Changeset 25728

Timestamp:

10/08/2013 05:19:00 PM (11 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation for the multi_resize() method in WP_Image_Editor, WP_Image_Editor_GD, and WP_Image_Editor_Imagick.

Props paolal for the initial patch.
Fixes #25530.

Location:

trunk/src/wp-includes

Files:

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

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

@@ -176 +176 @@
 
     /**
-     * Processes current image and saves to disk
-     * multiple sizes from single source.
-     *
-     * 'width' and 'height' are required.
-     * 'crop' defaults to false when not provided.
-     *
-     * @since 3.5.0
-     * @access public
-     *
-     * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... }
-     * @return array
+     * Resize multiple images from a single source.
+     *
+     * @since 3.5.0
+     * @access public
+     *
+     * @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 ) {

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

@@ -243 +243 @@
 
     /**
-     * Processes current image and saves to disk
-     * multiple sizes from single source.
-     *
-     * 'width' and 'height' are required.
-     * 'crop' defaults to false when not provided.
-     *
-     * @since 3.5.0
-     * @access public
-     *
-     * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... }
-     * @return array
+     * Resize multiple images from a single source.
+     *
+     * @since 3.5.0
+     * @access public
+     *
+     * @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 ) {

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

@@ -95 +95 @@
 
     /**
-     * Processes current image and saves to disk
-     * multiple sizes from single source.
-     *
-     * 'width' and 'height' are required.
-     * 'crop' defaults to false when not provided.
-     *
-     * @since 3.5.0
-     * @access public
-     * @abstract
-     *
-     * @param array $sizes { {'width'=>int, 'height'=>int, ['crop'=>bool]}, ... }
-     * @return array
+     * Resize multiple images from a single source.
+     *
+     * @since 3.5.0
+     * @access public
+     * @abstract
+     *
+     * @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 );