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

Timestamp:

09/20/2022 10:29:55 AM (3 years 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.

File:

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

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.