Ticket #40907: apply-widget_text-filter-in-custom-html-widget.2.diff

src/wp-includes/default-filters.php

@@ -170 +170 @@
 add_filter( 'widget_text_content', 'convert_smilies',  20 );
 add_filter( 'widget_text_content', 'wpautop'              );
 
-add_filter( 'widget_custom_html_content', 'balanceTags' );
-
 add_filter( 'date_i18n', 'wp_maybe_decline_date' );
 
 // RSS filters

src/wp-includes/widgets/class-wp-widget-custom-html.php

@@ -61 +61 @@
                 /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
                 $title = apply_filters( 'widget_title', $instance['title'], $instance, $this->id_base );
 
-                $content = $instance['content'];
+                /** This filter is documented in wp-includes/widgets/class-wp-widget-text.php */
+                $content = apply_filters( 'widget_text', $instance['content'], $instance, $this );
 
                 /**
                  * Filters the content of the Custom HTML widget.

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

@@ -213 +213 @@
                  *
                  * @since 2.3.0
                  * @since 4.4.0 Added the `$this` parameter.
+                 * @since 4.8.1 The `$this` param may now be a `WP_Widget_Custom_HTML` object in addition to a `WP_Widget_Text` object.
                  *
-                 * @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.
+                 * @param string                               $text     The widget content.
+                 * @param array                                $instance Array of settings for the current widget.
+                 * @param WP_Widget_Text|WP_Widget_Custom_HTML $this     Current Text widget instance.
                  */
                 $text = apply_filters( 'widget_text', $text, $instance, $this );
 

tests/phpunit/tests/widgets/custom-html-widget.php

@@ -21 +21 @@
         protected $widget_custom_html_content_args;
 
         /**
+         * Args passed to the widget_text filter.
+         *
+         * @var array
+         */
+        protected $widget_text_args;
+
+        /**
          * Test constructor.
          *
          * @covers WP_Widget_Custom_HTML::__constructor
@@ -52 +59 @@
                         'content' => $content,
                 );
 
-                $this->assertEquals( 10, has_filter( 'widget_custom_html_content', 'balanceTags' ) );
-
                 update_option( 'use_balanceTags', 0 );
                 add_filter( 'widget_custom_html_content', array( $this, 'filter_widget_custom_html_content' ), 5, 3 );
+                add_filter( 'widget_text', array( $this, 'filter_widget_text' ), 10, 3 );
                 ob_start();
                 $this->widget_custom_html_content_args = null;
                 $widget->widget( $args, $instance );
                 $output = ob_get_clean();
                 $this->assertNotEmpty( $this->widget_custom_html_content_args );
-                $this->assertContains( '[filter:widget_custom_html_content]', $output );
+                $this->assertContains( '[filter:widget_text][filter:widget_custom_html_content]', $output );
                 $this->assertNotContains( '<p>', $output );
                 $this->assertNotContains( '<br>', $output );
                 $this->assertNotContains( '</u>', $output );
+                $this->assertEquals( $instance, $this->widget_text_args[1] );
                 $this->assertEquals( $instance, $this->widget_custom_html_content_args[1] );
+                $this->assertSame( $widget, $this->widget_text_args[2] );
                 $this->assertSame( $widget, $this->widget_custom_html_content_args[2] );
                 remove_filter( 'widget_custom_html_content', array( $this, 'filter_widget_custom_html_content' ), 5, 3 );
+                remove_filter( 'widget_text', array( $this, 'filter_widget_text' ), 10 );
 
                 update_option( 'use_balanceTags', 1 );
                 ob_start();
@@ -77 +86 @@
         }
 
         /**
-         * Filters the content of the Custom HTML widget.
+         * Filters the content of the Custom HTML widget using the legacy widget_text filter.
+         *
+         * @param string                $text     The widget content.
+         * @param array                 $instance Array of settings for the current widget.
+         * @param WP_Widget_Custom_HTML $widget   Current widget instance.
+         * @return string Widget content.
+         */
+        function filter_widget_text( $text, $instance, $widget ) {
+                $this->widget_text_args = func_get_args();
+
+                $text .= '[filter:widget_text]';
+                return $text;
+        }
+
+        /**
+         * Filters the content of the Custom HTML widget using the dedicated widget_custom_html_content filter.
          *
          * @param string                $widget_content The widget content.
          * @param array                 $instance       Array of settings for the current widget.