Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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.

Built from https://develop.svn.wordpress.org/trunk@25728


git-svn-id: http://core.svn.wordpress.org/trunk@25641 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2013-10-08 17:19:09 +00:00
parent 7a7b9c89ec
commit 4ffec6be75
3 changed files with 33 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
wp-includes/class-wp-image-editor-gd.php
View File

@ -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();

18
wp-includes/class-wp-image-editor-imagick.php
View File

@ -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();

18
wp-includes/class-wp-image-editor.php
View File

@ -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 );