Changeset 51607

Timestamp:

08/12/2021 07:29:43 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Synchronize documentation for wp_get_attachment_image_attributes filter callbacks in bundled themes:

• Twenty Sixteen: Correct the $attachment parameter type, use typed array notation.
• Twenty Seventeen: Correct the $attachment parameter type, use typed array notation.
• Twenty Nineteen: Correct the @return value type, use typed array notation.
• Twenty Twenty-One: Add missing @return value description, use typed array notation.

Follow-up to [29836], [47249], [49021], [49597].

Props ankitmaru, mukesh27, SergeyBiryukov.
Fixes #53878.

Location:

trunk/src/wp-content/themes

Files:

• twentynineteen/inc/template-functions.php (modified) (1 diff)
• twentyseventeen/functions.php (modified) (1 diff)
• twentysixteen/functions.php (modified) (1 diff)
• twentytwentyone/inc/template-functions.php (modified) (1 diff)

trunk/src/wp-content/themes/twentynineteen/inc/template-functions.php

@@ -97 +97 @@
 
 /**
- * Add custom sizes attribute to responsive image functionality for post thumbnails.
+ * Add custom 'sizes' attribute to responsive image functionality for post thumbnails.
  *
  * @origin Twenty Nineteen 1.0
  *
- * @param array $attr  Attributes for the image markup.
- * @return string Value for use in post thumbnail 'sizes' attribute.
+ * @param string[] $attr Array of attribute values for the image markup, keyed by attribute name.
+ *                       See wp_get_attachment_image().
+ * @return string[] The filtered attributes for the image markup.
  */
 function twentynineteen_post_thumbnail_sizes_attr( $attr ) {

trunk/src/wp-content/themes/twentyseventeen/functions.php

@@ -574 +574 @@
  * @since Twenty Seventeen 1.0
  *
- * @param array $attr       Attributes for the image markup.
- * @param int   $attachment Image attachment ID.
- * @param array $size       Registered image size or flat array of height and width dimensions.
- * @return array The filtered attributes for the image markup.
+ * @param string[]     $attr       Array of attribute values for the image markup, keyed by attribute name.
+ *                                 See wp_get_attachment_image().
+ * @param WP_Post      $attachment Image attachment post.
+ * @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).
+ * @return string[] The filtered attributes for the image markup.
  */
 function twentyseventeen_post_thumbnail_sizes_attr( $attr, $attachment, $size ) {

trunk/src/wp-content/themes/twentysixteen/functions.php

@@ -560 +560 @@
  * @since Twenty Sixteen 1.0
  *
- * @param array $attr Attributes for the image markup.
- * @param int   $attachment Image attachment ID.
- * @param array $size Registered image size or flat array of height and width dimensions.
- * @return array The filtered attributes for the image markup.
+ * @param string[]     $attr       Array of attribute values for the image markup, keyed by attribute name.
+ *                                 See wp_get_attachment_image().
+ * @param WP_Post      $attachment Image attachment post.
+ * @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).
+ * @return string[] The filtered attributes for the image markup.
  */
 function twentysixteen_post_thumbnail_sizes_attr( $attr, $attachment, $size ) {

trunk/src/wp-content/themes/twentytwentyone/inc/template-functions.php

@@ -433 +433 @@
  * @since Twenty Twenty-One 1.0
  *
- * @param array        $attr       Array of attribute values for the image markup, keyed by attribute name.
+ * @param string[]     $attr       Array of attribute values for the image markup, keyed by attribute name.
  *                                 See wp_get_attachment_image().
  * @param WP_Post      $attachment Image attachment post.
- * @param string|array $size       Requested size. Image size or array of width and height values
- *                                 (in that order). Default 'thumbnail'.
- * @return array
+ * @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).
+ * @return string[] The filtered attributes for the image markup.
  */
 function twenty_twenty_one_get_attachment_image_attributes( $attr, $attachment, $size ) {