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

Timestamp:

07/02/2020 02:01:28 AM (5 years ago)

Author:

flixos90

Message:

Media: Improve support for opting out of lazy-loading for template images.

With this changeset, in addition to the already present wp_lazy_loading_enabled filter, developers can now opt out of lazy-loading template images via wp_get_attachment_image() by passing a loading attribute with boolean value false. This can be used e.g. by theme developers on images which are very likely to be in the initial viewport.

This changeset also improves related test coverage.

Props adamsilverstein, azaozz, joemcgill, johnbillion.
See #50425, #44427.

File:

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

trunk/src/wp-includes/media.php

@@ -1049 +1049 @@
         $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 ( array_key_exists( 'loading', $attr ) && ! $attr['loading'] ) {
+            unset( $attr['loading'] );
+        }
+
         // Generate 'srcset' and 'sizes' if not already present.
         if ( empty( $attr['srcset'] ) ) {
@@ -1726 +1732 @@
      * @since 5.5.0
      *
-     * @param string $value   The `loading` attribute value, defaults to `lazy`.
-     * @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|bool $value   The `loading` attribute value. Returning a false-y value will result in the
+     *                             attribute being omitted for the image. Default is `lazy`.
+     * @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.
      */
     $value = apply_filters( 'wp_img_tag_add_loading_attr', 'lazy', $image, $context );