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

See #34257.


git-svn-id: https://develop.svn.wordpress.org/trunk@35033 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-10-12 15:15:07 +00:00
parent ed4eee668e
commit bdfb256110
1 changed files with 3 additions and 2 deletions

View File

@ -31,8 +31,9 @@
*
* @param int $width Width of the image in pixels.
* @param int $height Height of the image in pixels.
* @param string|array $size Optional. Size or array of sizes of what the result image
* should be. Accepts any valid image size name. Default 'medium'.
* @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 '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.