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

Timestamp:

08/18/2023 05:54:41 PM (14 months ago)

Author:

johnbillion

Message:

Media: Standardise documentation of the $crop parameter for various media functions and methods.

See #58833

File:

• trunk/src/wp-includes/class-wp-image-editor-gd.php (modified) (2 diffs)

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

@@ -166 +166 @@
      * @param int|null   $max_w Image width.
      * @param int|null   $max_h Image height.
-     * @param bool|array $crop
+     * @param bool|array $crop   {
+     *     Optional. Image cropping behavior. If false, the image will be scaled (default),
+     *     If true, image will be cropped to the specified dimensions using center positions.
+     *     If an array, the image will be cropped using the array to specify the crop location:
+     *
+     *     @type string $0 The x crop position. Accepts 'left' 'center', or 'right'.
+     *     @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'.
+     * }
      * @return true|WP_Error
      */
@@ -191 +198 @@
      * @param int        $max_w
      * @param int        $max_h
-     * @param bool|array $crop
+     * @param bool|array $crop   {
+     *     Optional. Image cropping behavior. If false, the image will be scaled (default),
+     *     If true, image will be cropped to the specified dimensions using center positions.
+     *     If an array, the image will be cropped using the array to specify the crop location:
+     *
+     *     @type string $0 The x crop position. Accepts 'left' 'center', or 'right'.
+     *     @type string $1 The y crop position. Accepts 'top', 'center', or 'bottom'.
+     * }
      * @return resource|GdImage|WP_Error
      */