Changeset 54248

Timestamp:

09/20/2022 10:29:55 AM (9 months ago)

Author:

audrasjb

Message:

Shortcodes: Reverse wrapping of apply_shortcodes() and do_shortcode().

This changeset reverses the wrapping of apply_shortcodes() and do_shortcode() such that apply_shortcodes() is now the recommended function. In addition:

• Calls to do_shortcode() have been changed to apply_shortcodes().
• Some default filter callbacks have been changed from 'do_shortcode' to 'apply_shortcodes'.
• Applicable documentation has been updated to refer to apply_shortcodes() instead.

Follow-up to [47004].

Props SergeyBiryukov, rafiahmedd, namithjawahar, peterwilsoncc, costdev.
Fixes #55883.

Location:

trunk/src

Files:

• wp-admin/includes/ajax-actions.php (modified) (2 diffs)
• wp-includes/block-template.php (modified) (1 diff)
• wp-includes/class-wp-embed.php (modified) (3 diffs)
• wp-includes/default-filters.php (modified) (2 diffs)
• wp-includes/media.php (modified) (2 diffs)
• wp-includes/shortcodes.php (modified) (6 diffs)
• wp-includes/widgets/class-wp-widget-text.php (modified) (3 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -3789 +3789 @@
         }
 
-        $html = do_shortcode( $parsed );
+        $html = apply_shortcodes( $parsed );
 
         global $wp_scripts;
@@ -3862 +3862 @@
     }
 
-    $parsed = do_shortcode( $shortcode );
+    $parsed = apply_shortcodes( $shortcode );
 
     if ( empty( $parsed ) ) {

trunk/src/wp-includes/block-template.php

@@ -243 +243 @@
     $content = shortcode_unautop( $content );
     $content = wp_filter_content_tags( $content );
-    $content = do_shortcode( $content );
+    $content = apply_shortcodes( $content );
     $content = str_replace( ']]>', ']]>', $content );
 

trunk/src/wp-includes/class-wp-embed.php

@@ -53 +53 @@
      * Since the [embed] shortcode needs to be run earlier than other shortcodes,
      * this function removes all existing shortcodes, registers the [embed] shortcode,
-     * calls do_shortcode(), and then re-registers the old shortcodes.
+     * calls apply_shortcodes(), and then re-registers the old shortcodes.
      *
      * @global array $shortcode_tags
@@ -70 +70 @@
 
         // Do the shortcode (only the [embed] one is registered).
-        $content = do_shortcode( $content, true );
+        $content = apply_shortcodes( $content, true );
 
         // Put the original shortcodes back.
@@ -178 +178 @@
 
     /**
-     * The do_shortcode() callback function.
+     * The apply_shortcodes() callback function.
      *
      * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of

trunk/src/wp-includes/default-filters.php

@@ -229 +229 @@
 add_filter( 'widget_block_content', 'do_blocks', 9 );
 add_filter( 'widget_block_content', 'wp_filter_content_tags' );
-add_filter( 'widget_block_content', 'do_shortcode', 11 );
+add_filter( 'widget_block_content', 'apply_shortcodes', 11 );
 
 add_filter( 'block_type_metadata', 'wp_migrate_old_typography_shape' );
@@ -606 +606 @@
 
 // Shortcodes.
-add_filter( 'the_content', 'do_shortcode', 11 ); // AFTER wpautop().
+add_filter( 'the_content', 'apply_shortcodes', 11 ); // AFTER wpautop().
 
 // Media.

trunk/src/wp-includes/media.php

@@ -2297 +2297 @@
             $style,
             esc_attr( $class ),
-            do_shortcode( $content ),
+            apply_shortcodes( $content ),
             sprintf(
                 '<figcaption %sclass="wp-caption-text">%s</figcaption>',
@@ -2310 +2310 @@
             $style,
             esc_attr( $class ),
-            str_replace( '<img ', '<img ' . $describedby, do_shortcode( $content ) ),
+            str_replace( '<img ', '<img ' . $describedby, apply_shortcodes( $content ) ),
             sprintf(
                 '<p %sclass="wp-caption-text">%s</p>',

trunk/src/wp-includes/shortcodes.php

@@ -22 +22 @@
  * To apply shortcode tags to content:
  *
- *     $out = do_shortcode( $content );
+ *     $out = apply_shortcodes( $content );
  *
  * @link https://developer.wordpress.org/plugins/shortcodes/
@@ -172 +172 @@
  * Searches content for shortcodes and filter shortcodes through their hooks.
  *
- * This function is an alias for do_shortcode().
+ * If there are no shortcode tags defined, then the content will be returned
+ * without any filtering. This might cause issues when plugins are disabled but
+ * the shortcode will still show up in the post or content.
  *
  * @since 5.4.0
  *
- * @see do_shortcode()
+ * @global array $shortcode_tags List of shortcode tags and their callback hooks.
  *
  * @param string $content     Content to search for shortcodes.
@@ -184 +186 @@
  */
 function apply_shortcodes( $content, $ignore_html = false ) {
-    return do_shortcode( $content, $ignore_html );
+    global $shortcode_tags;
+
+    if ( false === strpos( $content, '[' ) ) {
+        return $content;
+    }
+
+    if ( empty( $shortcode_tags ) || ! is_array( $shortcode_tags ) ) {
+        return $content;
+    }
+
+    // Find all registered tag names in $content.
+    preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches );
+    $tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] );
+
+    if ( empty( $tagnames ) ) {
+        return $content;
+    }
+
+    $content = do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames );
+
+    $pattern = get_shortcode_regex( $tagnames );
+    $content = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $content );
+
+    // Always restore square braces so we don't break things like <!--[if IE ]>.
+    $content = unescape_invalid_shortcodes( $content );
+
+    return $content;
 }
 
