Changeset 51816

Timestamp:

09/15/2021 07:05:20 PM (21 months ago)

Author:

hellofromTonya

Message:

Media: Fix $content parameter default value in img_caption_shortcode().

The shortcode content is expected to be a string, not null. do_shortcode() expects a string for $content.

The img_caption_shortcode() also expects a string for the $content parameter and is expected to return a string for the HTML content to display the caption.

Prior to this commit:
The default value for the $content parameter was set to null. If no $content was passed, the function:

• could return null when the $atts['width'] < 1 or there was no caption
• else, it invoked do_shortcode( $content ) passing null which on PHP 8.1+ triggers a deprecation notice:

  strpos(): Passing null to parameter #1 ($haystack) of type string is deprecated
  

This commit:

• Fixes the default $content value to align to the expected shortcode content of string, not null.
• Fixes the PHP 8.1 deprecation notice when null was being passed to do_shortcode().
• Changes the assertion in a couple of tests to check for the empty string instead of `null.

Follow-up to [8196], [8925], [8239], [26915], [31530], [42704].

Props jrf, hellofromTonya, azaozz, joedolson.
See #53635.

Location:

trunk

Files:

• src/wp-includes/media.php (modified) (2 diffs)
• tests/phpunit/tests/media.php (modified) (2 diffs)

trunk/src/wp-includes/media.php

@@ -2086 +2086 @@
  * @since 3.9.0 The `class` attribute was added.
  * @since 5.1.0 The `caption_id` attribute was added.
+ * @since 5.9.0 The `$content` parameter default value changed from `null` to `''`.
  *
  * @param array  $attr {
@@ -2098 +2099 @@
  *     @type string $class      Additional class name(s) added to the caption container.
  * }
- * @param string $content Shortcode content.
+ * @param string $content Optional. Shortcode content. Default empty string.
  * @return string HTML content to display the caption.
  */
-function img_caption_shortcode( $attr, $content = null ) {
+function img_caption_shortcode( $attr, $content = '' ) {
     // New-style shortcode with the caption inside the shortcode with the link and image tags.
     if ( ! isset( $attr['caption'] ) ) {

trunk/tests/phpunit/tests/media.php

@@ -85 +85 @@
     function test_img_caption_shortcode_with_empty_params() {
         $result = img_caption_shortcode( array() );
-        $this->assertNull( $result );
+        $this->assertSame( '', $result );
     }
 
@@ -135 +135 @@
             )
         );
-        $this->assertNull( $result );
+        $this->assertSame( '', $result );
     }