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

Timestamp:

09/21/2023 04:35:30 PM (3 years ago)

Author:

flixos90

Message:

Media: Introduce filters to customize the results from wp_get_loading_optimization_attributes().

This changeset introduces two filters that allow customizing the loading optimization attributes array returned from wp_get_loading_optimization_attributes() for individual HTML tags:

• The wp_get_loading_optimization_attributes filter can be used to modify the results from the WordPress core logic.
• The pre_wp_get_loading_optimization_attributes filter can be used to use entirely custom logic and effectively short-circuit the core function.

Props pereirinha, mukesh27, spacedmonkey, joemcgill.
Fixes #58893.

File:

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

trunk/src/wp-includes/media.php

@@ -5626 +5626 @@
         global $wp_query;
 
+        /**
+         * Filters whether to short-circuit loading optimization attributes.
+         *
+         * Returning an array from the filter will effectively short-circuit the loading of optimization attributes,
+         * returning that value instead.
+         *
+         * @since 6.4.0
+         *
+         * @param array|false $loading_attrs False by default, or array of loading optimization attributes to short-circuit.
+         * @param string      $tag_name      The tag name.
+         * @param array       $attr          Array of the attributes for the tag.
+         * @param string      $context       Context for the element for which the loading optimization attribute is requested.
+         */
+        $loading_attrs = apply_filters( 'pre_wp_get_loading_optimization_attributes', false, $tag_name, $attr, $context );
+
+        if ( is_array( $loading_attrs ) ) {
+                return $loading_attrs;
+        }
+
         $loading_attrs = array();
 
@@ -5633 +5652 @@
          */
         if ( 'template' === $context ) {
-                return $loading_attrs;
+                /** This filter is documented in wp-includes/media.php */
+                return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
         }
 
         // For now this function only supports images and iframes.
         if ( 'img' !== $tag_name && 'iframe' !== $tag_name ) {
-                return $loading_attrs;
+                /** This filter is documented in wp-includes/media.php */
+                return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
         }
 
         // For any resources, width and height must be provided, to avoid layout shifts.
         if ( ! isset( $attr['width'], $attr['height'] ) ) {
-                return $loading_attrs;
+                /** This filter is documented in wp-includes/media.php */
+                return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
         }
 
@@ -5655 +5677 @@
         // TODO: Handle shortcode images together with the content (see https://core.trac.wordpress.org/ticket/58853).
         if ( 'the_content' !== $context && 'do_shortcode' !== $context && doing_filter( 'the_content' ) ) {
-                return $loading_attrs;
+                /** This filter is documented in wp-includes/media.php */
+                return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
         }
 
@@ -5790 +5813 @@
         }
 
-        return $loading_attrs;
+        /**
+         * Filters the loading optimization attributes.
+         *
+         * @since 6.4.0
+         *
+         * @param array  $loading_attrs The loading optimization attributes.
+         * @param string $tag_name      The tag name.
+         * @param array  $attr          Array of the attributes for the tag.
+         * @param string $context       Context for the element for which the loading optimization attribute is requested.
+         */
+        return apply_filters( 'wp_get_loading_optimization_attributes', $loading_attrs, $tag_name, $attr, $context );
 }