From ecf00fc84407249ae2a699e3b3d31571194efa34 Mon Sep 17 00:00:00 2001
From: Joe McGill <joemcgill@gmail.com>
Date: Thu, 3 Oct 2019 14:47:59 +0000
Subject: [PATCH] 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.


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


git-svn-id: http://core.svn.wordpress.org/trunk@46175 1a063a9b-81f0-0310-95a4-ce76da25c4cd
---
 wp-includes/media.php   | 16 ++++++----------
 wp-includes/version.php |  2 +-
 2 files changed, 7 insertions(+), 11 deletions(-)

diff --git a/wp-includes/media.php b/wp-includes/media.php
index 71bfed3a42..a5a06564e8 100644
--- a/wp-includes/media.php
+++ b/wp-includes/media.php
@@ -268,14 +268,6 @@ function image_downsize( $id, $size = 'medium' ) {
 /**
  * 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,8 +275,12 @@ function image_downsize( $id, $size = 'medium' ) {
  * @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. 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 ) {
 	global $_wp_additional_image_sizes;
diff --git a/wp-includes/version.php b/wp-includes/version.php
index f054d12eef..88eeff4815 100644
--- a/wp-includes/version.php
+++ b/wp-includes/version.php
@@ -13,7 +13,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '5.3-beta2-46375';
+$wp_version = '5.3-beta2-46376';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.