Changeset 35063

Timestamp:

10/12/2015 04:33:30 PM (11 years ago)

Author:

DrewAPicture

Message:

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].

Location:

trunk/src/wp-includes

Files:

• class-wp-image-editor-gd.php (modified) (1 diff)
• class-wp-image-editor-imagick.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-image-editor-gd.php

@@ -220 +220 @@
          *
          *     @type array $size {
-         *         Optional. 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.
+         *         Array of height, width values, and whether to crop.
+         *
+         *         @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.
          *     }
          * }

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -278 +278 @@
          *
          *     @type array $size {
-         *         Optional. 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.
+         *         Array of height, width values, and whether to crop.
+         *
+         *         @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.
          *     }
          * }