Changeset 38877

Timestamp:

10/23/2016 02:24:26 PM (8 years ago)

Author:

aaroncampbell

Message:

Shortcodes: Add new strip_shortcodes_tagnames filter.

With the new strip_shortcodes_tagnames filter you can specify which shortcodes are stripped by strip_shortcodes(). The default is all registered shortcodes.

Props DylanAuty, orvils, swissspidy.
Fixes #37767.

Location:

trunk

Files:

• src/wp-includes/shortcodes.php (modified) (1 diff)
• tests/phpunit/tests/shortcode.php (modified) (1 diff)

trunk/src/wp-includes/shortcodes.php

@@ -606 +606 @@
     // Find all registered tag names in $content.
     preg_match_all( '@\[([^<>&/\[\]\x00-\x20=]++)@', $content, $matches );
-    $tagnames = array_intersect( array_keys( $shortcode_tags ), $matches[1] );
+
+    $tags_to_remove = array_keys( $shortcode_tags );
+
+    /**
+     * Filters the list of shortcode tags to remove from the content.
+     *
+     * @since 4.7.0
+     *
+     * @param array  $tag_array Array of shortcode tags to remove.
+     * @param string $content   Content shortcodes are being removed from.
+     */
+    $tags_to_remove = apply_filters( 'strip_shortcodes_tagnames', $tags_to_remove, $content );
+
+    $tagnames = array_intersect( $tags_to_remove, $matches[1] );
 
     if ( empty( $tagnames ) ) {

trunk/tests/phpunit/tests/shortcode.php

@@ -341 +341 @@
     }
 
+    function data_test_strip_shortcodes() {
+        return array(
+            array( 'before', 'before[gallery]' ),
+            array( 'after', '[gallery]after' ),
+            array( 'beforeafter', 'before[gallery]after' ),
+            array( 'before[after', 'before[after' ),
+            array( 'beforeafter', 'beforeafter' ),
+            array( 'beforeafter', 'before[gallery id="123" size="medium"]after' ),
+            array( 'before[unregistered_shortcode]after', 'before[unregistered_shortcode]after' ),
+            array( 'beforeafter', 'before[footag]after' ),
+            array( 'before  after', 'before [footag]content[/footag] after' ),
+            array( 'before  after', 'before [footag foo="123"]content[/footag] after' ),
+        );
+    }
+
     /**
      * @ticket 10326
-     */
-    function test_strip_shortcodes() {
-        $this->assertEquals('before', strip_shortcodes('before[gallery]'));
-        $this->assertEquals('after', strip_shortcodes('[gallery]after'));
-        $this->assertEquals('beforeafter', strip_shortcodes('before[gallery]after'));
-    }
-
+     *
+     * @dataProvider data_test_strip_shortcodes
+     *
+     * @param string $expected  Expected output.
+     * @param string $content   Content to run strip_shortcodes() on.
+     */
+    function test_strip_shortcodes( $expected, $content ) {
+        $this->assertEquals( $expected, strip_shortcodes( $content ) );
+    }
+
+    /**
+     * @ticket 37767
+     */
+    function test_strip_shortcodes_filter() {
+        add_filter( 'strip_shortcodes_tagnames', array( $this, '_filter_strip_shortcodes_tagnames' ) );
+        $this->assertEquals( 'beforemiddle [footag]after', strip_shortcodes( 'before[gallery]middle [footag]after' ) );
+        remove_filter( 'strip_shortcodes_tagnames', array( $this, '_filter_strip_shortcodes_tagnames' ) );
+    }
+
+    function _filter_strip_shortcodes_tagnames() {
+        return array( 'gallery' );
+    }
 
     // Store passed in shortcode_atts_{$shortcode} args