Changeset 46369

Timestamp:

10/01/2019 03:41:58 AM (5 years ago)

Author:

whyisjake

Message:

Shortcodes: Improve handling from shortcode_parse_attts().

Ensure consistency between shortcode_parse_attts() when being used directly.

Props mauteri, birgire, SergeyBiryukov, kadamwhite, whyisjake.
Fixes #47863.

Location:

trunk

Files:

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

trunk/src/wp-includes/shortcodes.php

@@ -489 +489 @@
  *
  * @since 2.5.0
- *
- * @param string $text
+ * @since 5.3.0 Support of a full shortcode input.
+ *
+ * @param string $text  Any single shortcode of any format or key/value pair string.
  * @return array|string List of attribute values.
  *                      Returns empty array if trim( $text ) == '""'.
@@ -499 +500 @@
     $atts    = array();
     $pattern = get_shortcode_atts_regex();
-    $text    = preg_replace( "/[\x{00a0}\x{200b}]+/u", ' ', $text );
+    $text    = trim( preg_replace( "/[\x{00a0}\x{200b}]+/u", ' ', $text ) );
+
+    // Remove everything but attributes from shortcode.
+    if ( preg_match( '#^\[[\w-]+([^\]]*?)\/?\]#', $text, $matches ) ) {
+        $text = $matches[1];
+    }
+
     if ( preg_match_all( $pattern, $text, $match, PREG_SET_ORDER ) ) {
         foreach ( $match as $m ) {
@@ -517 +524 @@
         }
 
-        // Reject any unclosed HTML elements
+        // Reject any unclosed HTML elements.
         foreach ( $atts as &$value ) {
             if ( false !== strpos( $value, '<' ) ) {
@@ -528 +535 @@
         $atts = ltrim( $text );
     }
+
     return $atts;
 }

trunk/tests/phpunit/tests/shortcode.php

@@ -973 +973 @@
         $this->assertEquals( 'test-shortcode-tag', $this->tagname );
     }
+
+    /**
+     * Testing the `shortcode_parse_atts()` function.
+     *
+     * @ticket 47863
+     *
+     * @covers ::shortcode_parse_atts
+     * @dataProvider data_shortcode_parse_atts
+     *
+     * @param string       $text     A single shortcode format or key/value pair string.
+     * @param string|array $expected Expected results.
+     */
+    public function test_shortcode_parse_atts( $text, $expected ) {
+        $actual = shortcode_parse_atts( $text );
+        $this->assertSame( $expected, $actual );
+    }
+
+    /**
+     * Data provider for `test_shortcode_parse_atts()`.
+     *
+     * @return array {
+     *     @type array {
+     *         @type string       $text     A single shortcode format or key/value pair string.
+     *         @type string|array $expected The expected result.
+     *     }
+     * }
+     */
+    public function data_shortcode_parse_atts() {
+
+        return array(
+            array(
+                '',
+                '',
+            ),
+            array(
+                '   ',
+                '',
+            ),
+            array(
+                '""',
+                array(),
+            ),
+            array(
+                '\'\'',
+                array(),
+            ),
+            array(
+                '[unittest]',
+                '',
+            ),
+            array(
+                '[unitest]Unit Test[/unittest]',
+                '',
+            ),
+            array(
+                '[unittest title="unittest" link="https://unit.test/"]',
+                array(
+                    'title' => 'unittest',
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unittest title="unittest" link="https://unit.test/"/]',
+                array(
+                    'title' => 'unittest',
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unit_test title="unittest" link="https://unit.test/"/]',
+                array(
+                    'title' => 'unittest',
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unit-test title="unittest" link="https://unit.test/"/]',
+                array(
+                    'title' => 'unittest',
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unittest link=https://unit.test/ /]',
+                array(
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unittest link=https://unit.test/ ]',
+                array(
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unittest link=https://unit.test/]',
+                array(
+                    'link'  => 'https://unit.test',
+                ),
+            ),
+            array(
+                '[unittest link https://unit.test/ /]',
+                array(
+                    'link',
+                    'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unittest title="unittest" link="https://unit.test/"]Unit Test[/unittest]',
+                array(
+                    'title' => 'unittest',
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                '[unittest title="unittest" link="https://unit.test/"][unit_test foo="bar" bar="foo"][/unittest]',
+                array(
+                    'title' => 'unittest',
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+            array(
+                'title="unittest" link="https://unit.test/"',
+                array(
+                    'title' => 'unittest',
+                    'link'  => 'https://unit.test/',
+                ),
+            ),
+        );
+
+    }
+
 }