Changeset 41327

Timestamp:

09/01/2017 08:49:50 AM (7 years ago)

Author:

obenland

Message:

Widgets: Add nudge for registered widgets

Informs developers that widgets need to be registered before they can be
displayed through the_widget(). Previously it would fail with an ambiguous
undefined index notice.

Props SeBsZ, mrasharirfan.
Fixes #41743.

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

@@ -1037 +1037 @@
     global $wp_widget_factory;
 
+    if ( ! isset( $wp_widget_factory->widgets[ $widget ] ) ) {
+        _doing_it_wrong( __FUNCTION__, __( 'Widgets need to be registered before they can be displayed.' ), '4.9.0' );
+        return;
+    }
+
     $widget_obj = $wp_widget_factory->widgets[$widget];
     if ( ! ( $widget_obj instanceof WP_Widget ) ) {

trunk/tests/phpunit/tests/widgets.php

@@ -680 +680 @@
 
     /**
+     * Tests that no 'Undefined index' exception is thrown when trying to
+     * display an unregistered widget.
+     *
+     * @see \the_widget()
+     */
+    function test_the_widget_with_unregistered_widget() {
+        $this->setExpectedIncorrectUsage( 'the_widget' );
+        the_widget( 'Widget_Class' );
+    }
+
+    /**
      * Register nav menu sidebars.
      *