Make WordPress Core


Ignore:
Timestamp:
09/20/2020 04:21:42 PM (4 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/media.php

    r49020 r49021  
    126126 * @param string       $url     Optional. Image src URL. Default empty.
    127127 * @param bool|string  $rel     Optional. Value for rel attribute or whether to add a default value. Default false.
    128  * @param string|array $size    Optional. Image size. Accepts any valid image size, or an array of width
    129  *                              and height values in pixels (in that order). Default 'medium'.
     128 * @param string|int[] $size    Optional. Image size. Accepts any registered image size name, or an array of
     129 *                              width and height values in pixels (in that order). Default 'medium'.
    130130 * @param string       $alt     Optional. Image alt attribute. Default empty.
    131131 * @return string The HTML output to insert into the editor.
     
    161161     * @param string       $align   The image alignment.
    162162     * @param string       $url     The image source URL.
    163      * @param string|array $size    Size of image. Image size or array of width and height values
    164      *                              (in that order). Default 'medium'.
     163     * @param string|int[] $size    Requested image size. Can be any registered image size name, or
     164     *                              an array of width and height values in pixels (in that order).
    165165     * @param string       $alt     The image alternative, or alt, text.
    166166     * @param string       $rel     The image rel attribute.
Note: See TracChangeset for help on using the changeset viewer.