Changeset 56214 for trunk/src/wp-includes/shortcodes.php

Timestamp:

07/11/2023 01:56:55 PM (21 months ago)

Author:

joemcgill

Message:

Media: Optimize images created in shortcodes.

This fixes an issue where images dynamically created during shortcode rendering (e.g., shortcode image galleries), were not getting image optimizations like loading="lazy" or fetchpriority="hight" applied. Note that even after this commit, shortcodes are processed after the main content images, which can affect the order in which optimizations are applied in content areas.

Follow-up to [56037].

Props spacedmonkey, flixos90, thekt12, swissspidy, joemcgill.
Fixes #58681.

File:

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

trunk/src/wp-includes/shortcodes.php

@@ -222 +222 @@
     }
 
+    // Ensure this context is only added once if shortcodes are nested.
+    $has_filter = has_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
+    $filter_added = false;
+
+    if ( ! $has_filter ) {
+        $filter_added = add_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
+    }
+
     $content = do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames );
 
@@ -230 +238 @@
     $content = unescape_invalid_shortcodes( $content );
 
+    // Only remove the filter if it was added in this scope.
+    if ( $filter_added ) {
+        remove_filter( 'wp_get_attachment_image_context', '_filter_do_shortcode_context' );
+    }
+
     return $content;
+}
+
+/**
+ * Filter the `wp_get_attachment_image_context` hook during shortcode rendering.
+ *
+ * When wp_get_attachment_image() is called during shortcode rendering, we need to make clear
+ * that the context is a shortcode and not part of the theme's template rendering logic.
+ *
+ * @since 6.3.0
+ * @access private
+ *
+ * @return string The filtered context value for wp_get_attachment_images when doing shortcodes.
+ */
+function _filter_do_shortcode_context() {
+    return 'do_shortcode';
 }