@@ -190 +218 @@
  * Searches content for shortcodes and filter shortcodes through their hooks.
  *
- * If there are no shortcode tags defined, then the content will be returned
- * without any filtering. This might cause issues when plugins are disabled but
- * the shortcode will still show up in the post or content.
- *
- * @since 2.5.0
- *
- * @global array $shortcode_tags List of shortcode tags and their callback hooks.
+ * This function is an alias for apply_shortcodes().
+ *
+ * @since 2.5.0
+ *
+ * @see apply_shortcodes()
  *
  * @param string $content     Content to search for shortcodes.
@@ -204 +230 @@
  */
 function do_shortcode( $content, $ignore_html = false ) {
-    global $shortcode_tags;
-
-    if ( false === strpos( $content, '[' ) ) {
-        return $content;
-    }
-
-    if ( empty( $shortcode_tags ) || ! is_array( $shortcode_tags ) ) {
-        return $content;
-    }
-
-    // Find all registered tag names in $content.
-    preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches );
-    $tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] );
-
-    if ( empty( $tagnames ) ) {
-        return $content;
-    }
-
-    $content = do_shortcodes_in_html_tags( $content, $ignore_html, $tagnames );
-
-    $pattern = get_shortcode_regex( $tagnames );
-    $content = preg_replace_callback( "/$pattern/", 'do_shortcode_tag', $content );
-
-    // Always restore square braces so we don't break things like <!--[if IE ]>.
-    $content = unescape_invalid_shortcodes( $content );
-
-    return $content;
+    return apply_shortcodes( $content, $ignore_html );
 }
 
@@ -300 +300 @@
 
 /**
- * Regular Expression callable for do_shortcode() for calling shortcode hook.
+ * Regular Expression callable for apply_shortcodes() for calling shortcode hook.
  *
  * @see get_shortcode_regex() for details of the match array contents.

trunk/src/wp-includes/widgets/class-wp-widget-text.php

@@ -245 +245 @@
         /*
          * Suspend legacy plugin-supplied do_shortcode() for 'widget_text' filter for the visual Text widget to prevent
-         * shortcodes being processed twice. Now do_shortcode() is added to the 'widget_text_content' filter in core itself
+         * shortcodes being processed twice. Now apply_shortcodes() is added to the 'widget_text_content' filter in core itself
          * and it applies after wpautop() to prevent corrupting HTML output added by the shortcode. When do_shortcode() is
-         * added to 'widget_text_content' then do_shortcode() will be manually called when in legacy mode as well.
+         * added to 'widget_text_content' then apply_shortcodes() will be manually called when in legacy mode as well.
          */
         $widget_text_do_shortcode_priority       = has_filter( 'widget_text', 'do_shortcode' );
@@ -303 +303 @@
             /*
              * Manually do shortcodes on the content when the core-added filter is present. It is added by default
-             * in core by adding do_shortcode() to the 'widget_text_content' filter to apply after wpautop().
+             * in core by adding apply_shortcodes() to the 'widget_text_content' filter to apply after wpautop().
              * Since the legacy Text widget runs wpautop() after 'widget_text' filters are applied, the widget in
-             * legacy mode here manually applies do_shortcode() on the content unless the default
+             * legacy mode here manually applies apply_shortcodes() on the content unless the default
              * core filter for 'widget_text_content' has been removed, or if do_shortcode() has already
              * been applied via a plugin adding do_shortcode() to 'widget_text' filters.
@@ -313 +313 @@
                     $text = shortcode_unautop( $text );
                 }
-                $text = do_shortcode( $text );
+                $text = apply_shortcodes( $text );
             }
         }