Changeset 53481 for trunk/src/wp-includes/media.php

Timestamp:

06/09/2022 04:19:39 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Media: Some documentation and test improvements for wp_img_tag_add_decoding_attr():

• Add a @since note for the decoding attribute in wp_get_attachment_image().
• Adjust wp_img_tag_add_decoding_attr() DocBlocks per the documentation standards.
• Wrap some long sprintf() calls in unit tests for better readability. In at least one case, the_content was unnecessarily passed to sprintf() as an extra (unused) parameter.

Follow-up to [53480].

See #53232.

File:

• trunk/src/wp-includes/media.php (modified) (3 diffs)

trunk/src/wp-includes/media.php

@@ -1004 +1004 @@
  * @since 4.4.0 The `$srcset` and `$sizes` attributes were added.
  * @since 5.5.0 The `$loading` attribute was added.
+ * @since 6.1.0 The `$decoding` attribute was added.
  *
  * @param int          $attachment_id Image attachment ID.
@@ -1944 +1945 @@
 
 /**
- * Add `decoding` attribute to an `img` HTML tag.
+ * Adds `decoding` attribute to an `img` HTML tag.
  *
  * The `decoding` attribute allows developers to indicate whether the
@@ -1969 +1970 @@
      * @since 6.1.0
      *
-     * @param string|false|null $value   The `decoding` attribute value. Returning a falsey value will result in
-     *                                   the attribute being omitted for the image. Otherwise, it may be:
-     *                                   'async' (default), 'sync', or 'auto'.
+     * @param string|false|null $value   The `decoding` attribute value. Returning a falsey value
+     *                                   will result in the attribute being omitted for the image.
+     *                                   Otherwise, it may be: 'async' (default), 'sync', or 'auto'.
      * @param string            $image   The HTML `img` tag to be filtered.
-     * @param string            $context Additional context about how the function was called or where the img tag is.
+     * @param string            $context Additional context about how the function was called
+     *                                   or where the img tag is.
      */
     $value = apply_filters( 'wp_img_tag_add_decoding_attr', 'async', $image, $context );
+
     if ( in_array( $value, array( 'async', 'sync', 'auto' ), true ) ) {
         $image = str_replace( '<img ', '<img decoding="' . esc_attr( $value ) . '" ', $image );