sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Media: Improve documentation for add_image_size()

Browse Source 
This improves the description of the `$crop` parameter to clarify behavior.

Props nikolastoqnow, ketuchetan, audrasjb, killua99, pierlo.
Fixes #42463.



git-svn-id: https://develop.svn.wordpress.org/trunk@46376 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Joe McGill 2019-10-03 14:46:46 +00:00
parent 37cdffd3cc
commit 0c66e65b42
1 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/wp-includes/media.php
View File

@ -268,14 +268,6 @@ function image_downsize( $id, $size = 'medium' ) {
/** /**
* Register a new image size. * Register a new image size.
* *
* Cropping behavior for the image size is dependent on the value of $crop:
* 1. If false (default), images will be scaled, not cropped.
* 2. If an array in the form of array( x_crop_position, y_crop_position ):
* - x_crop_position accepts 'left' 'center', or 'right'.
* - y_crop_position accepts 'top', 'center', or 'bottom'.
* Images will be cropped to the specified dimensions within the defined crop area.
* 3. If true, images will be cropped to the specified dimensions using center positions.
*
* @since 2.9.0 * @since 2.9.0
* *
* @global array $_wp_additional_image_sizes Associative array of additional image sizes. * @global array $_wp_additional_image_sizes Associative array of additional image sizes.
@ -283,8 +275,12 @@ function image_downsize( $id, $size = 'medium' ) {
* @param string $name Image size identifier. * @param string $name Image size identifier.
* @param int $width Optional. Image width in pixels. Default 0. * @param int $width Optional. Image width in pixels. Default 0.
* @param int $height Optional. Image height in pixels. Default 0. * @param int $height Optional. Image height in pixels. Default 0.
* @param bool|array $crop Optional. Whether to crop images to specified width and height or resize. * @param bool|array $crop Optional. Image cropping behavior. If false, the image will be scaled (default),
* An array can specify positioning of the crop area. Default false. * 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.
* Array values must be in the format: array( x_crop_position, y_crop_position ) where:
* - x_crop_position accepts: 'left', 'center', or 'right'.
* - y_crop_position accepts: 'top', 'center', or 'bottom'.
*/ */
function add_image_size( $name, $width = 0, $height = 0, $crop = false ) { function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
global $_wp_additional_image_sizes; global $_wp_additional_image_sizes;