Changeset 56690 for trunk/src/wp-includes/deprecated.php

Timestamp:

09/25/2023 10:37:00 PM (2 years ago)

Author:

flixos90

Message:

Media: Rely on wp_get_loading_optimization_attributes() to add decoding="async" to images.

The wp_get_loading_optimization_attributes() function was introduced in 6.3, as a single centralized place to control loading optimization attributes for various tags, most importantly images.

This changeset consolidates the decoding="async" optimization, which was added in 6.1, to occur solely as part of wp_get_loading_optimization_attributes(), removing duplicate code and allowing centralized filtering based on [56651].

As part of the change, the wp_img_tag_add_decoding_attr() function has been deprecated. The filter of the same name continues to be maintained for backward compatibility, as before covering only images that are part of a content blob such as post content (the_content).

Props pereirinha, mukesh27, joemcgill, flixos90.
Fixes #58892.
See #53232.

File:

• trunk/src/wp-includes/deprecated.php (modified) (1 diff)

trunk/src/wp-includes/deprecated.php

@@ -5995 +5995 @@
     update_option( 'https_detection_errors', $support_errors );
 }
+
+/**
+ * Adds `decoding` attribute to an `img` HTML tag.
+ *
+ * The `decoding` attribute allows developers to indicate whether the
+ * browser can decode the image off the main thread (`async`), on the
+ * main thread (`sync`) or as determined by the browser (`auto`).
+ *
+ * By default WordPress adds `decoding="async"` to images but developers
+ * can use the {@see 'wp_img_tag_add_decoding_attr'} filter to modify this
+ * to remove the attribute or set it to another accepted value.
+ *
+ * @since 6.1.0
+ * @deprecated 6.4.0 Use wp_img_tag_add_loading_optimization_attrs() instead.
+ * @see wp_img_tag_add_loading_optimization_attrs()
+ *
+ * @param string $image   The HTML `img` tag where the attribute should be added.
+ * @param string $context Additional context to pass to the filters.
+ * @return string Converted `img` tag with `decoding` attribute added.
+ */
+function wp_img_tag_add_decoding_attr( $image, $context ) {
+    _deprecated_function( __FUNCTION__, '6.4.0', 'wp_img_tag_add_loading_optimization_attrs()' );
+
+    /*
+     * Only apply the decoding attribute to images that have a src attribute that
+     * starts with a double quote, ensuring escaped JSON is also excluded.
+     */
+    if ( ! str_contains( $image, ' src="' ) ) {
+        return $image;
+    }
+
+    /** This action is documented in wp-includes/media.php */
+    $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 );
+    }
+
+    return $image;
+}