Changeset 35045

Timestamp:

10/12/2015 03:42:22 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Adjust documentation for the $size argument in gallery_shortcode to clarify the required order of width and height values when passing an array.

Also adds the array type to the argument documentation.

Props jaspermdegroot.
See #34257.

File:

• trunk/src/wp-includes/media.php (modified) (1 diff)

trunk/src/wp-includes/media.php

@@ -1389 +1389 @@
  *                              Default 'dd', or 'figcaption' when the theme registers HTML5 gallery support.
  *     @type int    $columns    Number of columns of images to display. Default 3.
- *     @type string $size       Size of the images to display. Default 'thumbnail'.
+ *     @type string|array $size Size of the images to display. Accepts any valid image size, or an array of width
+ *                              and height values in pixels (in that order). Default 'thumbnail'.
  *     @type string $ids        A comma-separated list of IDs of attachments to display. Default empty.
  *     @type string $include    A comma-separated list of IDs of attachments to include. Default empty.