WordPress.org

Make WordPress Core

Changeset 35063


Ignore:
Timestamp:
10/12/2015 04:33:30 PM (4 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:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-image-editor-gd.php

    r35061 r35063  
    220220     *
    221221     *     @type array $size {
    222      *         Optional. Array of height, width values, and whether to crop.
    223      *
    224      *         @type int  $width  Image width.
    225      *         @type int  $height Image height.
    226      *         @type bool $crop   Whether to crop the image. Default false.
     222     *         Array of height, width values, and whether to crop.
     223     *
     224     *         @type int  $width  Image width. Optional if `$height` is specified.
     225     *         @type int  $height Image height. Optional if `$width` is specified.
     226     *         @type bool $crop   Optional. Whether to crop the image. Default false.
    227227     *     }
    228228     * }
  • trunk/src/wp-includes/class-wp-image-editor-imagick.php

    r35062 r35063  
    278278     *
    279279     *     @type array $size {
    280      *         Optional. Array of height, width values, and whether to crop.
    281      *
    282      *         @type int  $width  Image width.
    283      *         @type int  $height Image height.
    284      *         @type bool $crop   Whether to crop the image. Default false.
     280     *         Array of height, width values, and whether to crop.
     281     *
     282     *         @type int  $width  Image width. Optional if `$height` is specified.
     283     *         @type int  $height Image height. Optional if `$width` is specified.
     284     *         @type bool $crop   Optional. Whether to crop the image. Default false.
    285285     *     }
    286286     * }
Note: See TracChangeset for help on using the changeset viewer.