Media: Introduce the `image_get_intermediate_size` filter to its like-named function, making it possible to manipulate returned intermedia image size data.

Covers both the default and meaningful short-circuit return cases. Also adds a hash notation to the return documentation in the DocBlock.

Props A5hleyRich, DH-Shredder, wonderboymusic.
Fixes #34124.

Built from https://develop.svn.wordpress.org/trunk@35289


git-svn-id: http://core.svn.wordpress.org/trunk@35255 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-10-20 07:24:27 +00:00
parent 875c82f17f
commit 3686b78448
2 changed files with 37 additions and 10 deletions

View File

@ -607,7 +607,18 @@ function image_make_intermediate_size( $file, $width, $height, $crop = false ) {
* @param array|string $size Optional. Image size. Accepts any valid image size, or an array * @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). * of width and height values in pixels (in that order).
* Default 'thumbnail'. * Default 'thumbnail'.
* @return false|array False on failure or array of file path, width, and height on success. * @return false|array $data {
* 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.
*
* @type string $file Image's path relative to uploads directory
* @type int $width Width of image
* @type int $height Height of image
* @type string $path Optional. Image's absolute filesystem path. Only returned if registered
* size is passed to `$size` parameter.
* @type string $url Optional. Image's URL. Only returned if registered size is passed to `$size`
* parameter.
* }
*/ */
function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) { function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) ) if ( !is_array( $imagedata = wp_get_attachment_metadata( $post_id ) ) )
@ -620,9 +631,10 @@ function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
foreach ( $imagedata['sizes'] as $_size => $data ) { foreach ( $imagedata['sizes'] as $_size => $data ) {
// If there's an exact match to an existing image size, short circuit. // If there's an exact match to an existing image size, short circuit.
if ( $data['width'] == $size[0] && $data['height'] == $size[1] ) { if ( $data['width'] == $size[0] && $data['height'] == $size[1] ) {
$file = $data['file']; list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
list($width, $height) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
return compact( 'file', 'width', 'height' ); /** This filter is documented in wp-includes/media.php */
return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
} }
// If it's not an exact match but it's at least the dimensions requested. // If it's not an exact match but it's at least the dimensions requested.
if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) { if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) {
@ -647,10 +659,11 @@ function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
) ) { ) ) {
continue; continue;
} }
// If we're still here, then we're going to use this size // If we're still here, then we're going to use this size.
$file = $data['file']; list( $data['width'], $data['height'] ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
list( $width, $height ) = image_constrain_size_for_editor( $data['width'], $data['height'], $size );
return compact( 'file', 'width', 'height' ); /** This filter is documented in wp-includes/media.php */
return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
} }
} }
} }
@ -665,7 +678,21 @@ function image_get_intermediate_size( $post_id, $size = 'thumbnail' ) {
$data['path'] = path_join( dirname($imagedata['file']), $data['file'] ); $data['path'] = path_join( dirname($imagedata['file']), $data['file'] );
$data['url'] = path_join( dirname($file_url), $data['file'] ); $data['url'] = path_join( dirname($file_url), $data['file'] );
} }
return $data;
/**
* Filter the output of image_get_intermediate_size()
*
* @since 4.4.0
*
* @see image_get_intermediate_size()
*
* @param array $data Array of file relative path, width, and height on success. May also include
* file absolute path and URL.
* @param int $post_id The post_id of the image attachment
* @param string|array $size Registered image size or flat array of initially-requested height and width
* dimensions (in that order).
*/
return apply_filters( 'image_get_intermediate_size', $data, $post_id, $size );
} }
/** /**

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-35288'; $wp_version = '4.4-alpha-35289';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.