Changeset 35050

Timestamp:

10/12/2015 03:55:12 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Adjust documentation for the $size parameter in wp_get_attachment_link() to clarify the required order of width and height values when passing an array.

Also adds the array type to the parameter documentation (already supported).

Props jaspermdegroot.
See #34257.

File:

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

trunk/src/wp-includes/post-template.php

@@ -1403 +1403 @@
  *
  * @param int|WP_Post  $id        Optional. Post ID or post object.
- * @param string       $size      Optional, default is 'thumbnail'. Size of image, either array or string.
+ * @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 'thumbnail'.
  * @param bool         $permalink Optional, default is false. Whether to add permalink to image.
  * @param bool         $icon      Optional, default is false. Whether to include icon.