Ticket #31093: 31093.4.diff

src/wp-includes/shortcodes.php

@@ -127 +127 @@
 }
 
 /**
- * Whether the passed content contains the specified shortcode
+ * Whether the passed content contains any or specified shortcode.
+ * Can accept an array of shortcode tags.
  *
  * @since 3.6.0
  *
  * @global array $shortcode_tags
  *
- * @param string $content Content to search for shortcodes.
- * @param string $tag     Shortcode tag to check.
- * @return bool Whether the passed content contains the given shortcode.
+ * @param string       $content      Content to search for shortcodes.
+ * @param array|string $tag          Optional. Shortcode tag to check. Default empty string.
+ * @param string       $tag_relation Optional. When multiple shortcode tags are passed,
+ *                                   comparison operator for final result. Default 'OR'.
+ * @return bool        $return       Whether the passed content contains the given shortcodes.
  */
-function has_shortcode( $content, $tag ) {
+function has_shortcode( $content, $tag = '', $tag_relation = 'OR' ) {
         if ( false === strpos( $content, '[' ) ) {
                 return false;
         }
 
-        if ( shortcode_exists( $tag ) ) {
-                preg_match_all( '/' . get_shortcode_regex() . '/', $content, $matches, PREG_SET_ORDER );
-                if ( empty( $matches ) )
-                        return false;
+        if ( empty( $tag ) ) {
+                return strip_shortcodes( $content ) !== $content;
+        }
+
+        preg_match_all( '/' . get_shortcode_regex() . '/s', $content, $matches, PREG_SET_ORDER );
 
+        if ( empty( $matches ) ) {
+                return false;
+        }
+
+        if ( is_array( $tag ) ) {
+                $tag_relation = strtoupper( $tag_relation );
+                if ( 'OR' === $tag_relation ) {
+                        // Return true as soon as the first shortcode tag is found.
+                        foreach ( $tag as $stag ) {
+                                foreach ( $matches as $shortcode ) {
+                                        if ( $stag === $shortcode[2] ) {
+                                                return true;
+                                        } elseif ( ! empty( $shortcode[5] ) && has_shortcode( $shortcode[5], $stag ) ) {
+                                                return true;
+                                        }
+                                }
+                        }
+                } elseif ( 'AND' === $tag_relation ) {
+                        // Collect existence of all shortcode tags.
+                        $found_shortcode = array();
+                        foreach ( $tag as $stag ) {
+                                $found_shortcode[ $stag ] = false;
+                                foreach ( $matches as $shortcode ) {
+                                        if ( $stag === $shortcode[2] ) {
+                                                $found_shortcode[ $stag ] = true;
+                                        } elseif ( ! empty( $shortcode[5] ) && has_shortcode( $shortcode[5], $stag ) ) {
+                                                $found_shortcode[ $stag ] = true;
+                                        }
+                                }
+                        }
+                        // return true if all are true, else false.
+                        return count( array_unique( $found_shortcode ) ) === 1 && current( $found_shortcode );
+                }
+        } else {
                 foreach ( $matches as $shortcode ) {
                         if ( $tag === $shortcode[2] ) {
                                 return true;

tests/phpunit/tests/shortcode.php

@@ -580 +580 @@
                 $this->assertTrue( has_shortcode( $content_nested, 'gallery' ) );
                 remove_shortcode( 'foo' );
         }
+        
+        /**
+         * Tests if has_shortcode() detects any shortcode without tag input argument.
+         *
+         * @ticket 31093
+         */
+        public function test_has_shortcode_should_detect_any_shortcode_without_tag_input_argument() {
+                // Empty.
+                $content = '';
+                $this->assertFalse( has_shortcode( $content ) );
+
+                // Single shortcode.
+                $content = 'This is a blob with [gallery] in it';
+                $this->assertTrue( has_shortcode( $content ) );
+
+                // Two shortcodes.
+                $content = 'This is a blob with [gallery] and [playlist] in it';
+                $this->assertTrue( has_shortcode( $content ) );
+
+                // Un-registered [foo] shortcode.
+                $content = 'This is a blob with [foo] in it';
+                $this->assertFalse( has_shortcode( $content ) );
+
+                // Nested shortcode.
+                $content = 'This is a blob with [foo][gallery][/foo] in it';
+                $this->assertTrue( has_shortcode( $content ) );
+
+                // Register [foo] shortcode.
+                add_shortcode( 'foo', '__return_empty_string' );
+                $this->assertTrue( has_shortcode( $content ) );
+                remove_shortcode( 'foo' );
+        }
+
+        /**
+         * Tests if has_shortcode() detects any shortcode from a list of shortcodes.
+         *
+         * @ticket 31093
+         */
+        public function test_has_shortcode_should_detect_any_listed_shortcodes() {
+                // Empty.
+                $content = '';
+                $this->assertFalse( has_shortcode( $content, array( 'gallery', 'playlist' ) ) );
+
+                // Single shortcode.
+                $content = 'This is a blob with [gallery] in it';
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'playlist' ), 'OR' ) );
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'playlist' ) ) );
+
+                // Two shortcodes.
+                $content = 'This is a blob with [foo], [gallery] and [playlist] in it';
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'playlist' ), 'OR' ) );
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'video' ), 'OR' ) );
+                $this->assertFalse( has_shortcode( $content, array( 'foo' ), 'OR' ) );
+                $this->assertFalse( has_shortcode( $content, array( 'foo' ) ) );
+
+                // Nested shortcode.
+                $content = 'This is a blob with [foo][gallery][/foo] in it';
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'foo' ), 'OR' ) );
+                $this->assertFalse( has_shortcode( $content, array( 'video' ), 'OR' ) );
+
+                // Register [foo] shortcode.
+                add_shortcode( 'foo', '__return_empty_string' );
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'foo' ), 'OR' ) );
+                $this->assertFalse( has_shortcode( $content, array( 'video' ), 'OR' ) );
+                remove_shortcode( 'foo' );
+        }
+
+        /**
+         * Tests if has_shortcode() detects all shortcodes from a list.
+         *
+         * @ticket 31093
+         */
+        public function test_has_shortcode_should_detect_all_listed_shortcodes() {
+                // Empty.
+                $content = '';
+                $this->assertFalse( has_shortcode( $content, array( 'gallery', 'playlist' ), 'AND' ) );
+
+                // Single shortcode.
+                $content = 'This is a blob with [gallery] in it';
+                $this->assertFalse( has_shortcode( $content, array( 'gallery', 'playlist' ), 'AND' ) );
+
+                // Two shortcodes.
+                $content = 'This is a blob with [gallery] and [playlist] in it';
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'playlist' ), 'AND' ) );
+                $this->assertFalse( has_shortcode( $content, array( 'gallery', 'video' ), 'AND' ) );
+
+                // Non-existing [foo] shortcode.
+                $content = 'This is a blob with [foo] in it';
+                $this->assertFalse( has_shortcode( $content, array( 'foo' ), 'AND' ) );
+
+                // Nested shortcode.
+                $content = 'This is a blob with [foo][gallery][/foo] in it';
+                $this->assertFalse( has_shortcode( $content, array( 'gallery', 'foo' ), 'AND' ) );
+                $this->assertFalse( has_shortcode( $content, array( 'gallery', 'video' ), 'AND' ) );
+
+                // Register [foo] shortcode.
+                add_shortcode( 'foo', '__return_empty_string' );
+                $this->assertTrue( has_shortcode( $content, array( 'gallery', 'foo' ), 'AND' ) );
+                $this->assertFalse( has_shortcode( $content, array( 'gallery', 'video' ), 'AND' ) );
+                remove_shortcode( 'foo' );
+        }
 
         /**
          * Make sure invalid shortcode names are not allowed.