Changeset 35034

Timestamp:

10/12/2015 03:17:21 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Adjust documentation for the $size parameter in image_downsize() to clarify the required order of width and height values when passing an array.

See #34257.

File:

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

trunk/src/wp-includes/media.php

@@ -148 +148 @@
  *
  * @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'.
+ * @param array|string $size Optional. Image size to scale to. Accepts any valid image size,
+ *                           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.