Ticket #42463: 42463.5.patch

src/wp-includes/media.php

@@ -268 +268 @@
 /**
  * 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
  *
  * @global array $_wp_additional_image_sizes Associative array of additional image sizes.
@@ -283 +275 @@
  * @param string     $name   Image size identifier.
  * @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. 1. If false, image will be scaled, not cropped (default).
+ *                                                                         2. If true, image will be cropped to the specified dimensions using center positions.
+ *                                                                         3. If an array, it 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'
+ *                                                                            The image will be cropped to the specified dimensions within the defined crop area.
  */
 function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
         global $_wp_additional_image_sizes;