Changeset 57597

Timestamp:

02/12/2024 04:06:47 PM (6 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.

Location:

trunk

Files:

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

trunk/src/wp-includes/media.php

@@ -2355 +2355 @@
  */
 function img_caption_shortcode( $attr, $content = '' ) {
-    if ( ! $attr ) {
-        $attr = array();
-    }
-
     // New-style shortcode with the caption inside the shortcode with the link and image tags.
     if ( ! isset( $attr['caption'] ) ) {

trunk/src/wp-includes/shortcodes.php

@@ -601 +601 @@
  *
  * @since 2.5.0
+
+
  *
  * @param string $text Shortcode arguments list.
- * @return array|string Array of attribute values keyed by attribute name.
- *                      Returns empty array if there are no attributes.
- *                      Returns the original arguments string if it cannot be parsed.
+ * @return array Array of attribute values keyed by attribute name.
+ *               
+ *                cannot be parsed.
  */
 function shortcode_parse_atts( $text ) {
@@ -636 +638 @@
             }
         }
-    } else {
-        $atts = ltrim( $text );
     }
 

trunk/tests/phpunit/tests/shortcode.php

@@ -106 +106 @@
     }
 
+
+
+
     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 @@
     }
 
+
+
+
     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 @@
     }
 
+
+
+
     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 );
     }
+
+
+
+
+
+
+
+
+
 }