- File: class-wpseo-image-utils.php
- Full Path: /home/matthif/www/wp-content/plugins/wordpress-seo/inc/class-wpseo-image-utils.php
- Date Modified: 02/24/2024 11:29 PM
- File size: 15.09 KB
- MIME-type: text/x-php
- Charset: utf-8
<?php
/**
* WPSEO plugin file.
*
* @package WPSEO
*/
/**
* WPSEO_Image_Utils.
*/
class WPSEO_Image_Utils {
/**
* Find an attachment ID for a given URL.
*
* @param string $url The URL to find the attachment for.
*
* @return int The found attachment ID, or 0 if none was found.
*/
public static function get_attachment_by_url( $url ) {
/*
* As get_attachment_by_url won't work on resized versions of images,
* we strip out the size part of an image URL.
*/
$url = preg_replace( '/(.*)-\d+x\d+\.(jpg|png|gif)$/', '$1.$2', $url );
static $uploads;
if ( $uploads === null ) {
$uploads = wp_get_upload_dir();
}
// Don't try to do this for external URLs.
if ( strpos( $url, $uploads['baseurl'] ) !== 0 ) {
return 0;
}
if ( function_exists( 'wpcom_vip_attachment_url_to_postid' ) ) {
// @codeCoverageIgnoreStart -- We can't test this properly.
return (int) wpcom_vip_attachment_url_to_postid( $url );
// @codeCoverageIgnoreEnd -- The rest we _can_ test.
}
return self::attachment_url_to_postid( $url );
}
/**
* Implements the attachment_url_to_postid with use of WP Cache.
*
* @param string $url The attachment URL for which we want to know the Post ID.
*
* @return int The Post ID belonging to the attachment, 0 if not found.
*/
protected static function attachment_url_to_postid( $url ) {
$cache_key = sprintf( 'yoast_attachment_url_post_id_%s', md5( $url ) );
// Set the ID based on the hashed URL in the cache.
$id = wp_cache_get( $cache_key );
if ( $id === 'not_found' ) {
return 0;
}
// ID is found in cache, return.
if ( $id !== false ) {
return $id;
}
// Note: We use the WP COM version if we can, see above.
$id = attachment_url_to_postid( $url );
if ( empty( $id ) ) {
/**
* If no ID was found, maybe we're dealing with a scaled big image. So, let's try that.
*
* @see https://core.trac.wordpress.org/ticket/51058
*/
$id = self::get_scaled_image_id( $url );
}
if ( empty( $id ) ) {
wp_cache_set( $cache_key, 'not_found', '', ( 12 * HOUR_IN_SECONDS + wp_rand( 0, ( 4 * HOUR_IN_SECONDS ) ) ) );
return 0;
}
// We have the Post ID, but it's not in the cache yet. We do that here and return.
wp_cache_set( $cache_key, $id, '', ( 24 * HOUR_IN_SECONDS + wp_rand( 0, ( 12 * HOUR_IN_SECONDS ) ) ) );
return $id;
}
/**
* Tries getting the ID of a potentially scaled image.
*
* @param string $url The URL of the image.
*
* @return int|false The ID of the image or false for failure.
*/
protected static function get_scaled_image_id( $url ) {
$path_parts = pathinfo( $url );
if ( isset( $path_parts['dirname'], $path_parts['filename'], $path_parts['extension'] ) ) {
$scaled_url = trailingslashit( $path_parts['dirname'] ) . $path_parts['filename'] . '-scaled.' . $path_parts['extension'];
return attachment_url_to_postid( $scaled_url );
}
return false;
}
/**
* Retrieves the image data.
*
* @param array $image Image array with URL and metadata.
* @param int $attachment_id Attachment ID.
*
* @return false|array {
* Array of image data
*
* @type string $alt Image's alt text.
* @type string $path Path of image.
* @type int $width Width of image.
* @type int $height Height of image.
* @type string $type Image's MIME type.
* @type string $size Image's size.
* @type string $url Image's URL.
* @type int $filesize The file size in bytes, if already set.
* }
*/
public static function get_data( $image, $attachment_id ) {
if ( ! is_array( $image ) ) {
return false;
}
// Deals with non-set keys and values being null or false.
if ( empty( $image['width'] ) || empty( $image['height'] ) ) {
return false;
}
$image['id'] = $attachment_id;
$image['alt'] = self::get_alt_tag( $attachment_id );
$image['pixels'] = ( (int) $image['width'] * (int) $image['height'] );
if ( ! isset( $image['type'] ) ) {
$image['type'] = get_post_mime_type( $attachment_id );
}
/**
* Filter: 'wpseo_image_data' - Filter image data.
*
* Elements with keys not listed in the section will be discarded.
*
* @param array $image_data {
* Array of image data
*
* @type int id Image's ID as an attachment.
* @type string alt Image's alt text.
* @type string path Image's path.
* @type int width Width of image.
* @type int height Height of image.
* @type int pixels Number of pixels in the image.
* @type string type Image's MIME type.
* @type string size Image's size.
* @type string url Image's URL.
* @type int filesize The file size in bytes, if already set.
* }
* @param int $attachment_id Attachment ID.
*/
$image = apply_filters( 'wpseo_image_data', $image, $attachment_id );
// Keep only the keys we need, and nothing else.
return array_intersect_key( $image, array_flip( [ 'id', 'alt', 'path', 'width', 'height', 'pixels', 'type', 'size', 'url', 'filesize' ] ) );
}
/**
* Checks a size version of an image to see if it's not too heavy.
*
* @param array $image Image to check the file size of.
*
* @return bool True when the image is within limits, false if not.
*/
public static function has_usable_file_size( $image ) {
if ( ! is_array( $image ) || $image === [] ) {
return false;
}
/**
* Filter: 'wpseo_image_image_weight_limit' - Determines what the maximum weight
* (in bytes) of an image is allowed to be, default is 2 MB.
*
* @param int $max_bytes The maximum weight (in bytes) of an image.
*/
$max_size = apply_filters( 'wpseo_image_image_weight_limit', 2097152 );
// We cannot check without a path, so assume it's fine.
if ( ! isset( $image['path'] ) ) {
return true;
}
return ( self::get_file_size( $image ) <= $max_size );
}
/**
* Find the right version of an image based on size.
*
* @param int $attachment_id Attachment ID.
* @param string|array $size Size name, or array of width and height in pixels (e.g [800,400]).
*
* @return array|false Returns an array with image data on success, false on failure.
*/
public static function get_image( $attachment_id, $size ) {
$image = false;
if ( $size === 'full' ) {
$image = self::get_full_size_image_data( $attachment_id );
}
if ( ! $image ) {
$image = image_get_intermediate_size( $attachment_id, $size );
}
if ( ! is_array( $image ) ) {
$image_src = wp_get_attachment_image_src( $attachment_id, $size );
if ( is_array( $image_src ) && isset( $image_src[1] ) && isset( $image_src[2] ) ) {
$image = [];
$image['url'] = $image_src[0];
$image['width'] = $image_src[1];
$image['height'] = $image_src[2];
$image['size'] = 'full';
}
}
if ( ! $image ) {
return false;
}
if ( ! isset( $image['size'] ) ) {
$image['size'] = $size;
}
return self::get_data( $image, $attachment_id );
}
/**
* Returns the image data for the full size image.
*
* @param int $attachment_id Attachment ID.
*
* @return array|false Array when there is a full size image. False if not.
*/
protected static function get_full_size_image_data( $attachment_id ) {
$image = wp_get_attachment_metadata( $attachment_id );
if ( ! is_array( $image ) ) {
return false;
}
$image['url'] = wp_get_attachment_image_url( $attachment_id, 'full' );
$image['path'] = get_attached_file( $attachment_id );
$image['size'] = 'full';
return $image;
}
/**
* Finds the full file path for a given image file.
*
* @param string $path The relative file path.
*
* @return string The full file path.
*/
public static function get_absolute_path( $path ) {
static $uploads;
if ( $uploads === null ) {
$uploads = wp_get_upload_dir();
}
// Add the uploads basedir if the path does not start with it.
if ( empty( $uploads['error'] ) && strpos( $path, $uploads['basedir'] ) !== 0 ) {
return $uploads['basedir'] . DIRECTORY_SEPARATOR . ltrim( $path, DIRECTORY_SEPARATOR );
}
return $path;
}
/**
* Get the relative path of the image.
*
* @param string $img Image URL.
*
* @return string The expanded image URL.
*/
public static function get_relative_path( $img ) {
if ( $img[0] !== '/' ) {
return $img;
}
// If it's a relative URL, it's relative to the domain, not necessarily to the WordPress install, we
// want to preserve domain name and URL scheme (http / https) though.
$parsed_url = wp_parse_url( home_url() );
$img = $parsed_url['scheme'] . '://' . $parsed_url['host'] . $img;
return $img;
}
/**
* Get the image file size.
*
* @param array $image An image array object.
*
* @return int The file size in bytes.
*/
public static function get_file_size( $image ) {
if ( isset( $image['filesize'] ) ) {
return $image['filesize'];
}
if ( ! isset( $image['path'] ) ) {
return 0;
}
// If the file size for the file is over our limit, we're going to go for a smaller version.
if ( function_exists( 'wp_filesize' ) ) {
return wp_filesize( self::get_absolute_path( $image['path'] ) );
}
return file_exists( $image['path'] ) ? (int) filesize( $image['path'] ) : 0;
}
/**
* Returns the different image variations for consideration.
*
* @param int $attachment_id The attachment to return the variations for.
*
* @return array The different variations possible for this attachment ID.
*/
public static function get_variations( $attachment_id ) {
$variations = [];
foreach ( self::get_sizes() as $size ) {
$variation = self::get_image( $attachment_id, $size );
// The get_image function returns false if the size doesn't exist for this attachment.
if ( $variation ) {
$variations[] = $variation;
}
}
return $variations;
}
/**
* Check original size of image. If original image is too small, return false, else return true.
*
* Filters a list of variations by a certain set of usable dimensions.
*
* @param array $usable_dimensions {
* The parameters to check against.
*
* @type int $min_width Minimum width of image.
* @type int $max_width Maximum width of image.
* @type int $min_height Minimum height of image.
* @type int $max_height Maximum height of image.
* }
* @param array $variations The variations that should be considered.
*
* @return array Whether a variation is fit for display or not.
*/
public static function filter_usable_dimensions( $usable_dimensions, $variations ) {
$filtered = [];
foreach ( $variations as $variation ) {
$dimensions = $variation;
if ( self::has_usable_dimensions( $dimensions, $usable_dimensions ) ) {
$filtered[] = $variation;
}
}
return $filtered;
}
/**
* Filters a list of variations by (disk) file size.
*
* @param array $variations The variations to consider.
*
* @return array The validations that pass the required file size limits.
*/
public static function filter_usable_file_size( $variations ) {
foreach ( $variations as $variation ) {
// We return early to prevent measuring the file size of all the variations.
if ( self::has_usable_file_size( $variation ) ) {
return [ $variation ];
}
}
return [];
}
/**
* Retrieve the internal WP image file sizes.
*
* @return array An array of image sizes.
*/
public static function get_sizes() {
/**
* Filter: 'wpseo_image_sizes' - Determines which image sizes we'll loop through to get an appropriate image.
*
* @param array<string> $sizes The array of image sizes to loop through.
*/
return apply_filters( 'wpseo_image_sizes', [ 'full', 'large', 'medium_large' ] );
}
/**
* Grabs an image alt text.
*
* @param int $attachment_id The attachment ID.
*
* @return string The image alt text.
*/
public static function get_alt_tag( $attachment_id ) {
return (string) get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
}
/**
* Checks whether an img sizes up to the parameters.
*
* @param array $dimensions The image values.
* @param array $usable_dimensions The parameters to check against.
*
* @return bool True if the image has usable measurements, false if not.
*/
private static function has_usable_dimensions( $dimensions, $usable_dimensions ) {
foreach ( [ 'width', 'height' ] as $param ) {
$minimum = $usable_dimensions[ 'min_' . $param ];
$maximum = $usable_dimensions[ 'max_' . $param ];
$current = $dimensions[ $param ];
if ( ( $current < $minimum ) || ( $current > $maximum ) ) {
return false;
}
}
return true;
}
/**
* Gets the post's first usable content image. Null if none is available.
*
* @param int|null $post_id The post id.
*
* @return string|null The image URL.
*/
public static function get_first_usable_content_image_for_post( $post_id = null ) {
$post = get_post( $post_id );
// We know get_post() returns the post or null.
if ( ! $post ) {
return null;
}
$image_finder = new WPSEO_Content_Images();
$images = $image_finder->get_images( $post->ID, $post );
return self::get_first_image( $images );
}
/**
* Gets the term's first usable content image. Null if none is available.
*
* @param int $term_id The term id.
*
* @return string|null The image URL.
*/
public static function get_first_content_image_for_term( $term_id ) {
$term_description = term_description( $term_id );
// We know term_description() returns a string which may be empty.
if ( $term_description === '' ) {
return null;
}
$image_finder = new WPSEO_Content_Images();
$images = $image_finder->get_images_from_content( $term_description );
return self::get_first_image( $images );
}
/**
* Retrieves an attachment ID for an image uploaded in the settings.
*
* Due to self::get_attachment_by_url returning 0 instead of false.
* 0 is also a possibility when no ID is available.
*
* @param string $setting The setting the image is stored in.
*
* @return int|bool The attachment id, or false or 0 if no ID is available.
*/
public static function get_attachment_id_from_settings( $setting ) {
$image_id = WPSEO_Options::get( $setting . '_id', false );
if ( $image_id ) {
return $image_id;
}
$image = WPSEO_Options::get( $setting, false );
if ( $image ) {
// There is not an option to put a URL in an image field in the settings anymore, only to upload it through the media manager.
// This means an attachment always exists, so doing this is only needed once.
$image_id = self::get_attachment_by_url( $image );
}
// Only store a new ID if it is not 0, to prevent an update loop.
if ( $image_id ) {
WPSEO_Options::set( $setting . '_id', $image_id );
}
return $image_id;
}
/**
* Retrieves the first possible image url from an array of images.
*
* @param array $images The array to extract image url from.
*
* @return string|null The extracted image url when found, null when not found.
*/
protected static function get_first_image( $images ) {
if ( ! is_array( $images ) ) {
return null;
}
$images = array_filter( $images );
if ( empty( $images ) ) {
return null;
}
return reset( $images );
}
}