diff -r 3d4e9c994f10 -r a86126ab1dd4 wp/wp-includes/media.php --- a/wp/wp-includes/media.php Tue Oct 22 16:11:46 2019 +0200 +++ b/wp/wp-includes/media.php Tue Dec 15 13:49:49 2020 +0100 @@ -17,9 +17,11 @@ */ function wp_get_additional_image_sizes() { global $_wp_additional_image_sizes; + if ( ! $_wp_additional_image_sizes ) { $_wp_additional_image_sizes = array(); } + return $_wp_additional_image_sizes; } @@ -36,10 +38,7 @@ * not set. * * Finally, there is a filter named {@see 'editor_max_image_size'}, that will be - * called on the calculated array for width and height, respectively. The second - * parameter will be the value that was in the $size parameter. The returned - * type for the hook is an array with the width as the first element and the - * height as the second element. + * called on the calculated array for width and height, respectively. * * @since 2.5.0 * @@ -52,7 +51,12 @@ * Default 'medium'. * @param string $context Optional. Could be 'display' (like in a theme) or 'edit' * (like inserting into an editor). Default null. - * @return array Width and height of what the result image should resize to. + * @return int[] { + * An array of width and height values. + * + * @type int $0 The maximum width in pixels. + * @type int $1 The maximum height in pixels. + * } */ function image_constrain_size_for_editor( $width, $height, $size = 'medium', $context = null ) { global $content_width; @@ -66,26 +70,26 @@ if ( is_array( $size ) ) { $max_width = $size[0]; $max_height = $size[1]; - } elseif ( $size == 'thumb' || $size == 'thumbnail' ) { + } elseif ( 'thumb' === $size || 'thumbnail' === $size ) { $max_width = intval( get_option( 'thumbnail_size_w' ) ); $max_height = intval( get_option( 'thumbnail_size_h' ) ); - // last chance thumbnail size defaults + // Last chance thumbnail size defaults. if ( ! $max_width && ! $max_height ) { $max_width = 128; $max_height = 96; } - } elseif ( $size == 'medium' ) { + } elseif ( 'medium' === $size ) { $max_width = intval( get_option( 'medium_size_w' ) ); $max_height = intval( get_option( 'medium_size_h' ) ); - } elseif ( $size == 'medium_large' ) { + } elseif ( 'medium_large' === $size ) { $max_width = intval( get_option( 'medium_large_size_w' ) ); $max_height = intval( get_option( 'medium_large_size_h' ) ); if ( intval( $content_width ) > 0 ) { $max_width = min( intval( $content_width ), $max_width ); } - } elseif ( $size == 'large' ) { + } elseif ( 'large' === $size ) { /* * We're inserting a large size image into the editor. If it's a really * big image we'll scale it down to fit reasonably within the editor @@ -94,17 +98,18 @@ */ $max_width = intval( get_option( 'large_size_w' ) ); $max_height = intval( get_option( 'large_size_h' ) ); + if ( intval( $content_width ) > 0 ) { $max_width = min( intval( $content_width ), $max_width ); } - } elseif ( ! empty( $_wp_additional_image_sizes ) && in_array( $size, array_keys( $_wp_additional_image_sizes ) ) ) { + } elseif ( ! empty( $_wp_additional_image_sizes ) && in_array( $size, array_keys( $_wp_additional_image_sizes ), true ) ) { $max_width = intval( $_wp_additional_image_sizes[ $size ]['width'] ); $max_height = intval( $_wp_additional_image_sizes[ $size ]['height'] ); // Only in admin. Assume that theme authors know what they're doing. if ( intval( $content_width ) > 0 && 'edit' === $context ) { $max_width = min( intval( $content_width ), $max_width ); } - } else { // $size == 'full' has no constraint + } else { // $size === 'full' has no constraint. $max_width = $width; $max_height = $height; } @@ -114,8 +119,12 @@ * * @since 2.5.0 * - * @param array $max_image_size An array with the width as the first element, - * and the height as the second element. + * @param int[] $max_image_size { + * An array of width and height values. + * + * @type int $0 The maximum width in pixels. + * @type int $1 The maximum height in pixels. + * } * @param string|array $size Size of what the result image should be. * @param string $context The context the image is being resized for. * Possible values are 'display' (like in a theme) @@ -157,27 +166,28 @@ /** * Scale an image to fit a particular size (such as 'thumb' or 'medium'). * - * Array with image url, width, height, and whether is intermediate size, in - * that order is returned on success is returned. $is_intermediate is true if - * $url is a resized image, false if it is the original. - * * The URL might be the original image, or it might be a resized version. This * function won't create a new resized copy, it will just return an already * resized one if it exists. * * A plugin may use the {@see 'image_downsize'} filter to hook into and offer image * resizing services for images. The hook must return an array with the same - * elements that are returned in the function. The first element being the URL - * to the new image that was resized. + * elements that are normally returned from the function. * * @since 2.5.0 * * @param int $id Attachment ID for image. - * @param array|string $size Optional. Image size to scale to. Accepts any valid image size, + * @param string|int[] $size Optional. Image size to scale to. Accepts any valid image size name, * or an array of width and height values in pixels (in that order). * Default 'medium'. - * @return false|array Array containing the image URL, width, height, and boolean for whether - * the image is an intermediate size. False on failure. + * @return array|false { + * Array of image data, or boolean false if no image is available. + * + * @type string $0 Image source URL. + * @type int $1 Image width in pixels. + * @type int $2 Image height in pixels. + * @type bool $3 Whether the image is a resized image. + * } */ function image_downsize( $id, $size = 'medium' ) { $is_image = wp_attachment_is_image( $id ); @@ -185,30 +195,33 @@ /** * Filters whether to preempt the output of image_downsize(). * - * Passing a truthy value to the filter will effectively short-circuit - * down-sizing the image, returning that value as output instead. + * Returning a truthy value from the filter will effectively short-circuit + * down-sizing the image, returning that value instead. * * @since 2.5.0 * - * @param bool $downsize Whether to short-circuit the image downsize. Default false. + * @param bool|array $downsize Whether to short-circuit the image downsize. * @param int $id Attachment ID for image. - * @param array|string $size Size of image. Image size or array of width and height values (in that order). - * Default 'medium'. + * @param array|string $size Requested size of image. Image size name, or array of width + * and height values (in that order). */ - if ( $out = apply_filters( 'image_downsize', false, $id, $size ) ) { + $out = apply_filters( 'image_downsize', false, $id, $size ); + + if ( $out ) { return $out; } $img_url = wp_get_attachment_url( $id ); $meta = wp_get_attachment_metadata( $id ); - $width = $height = 0; + $width = 0; + $height = 0; $is_intermediate = false; $img_url_basename = wp_basename( $img_url ); // If the file isn't an image, attempt to replace its URL with a rendered image from its meta. // Otherwise, a non-image type could be returned. if ( ! $is_image ) { - if ( ! empty( $meta['sizes'] ) ) { + if ( ! empty( $meta['sizes']['full'] ) ) { $img_url = str_replace( $img_url_basename, $meta['sizes']['full']['file'], $img_url ); $img_url_basename = $meta['sizes']['full']['file']; $width = $meta['sizes']['full']['width']; @@ -218,48 +231,50 @@ } } - // try for a new style intermediate size - if ( $intermediate = image_get_intermediate_size( $id, $size ) ) { + // Try for a new style intermediate size. + $intermediate = image_get_intermediate_size( $id, $size ); + + if ( $intermediate ) { $img_url = str_replace( $img_url_basename, $intermediate['file'], $img_url ); $width = $intermediate['width']; $height = $intermediate['height']; $is_intermediate = true; - } elseif ( $size == 'thumbnail' ) { - // fall back to the old thumbnail - if ( ( $thumb_file = wp_get_attachment_thumb_file( $id ) ) && $info = getimagesize( $thumb_file ) ) { + } elseif ( 'thumbnail' === $size ) { + // Fall back to the old thumbnail. + $thumb_file = wp_get_attachment_thumb_file( $id ); + $info = null; + + if ( $thumb_file ) { + $info = @getimagesize( $thumb_file ); + } + + if ( $thumb_file && $info ) { $img_url = str_replace( $img_url_basename, wp_basename( $thumb_file ), $img_url ); $width = $info[0]; $height = $info[1]; $is_intermediate = true; } } + if ( ! $width && ! $height && isset( $meta['width'], $meta['height'] ) ) { - // any other type: use the real image + // Any other type: use the real image. $width = $meta['width']; $height = $meta['height']; } if ( $img_url ) { - // we have the actual image size, but might need to further constrain it if content_width is narrower + // We have the actual image size, but might need to further constrain it if content_width is narrower. list( $width, $height ) = image_constrain_size_for_editor( $width, $height, $size ); return array( $img_url, $width, $height, $is_intermediate ); } + return false; - } /** * Register a new image size. * - * Cropping behavior for the image size is dependent on the value of $crop: - * 1. If false (default), images will be scaled, not cropped. - * 2. If an array in the form of array( x_crop_position, y_crop_position ): - * - x_crop_position accepts 'left' 'center', or 'right'. - * - y_crop_position accepts 'top', 'center', or 'bottom'. - * Images will be cropped to the specified dimensions within the defined crop area. - * 3. If true, images will be cropped to the specified dimensions using center positions. - * * @since 2.9.0 * * @global array $_wp_additional_image_sizes Associative array of additional image sizes. @@ -267,8 +282,12 @@ * @param string $name Image size identifier. * @param int $width Optional. Image width in pixels. Default 0. * @param int $height Optional. Image height in pixels. Default 0. - * @param bool|array $crop Optional. Whether to crop images to specified width and height or resize. - * An array can specify positioning of the crop area. Default false. + * @param bool|array $crop Optional. Image cropping behavior. If false, the image will be scaled (default), + * If true, image will be cropped to the specified dimensions using center positions. + * If an array, the image will be cropped using the array to specify the crop location. + * Array values must be in the format: array( x_crop_position, y_crop_position ) where: + * - x_crop_position accepts: 'left', 'center', or 'right'. + * - y_crop_position accepts: 'top', 'center', or 'bottom'. */ function add_image_size( $name, $width = 0, $height = 0, $crop = false ) { global $_wp_additional_image_sizes; @@ -345,8 +364,8 @@ * @since 2.5.0 * * @param int $id Attachment ID. - * @param string $alt Image Description for the alt attribute. - * @param string $title Image Description for the title attribute. + * @param string $alt Image description for the alt attribute. + * @param string $title Image description for the title attribute. * @param string $align Part of the class name for aligning the image. * @param string|array $size Optional. Registered image size to retrieve a tag for. Accepts any * valid image size, or an array of width and height values in pixels @@ -384,8 +403,8 @@ * * @param string $html HTML content for the image. * @param int $id Attachment ID. - * @param string $alt Alternate text. - * @param string $title Attachment title. + * @param string $alt Image description for the alt attribute. + * @param string $title Image description for the title attribute. * @param string $align Part of the class name for aligning the image. * @param string|array $size Size of image. Image size or array of width and height values (in that order). * Default 'medium'. @@ -405,15 +424,22 @@ * @param int $current_height Current height of the image. * @param int $max_width Optional. Max width in pixels to constrain to. Default 0. * @param int $max_height Optional. Max height in pixels to constrain to. Default 0. - * @return array First item is the width, the second item is the height. + * @return int[] { + * An array of width and height values. + * + * @type int $0 The width in pixels. + * @type int $1 The height in pixels. + * } */ function wp_constrain_dimensions( $current_width, $current_height, $max_width = 0, $max_height = 0 ) { if ( ! $max_width && ! $max_height ) { return array( $current_width, $current_height ); } - $width_ratio = $height_ratio = 1.0; - $did_width = $did_height = false; + $width_ratio = 1.0; + $height_ratio = 1.0; + $did_width = false; + $did_height = false; if ( $max_width > 0 && $current_width > 0 && $current_width > $max_width ) { $width_ratio = $max_width / $current_width; @@ -425,7 +451,7 @@ $did_height = true; } - // Calculate the larger/smaller ratios + // Calculate the larger/smaller ratios. $smaller_ratio = min( $width_ratio, $height_ratio ); $larger_ratio = max( $width_ratio, $height_ratio ); @@ -441,18 +467,22 @@ $w = max( 1, (int) round( $current_width * $ratio ) ); $h = max( 1, (int) round( $current_height * $ratio ) ); - // Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short - // We also have issues with recursive calls resulting in an ever-changing result. Constraining to the result of a constraint should yield the original result. - // Thus we look for dimensions that are one pixel shy of the max value and bump them up + /* + * Sometimes, due to rounding, we'll end up with a result like this: + * 465x700 in a 177x177 box is 117x176... a pixel short. + * We also have issues with recursive calls resulting in an ever-changing result. + * Constraining to the result of a constraint should yield the original result. + * Thus we look for dimensions that are one pixel shy of the max value and bump them up. + */ // Note: $did_width means it is possible $smaller_ratio == $width_ratio. - if ( $did_width && $w == $max_width - 1 ) { - $w = $max_width; // Round it up + if ( $did_width && $w === $max_width - 1 ) { + $w = $max_width; // Round it up. } // Note: $did_height means it is possible $smaller_ratio == $height_ratio. - if ( $did_height && $h == $max_height - 1 ) { - $h = $max_height; // Round it up + if ( $did_height && $h === $max_height - 1 ) { + $h = $max_height; // Round it up. } /** @@ -460,7 +490,12 @@ * * @since 4.1.0 * - * @param array $dimensions The image width and height. + * @param int[] $dimensions { + * An array of width and height values. + * + * @type int $0 The width in pixels. + * @type int $1 The height in pixels. + * } * @param int $current_width The current width of the image. * @param int $current_height The current height of the image. * @param int $max_width The maximum width permitted. @@ -491,14 +526,14 @@ * @param int $dest_h New height in pixels. * @param bool|array $crop Optional. Whether to crop image to specified width and height or resize. * An array can specify positioning of the crop area. Default false. - * @return false|array False on failure. Returned array matches parameters for `imagecopyresampled()`. + * @return array|false Returned array matches parameters for `imagecopyresampled()`. False on failure. */ function image_resize_dimensions( $orig_w, $orig_h, $dest_w, $dest_h, $crop = false ) { if ( $orig_w <= 0 || $orig_h <= 0 ) { return false; } - // at least one of dest_w or dest_h must be specific + // At least one of $dest_w or $dest_h must be specific. if ( $dest_w <= 0 && $dest_h <= 0 ) { return false; } @@ -506,7 +541,7 @@ /** * Filters whether to preempt calculating the image resize dimensions. * - * Passing a non-null value to the filter will effectively short-circuit + * Returning a non-null value from the filter will effectively short-circuit * image_resize_dimensions(), returning that value instead. * * @since 3.4.0 @@ -520,12 +555,35 @@ * An array can specify positioning of the crop area. Default false. */ $output = apply_filters( 'image_resize_dimensions', null, $orig_w, $orig_h, $dest_w, $dest_h, $crop ); + if ( null !== $output ) { return $output; } + // Stop if the destination size is larger than the original image dimensions. + if ( empty( $dest_h ) ) { + if ( $orig_w < $dest_w ) { + return false; + } + } elseif ( empty( $dest_w ) ) { + if ( $orig_h < $dest_h ) { + return false; + } + } else { + if ( $orig_w < $dest_w && $orig_h < $dest_h ) { + return false; + } + } + if ( $crop ) { - // crop the largest possible portion of the original image that we can size to $dest_w x $dest_h + /* + * Crop the largest possible portion of the original image that we can size to $dest_w x $dest_h. + * Note that the requested crop dimensions are used as a maximum bounding box for the original image. + * If the original image's width or height is less than the requested width or height + * only the greater one will be cropped. + * For example when the original image is 600x300, and the requested crop dimensions are 400x400, + * the resulting image will be 400x300. + */ $aspect_ratio = $orig_w / $orig_h; $new_w = min( $dest_w, $orig_w ); $new_h = min( $dest_h, $orig_h ); @@ -565,7 +623,7 @@ $s_y = floor( ( $orig_h - $crop_h ) / 2 ); } } else { - // don't crop, just resize using $dest_w x $dest_h as a maximum bounding box + // Resize using $dest_w x $dest_h as a maximum bounding box. $crop_w = $orig_w; $crop_h = $orig_h; @@ -575,15 +633,29 @@ list( $new_w, $new_h ) = wp_constrain_dimensions( $orig_w, $orig_h, $dest_w, $dest_h ); } - // if the resulting image would be the same size or larger we don't want to resize it - if ( $new_w >= $orig_w && $new_h >= $orig_h && $dest_w != $orig_w && $dest_h != $orig_h ) { - return false; + if ( wp_fuzzy_number_match( $new_w, $orig_w ) && wp_fuzzy_number_match( $new_h, $orig_h ) ) { + // The new size has virtually the same dimensions as the original image. + + /** + * Filters whether to proceed with making an image sub-size with identical dimensions + * with the original/source image. Differences of 1px may be due to rounding and are ignored. + * + * @since 5.3.0 + * + * @param bool $proceed The filtered value. + * @param int $orig_w Original image width. + * @param int $orig_h Original image height. + */ + $proceed = (bool) apply_filters( 'wp_image_resize_identical_dimensions', false, $orig_w, $orig_h ); + + if ( ! $proceed ) { + return false; + } } - // the return array matches the parameters to imagecopyresampled() + // The return array matches the parameters to imagecopyresampled(). // int dst_x, int dst_y, int src_x, int src_y, int dst_w, int dst_h, int src_w, int src_h return array( 0, 0, (int) $s_x, (int) $s_y, (int) $new_w, (int) $new_h, (int) $crop_w, (int) $crop_h ); - } /** @@ -600,7 +672,7 @@ * @param int $height Image height. * @param bool $crop Optional. Whether to crop image to specified width and height or resize. * Default false. - * @return false|array False, if no image was created. Metadata array on success. + * @return array|false Metadata array on success. False if no image was created. */ function image_make_intermediate_size( $file, $width, $height, $crop = false ) { if ( $width || $height ) { @@ -645,7 +717,7 @@ } // If the image dimensions are within 1px of the expected size, we consider it a match. - $matched = ( abs( $constrained_size[0] - $expected_size[0] ) <= 1 && abs( $constrained_size[1] - $expected_size[1] ) <= 1 ); + $matched = ( wp_fuzzy_number_match( $constrained_size[0], $expected_size[0] ) && wp_fuzzy_number_match( $constrained_size[1], $expected_size[1] ) ); return $matched; } @@ -675,7 +747,7 @@ * @param array|string $size Optional. Image size. Accepts any valid image size, or an array * of width and height values in pixels (in that order). * Default 'thumbnail'. - * @return false|array $data { + * @return array|false { * Array of file relative path, width, and height on success. Additionally includes absolute * path and URL if registered size is passed to $size parameter. False on failure. * @@ -687,7 +759,9 @@ * } */ function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) { - if ( ! $size || ! is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) || empty( $imagedata['sizes'] ) ) { + $imagedata = wp_get_attachment_metadata( $post_id ); + + if ( ! $size || ! is_array( $imagedata ) || empty( $imagedata['sizes'] ) ) { return false; } @@ -704,7 +778,7 @@ foreach ( $imagedata['sizes'] as $_size => $data ) { // If there's an exact match to an existing image size, short circuit. - if ( $data['width'] == $size[0] && $data['height'] == $size[1] ) { + if ( intval( $data['width'] ) === intval( $size[0] ) && intval( $data['height'] ) === intval( $size[1] ) ) { $candidates[ $data['width'] * $data['height'] ] = $data; break; } @@ -754,7 +828,7 @@ return false; } - // include the full filesystem path of the intermediate file + // Include the full filesystem path of the intermediate file. if ( empty( $data['path'] ) && ! empty( $data['file'] ) && ! empty( $imagedata['file'] ) ) { $file_url = wp_get_attachment_url( $post_id ); $data['path'] = path_join( dirname( $imagedata['file'] ), $data['file'] ); @@ -778,17 +852,18 @@ } /** - * Gets the available intermediate image sizes. + * Gets the available intermediate image size names. * * @since 3.0.0 * - * @return array Returns a filtered array of image size strings. + * @return string[] An array of image size names. */ function get_intermediate_image_sizes() { - $_wp_additional_image_sizes = wp_get_additional_image_sizes(); - $image_sizes = array( 'thumbnail', 'medium', 'medium_large', 'large' ); // Standard sizes - if ( ! empty( $_wp_additional_image_sizes ) ) { - $image_sizes = array_merge( $image_sizes, array_keys( $_wp_additional_image_sizes ) ); + $default_sizes = array( 'thumbnail', 'medium', 'medium_large', 'large' ); + $additional_sizes = wp_get_additional_image_sizes(); + + if ( ! empty( $additional_sizes ) ) { + $default_sizes = array_merge( $default_sizes, array_keys( $additional_sizes ) ); } /** @@ -796,58 +871,124 @@ * * @since 2.5.0 * - * @param array $image_sizes An array of intermediate image sizes. Defaults - * are 'thumbnail', 'medium', 'medium_large', 'large'. + * @param string[] $default_sizes An array of intermediate image size names. Defaults + * are 'thumbnail', 'medium', 'medium_large', 'large'. */ - return apply_filters( 'intermediate_image_sizes', $image_sizes ); + return apply_filters( 'intermediate_image_sizes', $default_sizes ); } /** - * Retrieve an image to represent an attachment. - * - * A mime icon for files, thumbnail or intermediate size for images. - * - * The returned array contains four values: the URL of the attachment image src, - * the width of the image file, the height of the image file, and a boolean - * representing whether the returned array describes an intermediate (generated) - * image size or the original, full-sized upload. + * Returns a normalized list of all currently registered image sub-sizes. + * + * @since 5.3.0 + * @uses wp_get_additional_image_sizes() + * @uses get_intermediate_image_sizes() + * + * @return array Associative array of the registered image sub-sizes. + */ +function wp_get_registered_image_subsizes() { + $additional_sizes = wp_get_additional_image_sizes(); + $all_sizes = array(); + + foreach ( get_intermediate_image_sizes() as $size_name ) { + $size_data = array( + 'width' => 0, + 'height' => 0, + 'crop' => false, + ); + + if ( isset( $additional_sizes[ $size_name ]['width'] ) ) { + // For sizes added by plugins and themes. + $size_data['width'] = intval( $additional_sizes[ $size_name ]['width'] ); + } else { + // For default sizes set in options. + $size_data['width'] = intval( get_option( "{$size_name}_size_w" ) ); + } + + if ( isset( $additional_sizes[ $size_name ]['height'] ) ) { + $size_data['height'] = intval( $additional_sizes[ $size_name ]['height'] ); + } else { + $size_data['height'] = intval( get_option( "{$size_name}_size_h" ) ); + } + + if ( empty( $size_data['width'] ) && empty( $size_data['height'] ) ) { + // This size isn't set. + continue; + } + + if ( isset( $additional_sizes[ $size_name ]['crop'] ) ) { + $size_data['crop'] = $additional_sizes[ $size_name ]['crop']; + } else { + $size_data['crop'] = get_option( "{$size_name}_crop" ); + } + + if ( ! is_array( $size_data['crop'] ) || empty( $size_data['crop'] ) ) { + $size_data['crop'] = (bool) $size_data['crop']; + } + + $all_sizes[ $size_name ] = $size_data; + } + + return $all_sizes; +} + +/** + * Retrieves an image to represent an attachment. * * @since 2.5.0 * * @param int $attachment_id Image attachment ID. - * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width + * @param string|int[] $size Optional. Image size. Accepts any valid image size name, or an array of width * and height values in pixels (in that order). Default 'thumbnail'. - * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. - * @return false|array Returns an array (url, width, height, is_intermediate), or false, if no image is available. + * @param bool $icon Optional. Whether the image should fall back to a mime type icon. Default false. + * @return array|false { + * Array of image data, or boolean false if no image is available. + * + * @type string $0 Image source URL. + * @type int $1 Image width in pixels. + * @type int $2 Image height in pixels. + * @type bool $3 Whether the image is a resized image. + * } */ function wp_get_attachment_image_src( $attachment_id, $size = 'thumbnail', $icon = false ) { - // get a thumbnail or intermediate image if there is one + // Get a thumbnail or intermediate image if there is one. $image = image_downsize( $attachment_id, $size ); if ( ! $image ) { $src = false; - if ( $icon && $src = wp_mime_type_icon( $attachment_id ) ) { - /** This filter is documented in wp-includes/post.php */ - $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' ); - - $src_file = $icon_dir . '/' . wp_basename( $src ); - @list( $width, $height ) = getimagesize( $src_file ); + if ( $icon ) { + $src = wp_mime_type_icon( $attachment_id ); + + if ( $src ) { + /** This filter is documented in wp-includes/post.php */ + $icon_dir = apply_filters( 'icon_dir', ABSPATH . WPINC . '/images/media' ); + + $src_file = $icon_dir . '/' . wp_basename( $src ); + list( $width, $height ) = @getimagesize( $src_file ); + } } if ( $src && $width && $height ) { - $image = array( $src, $width, $height ); + $image = array( $src, $width, $height, false ); } } /** - * Filters the image src result. + * Filters the attachment image source result. * * @since 4.3.0 * - * @param array|false $image Either array with src, width & height, icon src, or false. + * @param array|false $image { + * Array of image data, or boolean false if no image is available. + * + * @type string $0 Image source URL. + * @type int $1 Image width in pixels. + * @type int $2 Image height in pixels. + * @type bool $3 Whether the image is a resized image. + * } * @param int $attachment_id Image attachment ID. - * @param string|array $size Size of image. Image size or array of width and height values - * (in that order). Default 'thumbnail'. - * @param bool $icon Whether the image should be treated as an icon. Default false. + * @param string|int[] $size Requested size of image. Image size name, or array of width + * and height values (in that order). + * @param bool $icon Whether the image should be treated as an icon. */ return apply_filters( 'wp_get_attachment_image_src', $image, $attachment_id, $size, $icon ); } @@ -861,33 +1002,63 @@ * browser scale down the image. * * @since 2.5.0 + * @since 4.4.0 The `$srcset` and `$sizes` attributes were added. + * @since 5.5.0 The `$loading` attribute was added. * * @param int $attachment_id Image attachment ID. * @param string|array $size Optional. Image size. Accepts any valid image size, or an array of width * and height values in pixels (in that order). Default 'thumbnail'. * @param bool $icon Optional. Whether the image should be treated as an icon. Default false. - * @param string|array $attr Optional. Attributes for the image markup. Default empty. + * @param string|array $attr { + * Optional. Attributes for the image markup. + * + * @type string $src Image attachment URL. + * @type string $class CSS class name or space-separated list of classes. + * Default `attachment-$size_class size-$size_class`, + * where `$size_class` is the image size being requested. + * @type string $alt Image description for the alt attribute. + * @type string $srcset The 'srcset' attribute value. + * @type string $sizes The 'sizes' attribute value. + * @type string|false $loading The 'loading' attribute value. Passing a value of false + * will result in the attribute being omitted for the image. + * Defaults to 'lazy', depending on wp_lazy_loading_enabled(). + * } * @return string HTML img element or empty string on failure. */ function wp_get_attachment_image( $attachment_id, $size = 'thumbnail', $icon = false, $attr = '' ) { $html = ''; $image = wp_get_attachment_image_src( $attachment_id, $size, $icon ); + if ( $image ) { - list($src, $width, $height) = $image; - $hwstring = image_hwstring( $width, $height ); - $size_class = $size; + list( $src, $width, $height ) = $image; + + $attachment = get_post( $attachment_id ); + $hwstring = image_hwstring( $width, $height ); + $size_class = $size; + if ( is_array( $size_class ) ) { $size_class = join( 'x', $size_class ); } - $attachment = get_post( $attachment_id ); + $default_attr = array( 'src' => $src, 'class' => "attachment-$size_class size-$size_class", 'alt' => trim( strip_tags( get_post_meta( $attachment_id, '_wp_attachment_image_alt', true ) ) ), ); + // Add `loading` attribute. + if ( wp_lazy_loading_enabled( 'img', 'wp_get_attachment_image' ) ) { + $default_attr['loading'] = 'lazy'; + } + $attr = wp_parse_args( $attr, $default_attr ); + // If the default value of `lazy` for the `loading` attribute is overridden + // to omit the attribute for this image, ensure it is not included. + if ( array_key_exists( 'loading', $attr ) && ! $attr['loading'] ) { + unset( $attr['loading'] ); + } + // Generate 'srcset' and 'sizes' if not already present. if ( empty( $attr['srcset'] ) ) { $image_meta = wp_get_attachment_metadata( $attachment_id ); @@ -912,17 +1083,21 @@ * * @since 2.8.0 * - * @param array $attr Attributes for the image markup. + * @param array $attr Array of attribute values for the image markup, keyed by attribute name. + * See wp_get_attachment_image(). * @param WP_Post $attachment Image attachment post. * @param string|array $size Requested size. Image size or array of width and height values * (in that order). Default 'thumbnail'. */ $attr = apply_filters( 'wp_get_attachment_image_attributes', $attr, $attachment, $size ); + $attr = array_map( 'esc_attr', $attr ); $html = rtrim( " $value ) { $html .= " $name=" . '"' . $value . '"'; } + $html .= ' />'; } @@ -962,7 +1137,7 @@ } if ( false !== strpos( $dirname, 'wp-content/uploads' ) ) { - // Get the directory name relative to the upload directory (back compat for pre-2.7 uploads) + // Get the directory name relative to the upload directory (back compat for pre-2.7 uploads). $dirname = substr( $dirname, strpos( $dirname, 'wp-content/uploads' ) + 18 ); $dirname = ltrim( $dirname, '/' ); } @@ -980,11 +1155,10 @@ * * @param string $size_name Image size. Accepts any valid image size name ('thumbnail', 'medium', etc.). * @param array $image_meta The image meta data. - * @return array|bool Array of width and height values in pixels (in that order) - * or false if the size doesn't exist. + * @return array|bool The image meta data as returned by `wp_get_attachment_metadata()`. */ function _wp_get_image_size_from_meta( $size_name, $image_meta ) { - if ( $size_name === 'full' ) { + if ( 'full' === $size_name ) { return array( absint( $image_meta['width'] ), absint( $image_meta['height'] ), @@ -1014,7 +1188,9 @@ * @return string|bool A 'srcset' value string or false. */ function wp_get_attachment_image_srcset( $attachment_id, $size = 'medium', $image_meta = null ) { - if ( ! $image = wp_get_attachment_image_src( $attachment_id, $size ) ) { + $image = wp_get_attachment_image_src( $attachment_id, $size ); + + if ( ! $image ) { return false; } @@ -1036,10 +1212,15 @@ * * @since 4.4.0 * - * @param array $size_array Array of width and height values in pixels (in that order). + * @param int[] $size_array { + * An array of width and height values. + * + * @type int $0 The width in pixels. + * @type int $1 The height in pixels. + * } * @param string $image_src The 'src' of the image. * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. - * @param int $attachment_id Optional. The image attachment ID to pass to the filter. Default 0. + * @param int $attachment_id Optional. The image attachment ID. Default 0. * @return string|bool The 'srcset' attribute value. False on error or when only one source exists. */ function wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id = 0 ) { @@ -1049,7 +1230,12 @@ * @since 4.5.0 * * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. - * @param array $size_array Array of width and height values in pixels (in that order). + * @param int[] $size_array { + * An array of requested width and height values. + * + * @type int $0 The width in pixels. + * @type int $1 The height in pixels. + * } * @param string $image_src The 'src' of the image. * @param int $attachment_id The image attachment ID or 0 if not supplied. */ @@ -1117,10 +1303,15 @@ * * @since 4.4.0 * - * @param int $max_width The maximum image width to be included in the 'srcset'. Default '1600'. - * @param array $size_array Array of width and height values in pixels (in that order). + * @param int $max_width The maximum image width to be included in the 'srcset'. Default '2048'. + * @param int[] $size_array { + * An array of requested width and height values. + * + * @type int $0 The width in pixels. + * @type int $1 The height in pixels. + * } */ - $max_srcset_image_width = apply_filters( 'max_srcset_image_width', 1600, $size_array ); + $max_srcset_image_width = apply_filters( 'max_srcset_image_width', 2048, $size_array ); // Array to hold URL candidates. $sources = array(); @@ -1146,7 +1337,8 @@ // If the file name is part of the `src`, we've confirmed a match. if ( ! $src_matched && false !== strpos( $image_src, $dirname . $image['file'] ) ) { - $src_matched = $is_src = true; + $src_matched = true; + $is_src = true; } // Filter out images that are from previous edits. @@ -1196,7 +1388,12 @@ * pixel density value if paired with an 'x' descriptor. * } * } - * @param array $size_array Array of width and height values in pixels (in that order). + * @param array $size_array { + * An array of requested width and height values. + * + * @type int $0 The width in pixels. + * @type int $1 The height in pixels. + * } * @param string $image_src The 'src' of the image. * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. * @param int $attachment_id Image attachment ID or 0. @@ -1232,7 +1429,9 @@ * @return string|bool A valid source size value for use in a 'sizes' attribute or false. */ function wp_get_attachment_image_sizes( $attachment_id, $size = 'medium', $image_meta = null ) { - if ( ! $image = wp_get_attachment_image_src( $attachment_id, $size ) ) { + $image = wp_get_attachment_image_src( $attachment_id, $size ); + + if ( ! $image ) { return false; } @@ -1304,50 +1503,112 @@ } /** - * Filters 'img' elements in post content to add 'srcset' and 'sizes' attributes. - * - * @since 4.4.0 - * - * @see wp_image_add_srcset_and_sizes() - * - * @param string $content The raw post content to be filtered. - * @return string Converted content with 'srcset' and 'sizes' attributes added to images. + * Determines if the image meta data is for the image source file. + * + * The image meta data is retrieved by attachment post ID. In some cases the post IDs may change. + * For example when the website is exported and imported at another website. Then the + * attachment post IDs that are in post_content for the exported website may not match + * the same attachments at the new website. + * + * @since 5.5.0 + * + * @param string $image_location The full path or URI to the image file. + * @param array $image_meta The attachment meta data as returned by 'wp_get_attachment_metadata()'. + * @param int $attachment_id Optional. The image attachment ID. Default 0. + * @return bool Whether the image meta is for this image file. */ -function wp_make_content_images_responsive( $content ) { - if ( ! preg_match_all( '/]+>/', $content, $matches ) ) { - return $content; - } - - $selected_images = $attachment_ids = array(); - - foreach ( $matches[0] as $image ) { - if ( false === strpos( $image, ' srcset=' ) && preg_match( '/wp-image-([0-9]+)/i', $image, $class_id ) && - ( $attachment_id = absint( $class_id[1] ) ) ) { - - /* - * If exactly the same image tag is used more than once, overwrite it. - * All identical tags will be replaced later with 'str_replace()'. - */ - $selected_images[ $image ] = $attachment_id; - // Overwrite the ID when the same image is included more than once. - $attachment_ids[ $attachment_id ] = true; +function wp_image_file_matches_image_meta( $image_location, $image_meta, $attachment_id = 0 ) { + $match = false; + + // Ensure the $image_meta is valid. + if ( isset( $image_meta['file'] ) && strlen( $image_meta['file'] ) > 4 ) { + // Remove quiery args if image URI. + list( $image_location ) = explode( '?', $image_location ); + + // Check if the relative image path from the image meta is at the end of $image_location. + if ( strrpos( $image_location, $image_meta['file'] ) === strlen( $image_location ) - strlen( $image_meta['file'] ) ) { + $match = true; + } else { + // Retrieve the uploads sub-directory from the full size image. + $dirname = _wp_get_attachment_relative_path( $image_meta['file'] ); + + if ( $dirname ) { + $dirname = trailingslashit( $dirname ); + } + + if ( ! empty( $image_meta['original_image'] ) ) { + $relative_path = $dirname . $image_meta['original_image']; + + if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) { + $match = true; + } + } + + if ( ! $match && ! empty( $image_meta['sizes'] ) ) { + foreach ( $image_meta['sizes'] as $image_size_data ) { + $relative_path = $dirname . $image_size_data['file']; + + if ( strrpos( $image_location, $relative_path ) === strlen( $image_location ) - strlen( $relative_path ) ) { + $match = true; + break; + } + } + } } } - if ( count( $attachment_ids ) > 1 ) { - /* - * Warm the object cache with post and meta information for all found - * images to avoid making individual database calls. - */ - _prime_post_caches( array_keys( $attachment_ids ), false, true ); + /** + * Filter whether an image path or URI matches image meta. + * + * @since 5.5.0 + * + * @param bool $match Whether the image relative path from the image meta + * matches the end of the URI or path to the image file. + * @param string $image_location Full path or URI to the tested image file. + * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. + * @param int $attachment_id The image attachment ID or 0 if not supplied. + */ + return apply_filters( 'wp_image_file_matches_image_meta', $match, $image_location, $image_meta, $attachment_id ); +} + +/** + * Determines an image's width and height dimensions based on the source file. + * + * @since 5.5.0 + * + * @param string $image_src The image source file. + * @param array $image_meta The image meta data as returned by 'wp_get_attachment_metadata()'. + * @param int $attachment_id Optional. The image attachment ID. Default 0. + * @return array|false Array with first element being the width and second element being the height, + * or false if dimensions cannot be determined. + */ +function wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id = 0 ) { + if ( ! wp_image_file_matches_image_meta( $image_src, $image_meta, $attachment_id ) ) { + return false; } - foreach ( $selected_images as $image => $attachment_id ) { - $image_meta = wp_get_attachment_metadata( $attachment_id ); - $content = str_replace( $image, wp_image_add_srcset_and_sizes( $image, $image_meta, $attachment_id ), $content ); + // Is it a full size image? + if ( strpos( $image_src, $image_meta['file'] ) !== false ) { + return array( + (int) $image_meta['width'], + (int) $image_meta['height'], + ); } - return $content; + if ( ! empty( $image_meta['sizes'] ) ) { + $src_filename = wp_basename( $image_src ); + + foreach ( $image_meta['sizes'] as $image_size_data ) { + if ( $src_filename === $image_size_data['file'] ) { + return array( + (int) $image_size_data['width'], + (int) $image_size_data['height'], + ); + } + } + } + + return false; } /** @@ -1387,33 +1648,16 @@ $width = preg_match( '/ width="([0-9]+)"/', $image, $match_width ) ? (int) $match_width[1] : 0; $height = preg_match( '/ height="([0-9]+)"/', $image, $match_height ) ? (int) $match_height[1] : 0; - if ( ! $width || ! $height ) { - /* - * If attempts to parse the size value failed, attempt to use the image meta data to match - * the image file name from 'src' against the available sizes for an attachment. - */ - $image_filename = wp_basename( $image_src ); - - if ( $image_filename === wp_basename( $image_meta['file'] ) ) { - $width = (int) $image_meta['width']; - $height = (int) $image_meta['height']; - } else { - foreach ( $image_meta['sizes'] as $image_size_data ) { - if ( $image_filename === $image_size_data['file'] ) { - $width = (int) $image_size_data['width']; - $height = (int) $image_size_data['height']; - break; - } - } + if ( $width && $height ) { + $size_array = array( $width, $height ); + } else { + $size_array = wp_image_src_get_dimensions( $image_src, $image_meta, $attachment_id ); + if ( ! $size_array ) { + return $image; } } - if ( ! $width || ! $height ) { - return $image; - } - - $size_array = array( $width, $height ); - $srcset = wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id ); + $srcset = wp_calculate_image_srcset( $size_array, $image_src, $image_meta, $attachment_id ); if ( $srcset ) { // Check if there is already a 'sizes' attribute. @@ -1432,8 +1676,243 @@ $attr .= sprintf( ' sizes="%s"', esc_attr( $sizes ) ); } - // Add 'srcset' and 'sizes' attributes to the image markup. - $image = preg_replace( '/]+?)[\/ ]*>/', '', $image ); + // Add the srcset and sizes attributes to the image markup. + return preg_replace( '/]+?)[\/ ]*>/', '', $image ); + } + + return $image; +} + +/** + * Determine whether to add the `loading` attribute to the specified tag in the specified context. + * + * @since 5.5.0 + * + * @param string $tag_name The tag name. + * @param string $context Additional context, like the current filter name or the function name from where this was called. + * @return bool Whether to add the attribute. + */ +function wp_lazy_loading_enabled( $tag_name, $context ) { + // By default add to all 'img' tags. + // See https://html.spec.whatwg.org/multipage/embedded-content.html#attr-img-loading + $default = ( 'img' === $tag_name ); + + /** + * Filters whether to add the `loading` attribute to the specified tag in the specified context. + * + * @since 5.5.0 + * + * @param bool $default Default value. + * @param string $tag_name The tag name. + * @param string $context Additional context, like the current filter name or the function name from where this was called. + */ + return (bool) apply_filters( 'wp_lazy_loading_enabled', $default, $tag_name, $context ); +} + +/** + * Filters specific tags in post content and modifies their markup. + * + * Modifies HTML tags in post content to include new browser and HTML technologies + * that may not have existed at the time of post creation. These modifications currently + * include adding `srcset`, `sizes`, and `loading` attributes to `img` HTML tags. + * Future similar optimizations should be added/expected here. + * + * @since 5.5.0 + * + * @see wp_img_tag_add_width_and_height_attr() + * @see wp_img_tag_add_srcset_and_sizes_attr() + * @see wp_img_tag_add_loading_attr() + * + * @param string $content The HTML content to be filtered. + * @param string $context Optional. Additional context to pass to the filters. + * Defaults to `current_filter()` when not set. + * @return string Converted content with images modified. + */ +function wp_filter_content_tags( $content, $context = null ) { + if ( null === $context ) { + $context = current_filter(); + } + + $add_loading_attr = wp_lazy_loading_enabled( 'img', $context ); + + if ( false === strpos( $content, ']+>/', $content, $matches ) ) { + return $content; + } + + // List of the unique `img` tags found in $content. + $images = array(); + + foreach ( $matches[0] as $image ) { + if ( preg_match( '/wp-image-([0-9]+)/i', $image, $class_id ) ) { + $attachment_id = absint( $class_id[1] ); + + if ( $attachment_id ) { + // If exactly the same image tag is used more than once, overwrite it. + // All identical tags will be replaced later with 'str_replace()'. + $images[ $image ] = $attachment_id; + continue; + } + } + + $images[ $image ] = 0; + } + + // Reduce the array to unique attachment IDs. + $attachment_ids = array_unique( array_filter( array_values( $images ) ) ); + + if ( count( $attachment_ids ) > 1 ) { + /* + * Warm the object cache with post and meta information for all found + * images to avoid making individual database calls. + */ + _prime_post_caches( $attachment_ids, false, true ); + } + + foreach ( $images as $image => $attachment_id ) { + $filtered_image = $image; + + // Add 'width' and 'height' attributes if applicable. + if ( $attachment_id > 0 && false === strpos( $filtered_image, ' width=' ) && false === strpos( $filtered_image, ' height=' ) ) { + $filtered_image = wp_img_tag_add_width_and_height_attr( $filtered_image, $context, $attachment_id ); + } + + // Add 'srcset' and 'sizes' attributes if applicable. + if ( $attachment_id > 0 && false === strpos( $filtered_image, ' srcset=' ) ) { + $filtered_image = wp_img_tag_add_srcset_and_sizes_attr( $filtered_image, $context, $attachment_id ); + } + + // Add 'loading' attribute if applicable. + if ( $add_loading_attr && false === strpos( $filtered_image, ' loading=' ) ) { + $filtered_image = wp_img_tag_add_loading_attr( $filtered_image, $context ); + } + + if ( $filtered_image !== $image ) { + $content = str_replace( $image, $filtered_image, $content ); + } + } + + return $content; +} + +/** + * Adds `loading` attribute to an `img` HTML tag. + * + * @since 5.5.0 + * + * @param string $image The HTML `img` tag where the attribute should be added. + * @param string $context Additional context to pass to the filters. + * @return string Converted `img` tag with `loading` attribute added. + */ +function wp_img_tag_add_loading_attr( $image, $context ) { + /** + * Filters the `loading` attribute value. Default `lazy`. + * + * Returning `false` or an empty string will not add the attribute. + * Returning `true` will add the default value. + * + * @since 5.5.0 + * + * @param string|bool $value The `loading` attribute value. Returning a falsey value will result in + * the attribute being omitted for the image. Default is `lazy`. + * @param string $image The HTML `img` tag to be filtered. + * @param string $context Additional context about how the function was called or where the img tag is. + */ + $value = apply_filters( 'wp_img_tag_add_loading_attr', 'lazy', $image, $context ); + + if ( $value ) { + if ( ! in_array( $value, array( 'lazy', 'eager' ), true ) ) { + $value = 'lazy'; + } + + // Images should have source and dimension attributes for the `loading` attribute to be added. + if ( false === strpos( $image, ' src="' ) || false === strpos( $image, ' width="' ) || false === strpos( $image, ' height="' ) ) { + return $image; + } + + return str_replace( ' $attachment ) { - $output .= wp_get_attachment_link( $att_id, $atts['size'], true ) . "\n"; + if ( ! empty( $atts['link'] ) ) { + if ( 'none' === $atts['link'] ) { + $output .= wp_get_attachment_image( $att_id, $atts['size'], false, $attr ); + } else { + $output .= wp_get_attachment_link( $att_id, $atts['size'], false ); + } + } else { + $output .= wp_get_attachment_link( $att_id, $atts['size'], true ); + } + $output .= "\n"; } return $output; } @@ -1815,8 +2307,10 @@ * Otherwise, defaults to true. */ if ( apply_filters( 'use_default_gallery_style', ! $html5 ) ) { + $type_attr = current_theme_supports( 'html5', 'style' ) ? '' : ' type="text/css"'; + $gallery_style = " -