diff --git a/src/wp-includes/class-wp-image-editor-gd.php b/src/wp-includes/class-wp-image-editor-gd.php index 12aaece1eb..a8235c241d 100644 --- a/src/wp-includes/class-wp-image-editor-gd.php +++ b/src/wp-includes/class-wp-image-editor-gd.php @@ -175,17 +175,21 @@ class WP_Image_Editor_GD extends WP_Image_Editor { } /** - * Processes current image and saves to disk - * multiple sizes from single source. - * - * 'width' and 'height' are required. - * 'crop' defaults to false when not provided. + * Resize multiple images from a single source. * * @since 3.5.0 * @access public * - * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... } - * @return array + * @param array $sizes { + * An array of image size arrays. Default sizes are 'small', 'medium', 'large'. + * + * @type array $size { + * @type int $width Image width. + * @type int $height Image height. + * @type bool $crop Optional. Whether to crop the image. Default false. + * } + * } + * @return array An array of resized images metadata by size. */ public function multi_resize( $sizes ) { $metadata = array(); diff --git a/src/wp-includes/class-wp-image-editor-imagick.php b/src/wp-includes/class-wp-image-editor-imagick.php index 436fdec782..2e1bebc994 100644 --- a/src/wp-includes/class-wp-image-editor-imagick.php +++ b/src/wp-includes/class-wp-image-editor-imagick.php @@ -242,17 +242,21 @@ class WP_Image_Editor_Imagick extends WP_Image_Editor { } /** - * Processes current image and saves to disk - * multiple sizes from single source. - * - * 'width' and 'height' are required. - * 'crop' defaults to false when not provided. + * Resize multiple images from a single source. * * @since 3.5.0 * @access public * - * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... } - * @return array + * @param array $sizes { + * An array of image size arrays. Default sizes are 'small', 'medium', 'large'. + * + * @type array $size { + * @type int $width Image width. + * @type int $height Image height. + * @type bool $crop Optional. Whether to crop the image. Default false. + * } + * } + * @return array An array of resized images metadata by size. */ public function multi_resize( $sizes ) { $metadata = array(); diff --git a/src/wp-includes/class-wp-image-editor.php b/src/wp-includes/class-wp-image-editor.php index d97af3b5dc..81909f89be 100644 --- a/src/wp-includes/class-wp-image-editor.php +++ b/src/wp-includes/class-wp-image-editor.php @@ -94,18 +94,22 @@ abstract class WP_Image_Editor { abstract public function resize( $max_w, $max_h, $crop = false ); /** - * Processes current image and saves to disk - * multiple sizes from single source. - * - * 'width' and 'height' are required. - * 'crop' defaults to false when not provided. + * Resize multiple images from a single source. * * @since 3.5.0 * @access public * @abstract * - * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... } - * @return array + * @param array $sizes { + * An array of image size arrays. Default sizes are 'small', 'medium', 'large'. + * + * @type array $size { + * @type int $width Image width. + * @type int $height Image height. + * @type bool $crop Optional. Whether to crop the image. Default false. + * } + * } + * @return array An array of resized images metadata by size. */ abstract public function multi_resize( $sizes );