Changeset 45798

Timestamp:

08/14/2019 11:02:25 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Widgets: Allow for short-circuiting widget output in the_widget() using the widget_display_callback filter, for consistency with output via a registered sidebar.

Props MarcGuay, donmhico.
Fixes #34226.

Location:

trunk

Files:

• src/wp-includes/widgets.php (modified) (1 diff)
• tests/phpunit/tests/widgets.php (modified) (1 diff)

trunk/src/wp-includes/widgets.php

@@ -1126 +1126 @@
         $instance = wp_parse_args( $instance );
 
+        /** This filter is documented in wp-includes/class-wp-widget.php */
+        $instance = apply_filters( 'widget_display_callback', $instance, $widget_obj, $args );
+
+        if ( false === $instance ) {
+                return;
+        }
+
         /**
          * Fires before rendering the requested widget.

trunk/tests/phpunit/tests/widgets.php

@@ -714 +714 @@
 
         /**
+         * @ticket 34226
+         */
+        public function test_the_widget_should_short_circuit_with_widget_display_callback() {
+                add_filter( 'widget_display_callback', '__return_false' );
+
+                register_widget( 'WP_Widget_Text' );
+
+                ob_start();
+                the_widget( 'WP_Widget_Text' );
+                $widget_content = ob_get_clean();
+                unregister_widget( 'WP_Widget_Text' );
+
+                $this->assertEmpty( $widget_content );
+        }
+
+        /**
          * Register nav menu sidebars.
          *