Changeset 40673

Timestamp:

05/15/2017 10:35:41 PM (8 years ago)

Author:

westonruter

Message:

Widgets: Ensure return value of widget_text filter is not dropped but passed into widget_text_content filter for rendering.

Amends [40631].
Props vijustin, swissspidy, westonruter.
See #35243.
Fixes #40772.

Location:

trunk

Files:

• src/wp-includes/widgets/class-wp-widget-text.php (modified) (3 diffs)
• tests/phpunit/tests/widgets/text-widget.php (modified) (6 diffs)

trunk/src/wp-includes/widgets/class-wp-widget-text.php

@@ -68 +68 @@
         $title = apply_filters( 'widget_title', empty( $instance['title'] ) ? '' : $instance['title'], $instance, $this->id_base );
 
-        $widget_text = ! empty( $instance['text'] ) ? $instance['text'] : '';
+        $text = ! empty( $instance['text'] ) ? $instance['text'] : '';
 
         /**
@@ -76 +76 @@
          * @since 4.4.0 Added the `$this` parameter.
          *
-         * @param string         $widget_text The widget content.
-         * @param array          $instance    Array of settings for the current widget.
-         * @param WP_Widget_Text $this        Current Text widget instance.
+         * @param string         $text     The widget content.
+         * @param array          $instance Array of settings for the current widget.
+         * @param WP_Widget_Text $this     Current Text widget instance.
          */
-        $text = apply_filters( 'widget_text', $widget_text, $instance, $this );
+        $text = apply_filters( 'widget_text', $text, $instance, $this );
 
         if ( isset( $instance['filter'] ) ) {
@@ -92 +92 @@
                  * @since 4.8.0
                  *
-                 * @param string         $widget_text The widget content.
-                 * @param array          $instance    Array of settings for the current widget.
-                 * @param WP_Widget_Text $this        Current Text widget instance.
+                 * @param string         $text     The widget content.
+                 * @param array          $instance Array of settings for the current widget.
+                 * @param WP_Widget_Text $this     Current Text widget instance.
                  */
-                $text = apply_filters( 'widget_text_content', $widget_text, $instance, $this );
+                $text = apply_filters( 'widget_text_content', $text, $instance, $this );
 
             } elseif ( $instance['filter'] ) {

trunk/tests/phpunit/tests/widgets/text-widget.php

@@ -75 +75 @@
         );
 
-        add_filter( 'widget_text_content', array( $this, 'filter_widget_text_content' ), 10, 3 );
-        add_filter( 'widget_text', array( $this, 'filter_widget_text' ), 10, 3 );
+        add_filter( 'widget_text_content', array( $this, 'filter_widget_text_content' ), 5, 3 );
+        add_filter( 'widget_text', array( $this, 'filter_widget_text' ), 5, 3 );
 
         // Test with filter=false.
@@ -86 +86 @@
         $this->assertEmpty( $this->widget_text_content_args );
         $this->assertNotEmpty( $this->widget_text_args );
+        $this->assertContains( '[filter:widget_text]', $output );
+        $this->assertNotContains( '[filter:widget_text_content]', $output );
 
         // Test with filter=true.
@@ -99 +101 @@
         $this->assertEquals( $widget, $this->widget_text_args[2] );
         $this->assertEmpty( $this->widget_text_content_args );
+        $this->assertContains( '[filter:widget_text]', $output );
+        $this->assertNotContains( '[filter:widget_text_content]', $output );
 
         // Test with filter=content, the upgraded widget.
@@ -112 +116 @@
         $this->assertEquals( $widget, $this->widget_text_args[2] );
         $this->assertCount( 3, $this->widget_text_content_args );
-        $this->assertEquals( wpautop( $instance['text'] ), $this->widget_text_content_args[0] );
+        $this->assertEquals( $instance['text'] . '[filter:widget_text]', $this->widget_text_content_args[0] );
         $this->assertEquals( $instance, $this->widget_text_content_args[1] );
         $this->assertEquals( $widget, $this->widget_text_content_args[2] );
+        $this->assertContains( wpautop( $instance['text'] . '[filter:widget_text][filter:widget_text_content]' ), $output );
     }
 
@@ -128 +133 @@
         $this->widget_text_args = func_get_args();
 
+        $widget_text .= '[filter:widget_text]';
         return $widget_text;
     }
@@ -142 +148 @@
         $this->widget_text_content_args = func_get_args();
 
+        $widget_text .= '[filter:widget_text_content]';
         return $widget_text;
     }