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

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.

File:

• trunk/src/wp-content/themes/twentynineteen/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 ) {