Changeset 57597 for trunk/tests/phpunit/tests/shortcode.php

Timestamp:

02/12/2024 04:06:47 PM (15 months ago)

Author:

swissspidy

Message:

Shortcodes: Always return an array in shortcode_parse_atts().

Previously, shortcode_parse_atts() would return the input (an empty string) if a shortcode had no attributes, even though the documentation said otherwise.

Always returning an (empty) array reduces confusion and improves developer experience as the return value does not have to be manually checked in the shortcode itself.

Props: nicolefurlan, swissspidy, johnbillion, bedas.
Fixes #59249.

File:

• trunk/tests/phpunit/tests/shortcode.php (modified) (4 diffs)

trunk/tests/phpunit/tests/shortcode.php

@@ -106 +106 @@
     }
 
+    /**
+     * @ticket 59249
+     */
     public function test_noatts() {
         do_shortcode( '[test-shortcode-tag /]' );
-        $this->assertSame( '', $this->atts );
+        $this->assertIsArray( $this->atts );
+        $this->assertEmpty( $this->atts );
         $this->assertSame( 'test-shortcode-tag', $this->tagname );
     }
@@ -182 +186 @@
     }
 
+    /**
+     * @ticket 59249
+     */
     public function test_noatts_enclosing() {
         do_shortcode( '[test-shortcode-tag]content[/test-shortcode-tag]' );
-        $this->assertSame( '', $this->atts );
+        $this->assertIsArray( $this->atts );
+        $this->assertEmpty( $this->atts );
         $this->assertSame( 'content', $this->content );
         $this->assertSame( 'test-shortcode-tag', $this->tagname );
@@ -209 +217 @@
     }
 
+    /**
+     * @ticket 59249
+     */
     public function test_unclosed() {
         $out = do_shortcode( '[test-shortcode-tag]' );
         $this->assertSame( '', $out );
-        $this->assertSame( '', $this->atts );
+        $this->assertIsArray( $this->atts );
+        $this->assertEmpty( $this->atts );
         $this->assertSame( 'test-shortcode-tag', $this->tagname );
     }
@@ -999 +1011 @@
         $this->assertSame( 'test-shortcode-tag', $this->tagname );
     }
+
+    /**
+     * @ticket 59249
+     */
+    public function test_shortcode_parse_atts_empty() {
+        $out = shortcode_parse_atts( '' );
+        $this->assertIsArray( $out, 'Return value is not an array' );
+        $this->assertEmpty( $out, 'Returned array is not empty' );
+    }
 }