Changeset 49021 for trunk/src/wp-admin/includes/media.php

Timestamp:

09/20/2020 04:21:42 PM (3 years ago)

Author:

johnbillion

Message:

Media: Standardise the description for image size parameters.

This brings continuity to all the image related functions and filters which accept or pass a size parameter.

Props dilipbheda, johnbillion

Fixes #47364

File:

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

trunk/src/wp-admin/includes/media.php

@@ -126 +126 @@
  * @param string       $url     Optional. Image src URL. Default empty.
  * @param bool|string  $rel     Optional. Value for rel attribute or whether to add a default value. Default false.
- * @param string|array $size    Optional. Image size. Accepts any valid image size, or an array of width
- *                              and height values in pixels (in that order). Default 'medium'.
+ * @param string|int[] $size    Optional. Image size. Accepts any registered image size name, or an array of
+ *                              width and height values in pixels (in that order). Default 'medium'.
  * @param string       $alt     Optional. Image alt attribute. Default empty.
  * @return string The HTML output to insert into the editor.
@@ -161 +161 @@
      * @param string       $align   The image alignment.
      * @param string       $url     The image source URL.
-     * @param string|array $size    Size of image. Image size or array of width and height values
-     *                              (in that order). Default 'medium'.
+     * @param string|int[] $size    Requested image size. Can be any registered image size name, or
+     *                              an array of width and height values in pixels (in that order).
      * @param string       $alt     The image alternative, or alt, text.
      * @param string       $rel     The image rel attribute.