Changeset 34362

Timestamp:

09/21/2015 10:21:48 AM (8 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/media.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -149 +149 @@
  * @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' ) {