Changeset 56204

Timestamp:

07/11/2023 06:29:11 AM (15 months ago)

Author:

audrasjb

Message:

Docs: Fix incorrect type for $crop param is various WP_Image_Editor classes and methods.

This changeset updates the $crop docblock type in various WP_Image_Editor, WP_Image_Editor_GD and WP_Image_Editor_Imagick functions, to match the
type documented in image_resize_dimensions().

Props thunderdw.
Fixes #58271.
See #57840.

Location:

trunk/src/wp-includes

Files:

• class-wp-image-editor-gd.php (modified) (3 diffs)
• class-wp-image-editor-imagick.php (modified) (3 diffs)
• class-wp-image-editor.php (modified) (2 diffs)

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

@@ -164 +164 @@
      * @since 3.5.0
      *
-     * @param int|null $max_w Image width.
-     * @param int|null $max_h Image height.
-     * @param bool     $crop
+     * @param int|null   $max_w Image width.
+     * @param int|null   $max_h Image height.
+     * @param bool|array $crop
      * @return true|WP_Error
      */
@@ -237 +237 @@
      *         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.
+     *         @type int        $width  Image width. Optional if `$height` is specified.
+     *         @type int        $height Image height. Optional if `$width` is specified.
+     *         @type bool|array $crop   Optional. Whether to crop the image. Default false.
      *     }
      * }
@@ -266 +266 @@
      *     Array of size data.
      *
-     *     @type int  $width  The maximum width in pixels.
-     *     @type int  $height The maximum height in pixels.
-     *     @type bool $crop   Whether to crop the image to exact dimensions.
+     *     @type int        $width  The maximum width in pixels.
+     *     @type int        $height The maximum height in pixels.
+     *     @type bool|array $crop   Whether to crop the image to exact dimensions.
      * }
      * @return array|WP_Error The image data array for inclusion in the `sizes` array in the image meta,

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

@@ -309 +309 @@
      * @since 3.5.0
      *
-     * @param int|null $max_w Image width.
-     * @param int|null $max_h Image height.
-     * @param bool     $crop
+     * @param int|null   $max_w Image width.
+     * @param int|null   $max_h Image height.
+     * @param bool|array $crop
      * @return true|WP_Error
      */
@@ -496 +496 @@
      *         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.
+     *         @type int        $width  Image width. Optional if `$height` is specified.
+     *         @type int        $height Image height. Optional if `$width` is specified.
+     *         @type bool|array $crop   Optional. Whether to crop the image. Default false.
      *     }
      * }
@@ -525 +525 @@
      *     Array of size data.
      *
-     *     @type int  $width  The maximum width in pixels.
-     *     @type int  $height The maximum height in pixels.
-     *     @type bool $crop   Whether to crop the image to exact dimensions.
+     *     @type int        $width  The maximum width in pixels.
+     *     @type int        $height The maximum height in pixels.
+     *     @type bool|array $crop   Whether to crop the image to exact dimensions.
      * }
      * @return array|WP_Error The image data array for inclusion in the `sizes` array in the image meta,

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

@@ -105 +105 @@
      * @abstract
      *
-     * @param int|null $max_w Image width.
-     * @param int|null $max_h Image height.
-     * @param bool     $crop
+     * @param int|null   $max_w Image width.
+     * @param int|null   $max_h Image height.
+     * @param bool|array $crop
      * @return true|WP_Error
      */
@@ -122 +122 @@
      *
      *     @type array ...$0 {
-     *         @type int  $width  Image width.
-     *         @type int  $height Image height.
-     *         @type bool $crop   Optional. Whether to crop the image. Default false.
+     *         @type int        $width  Image width.
+     *         @type int        $height Image height.
+     *         @type bool|array $crop   Optional. Whether to crop the image. Default false.
      *     }
      * }