Changeset 46376

Timestamp:

10/03/2019 02:46:46 PM (5 years ago)

Author:

joemcgill

Message:

Media: Improve documentation for add_image_size()

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

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

File:

• trunk/src/wp-includes/media.php (modified) (2 diffs)

trunk/src/wp-includes/media.php

@@ -269 +269 @@
  * 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
  *
@@ -284 +276 @@
  * @param int        $width  Optional. Image width 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.
- *                           An array can specify positioning of the crop area. Default false.
+ * @param bool|array $crop   Optional. Image cropping behavior. If false, the image will be scaled (default),
+ *                           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 ) {