Docs: Re-clarify the $sizes[ $size ] section of the hash notations for WP_Image_Editor_GD::multi_resize() and WP_Image_Editor_Imagick::multi_resize() as not fully-optional.

The `$width` value is optional if `$height` is specified, and vice versa. The `$crop` value is always optional and defaults to false.

Props dh-shredder.
See #32246. See [35061] and [35062].


git-svn-id: https://develop.svn.wordpress.org/trunk@35063 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-10-12 16:33:30 +00:00
parent f66e753d46
commit 6cfda71af7
2 changed files with 8 additions and 8 deletions

View File

@ -219,11 +219,11 @@ class WP_Image_Editor_GD extends WP_Image_Editor {
* maintain aspect ratio according to the provided dimension.
*
* @type array $size {
* Optional. Array of height, width values, and whether to crop.
* Array of height, width values, and whether to crop.
*
* @type int $width Image width.
* @type int $height Image height.
* @type bool $crop Whether to crop the image. Default false.
* @type int $width Image width. Optional if `$height` is specified.
* @type int $height Image height. Optional if `$width` is specified.
* @type bool $crop Optional. Whether to crop the image. Default false.
* }
* }
* @return array An array of resized images' metadata by size.

View File

@ -277,11 +277,11 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor {
* maintain aspect ratio according to the provided dimension.
*
* @type array $size {
* Optional. Array of height, width values, and whether to crop.
* Array of height, width values, and whether to crop.
*
* @type int $width Image width.
* @type int $height Image height.
* @type bool $crop Whether to crop the image. Default false.
* @type int $width Image width. Optional if `$height` is specified.
* @type int $height Image height. Optional if `$width` is specified.
* @type bool $crop Optional. Whether to crop the image. Default false.
* }
* }
* @return array An array of resized images' metadata by size.