Changeset 42030

Timestamp:

10/27/2017 05:04:04 AM (9 years ago)

Author:

westonruter

Message:

Widgets: Prevent showing underlying attachment excerpt as caption when empty caption value is supplied in Image widget.

Allow underlying attachment to display if caption is null.

Props miyauchi, westonruter.
See #39993.
Fixes #42350.

Location:

trunk

Files:

• src/wp-includes/widgets/class-wp-widget-media-image.php (modified) (1 diff)
• tests/phpunit/tests/widgets/media-image-widget.php (modified) (3 diffs)

trunk/src/wp-includes/widgets/class-wp-widget-media-image.php

@@ -178 +178 @@
                 }
                 if ( $attachment ) {
-                        $caption = $attachment->post_excerpt;
-                        if ( $instance['caption'] ) {
+                        $caption = '';
+                        if ( ! isset( $instance['caption'] ) ) {
+                                $caption = $attachment->post_excerpt;
+                        } elseif ( trim( $instance['caption'] ) ) {
                                 $caption = $instance['caption'];
                         }

trunk/tests/phpunit/tests/widgets/media-image-widget.php

@@ -426 +426 @@
                 $this->assertContains( 'target="_blank"', $output );
 
-                // Caption settings.
+                // Populate caption in attachment.
                 wp_update_post( array(
                         'ID' => $attachment_id,
@@ -432 +432 @@
                 ) );
 
-                ob_start();
-                $widget->render_media( array(
-                        'attachment_id' => $attachment_id,
-                ) );
-                $output = ob_get_clean();
-
+                // If no caption is supplied, then the default is '', and so the caption will not be displayed.
+                ob_start();
+                $widget->render_media( array(
+                        'attachment_id' => $attachment_id,
+                ) );
+                $output = ob_get_clean();
+                $this->assertNotContains( 'wp-caption', $output );
+                $this->assertNotContains( '<p class="wp-caption-text">', $output );
+
+                // If the caption is explicitly null, then the caption of the underlying attachment will be displayed.
+                ob_start();
+                $widget->render_media( array(
+                        'attachment_id' => $attachment_id,
+                        'caption' => null,
+                ) );
+                $output = ob_get_clean();
                 $this->assertContains( 'class="wp-caption alignnone"', $output );
                 $this->assertContains( '<p class="wp-caption-text">Default caption</p>', $output );
 
+                // If caption is provided, then it will be displayed.
                 ob_start();
                 $widget->render_media( array(
@@ -447 +458 @@
                 ) );
                 $output = ob_get_clean();
-
                 $this->assertContains( 'class="wp-caption alignnone"', $output );
                 $this->assertContains( '<p class="wp-caption-text">Custom caption</p>', $output );