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

Timestamp:

08/24/2020 10:02:44 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add documentation and a @since note about the loading attribute added to wp_get_attachment_image().

Follow-up to [48272].

Props audrasjb.
Fixes #51122.

File:

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

trunk/src/wp-includes/media.php

@@ -1003 +1003 @@
  *
  * @since 2.5.0
+ * @since 5.5.0 The `$loading` attribute was added.
  *
  * @param int          $attachment_id Image attachment ID.
@@ -1011 +1012 @@
  *     Optional. Attributes for the image markup.
  *
- *     @type string $src    Image attachment URL.
- *     @type string $class  CSS class name or space-separated list of classes.
- *                          Default `attachment-$size_class size-$size_class`,
- *                          where `$size_class` is the image size being requested.
- *     @type string $alt    Image description for the alt attribute.
- *     @type string $srcset The 'srcset' attribute value.
- *     @type string $sizes  The 'sizes' attribute value.
+ *     @type string       $src     Image attachment URL.
+ *     @type string       $class   CSS class name or space-separated list of classes.
+ *                                 Default `attachment-$size_class size-$size_class`,
+ *                                 where `$size_class` is the image size being requested.
+ *     @type string       $alt     Image description for the alt attribute.
+ *     @type string       $srcset  The 'srcset' attribute value.
+ *     @type string       $sizes   The 'sizes' attribute value.
+ *     @type string|false $loading The 'loading' attribute value. Passing a value of false
+ *                                 will result in the attribute being omitted for the image.
+ *                                 Defaults to 'lazy', depending on wp_lazy_loading_enabled().
  * }
  * @return string HTML img element or empty string on failure.
@@ -1049 +1053 @@
         $attr = wp_parse_args( $attr, $default_attr );
 
-        // If `loading` attribute default of `lazy` is overridden for this
-        // image to omit the attribute, ensure it is not included.
+        // If the default value of `lazy` for the `loading` attribute is overridden
+        // to omit the attribute for this image, ensure it is not included.
         if ( array_key_exists( 'loading', $attr ) && ! $attr['loading'] ) {
             unset( $attr['loading'] );