Docs: Add a more complete return description for the array of data (or false) returned by image_downsize().

If not short-circuited via the `image_downsize` boolean filter, `image_downsize()` returns an array of data including the image URL, width, height, and whether the image size is intermediate, in that order. Otherwise, it returns false.

Fixes #30636.


git-svn-id: https://develop.svn.wordpress.org/trunk@34362 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-21 10:21:48 +00:00
parent 71ce9e812c
commit f9e45047c1

View File

@ -148,7 +148,8 @@ function image_hwstring( $width, $height ) {
* @param int $id Attachment ID for image.
* @param array|string $size Optional. Image size to scale to. Accepts a registered image size
* or flat array of height and width values. Default 'medium'.
* @return false|array False on failure, array on success.
* @return false|array Array containing the image URL, width, height, and boolean for whether
* the image is an intermediate size. False on failure.
*/
function image_downsize( $id, $size = 'medium' ) {