Changeset 50953 for trunk/tests/phpunit/tests/widgets.php

Timestamp:

05/23/2021 08:50:44 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Widgets: Make sure WP_Widget constructor creates a correct id_base value for a namespaced widget class.

The id_base value is used for the widget's id and class attributes and also for the option name which stores the widget settings (unless the widget specifies a custom option_name value).

With this change, any backslashes in the id_base for a namespaced widget class are converted to hyphens, making it easier to style the output or target the widget with JavaScript.

This also avoids a preg_match(): Compilation failed PHP warning from next_widget_id_number() on the Widgets screen, previously caused by unescaped backslashes.

Props Mte90, hermpheus, rogerlos, welcher, SergeyBiryukov.
Fixes #44098.

File:

• trunk/tests/phpunit/tests/widgets.php (modified) (8 diffs)

trunk/tests/phpunit/tests/widgets.php

@@ -24 +24 @@
     function tearDown() {
         global $wp_customize;
+
         $wp_customize = null;
 
@@ -37 +38 @@
 
         $widget_class = 'WP_Widget_Search';
+
         register_widget( $widget_class );
         $this->assertArrayHasKey( $widget_class, $wp_widget_factory->widgets );
@@ -53 +55 @@
     function test_register_and_unregister_widget_instance() {
         global $wp_widget_factory, $wp_registered_widgets;
+
         $this->assertEmpty( $wp_widget_factory->widgets );
         $this->assertEmpty( $wp_registered_widgets );
@@ -128 +131 @@
      */
     function test_register_sidebars_single() {
-
         global $wp_registered_sidebars;
 
@@ -141 +143 @@
      */
     function test_register_sidebars_multiple() {
-
         global $wp_registered_sidebars;
 
@@ -200 +201 @@
      */
     function test_register_sidebar_with_string_id() {
-
         global $wp_registered_sidebars;
 
@@ -427 +427 @@
 
     /**
+     * @ticket 44098
+     * @see WP_Widget::__construct()
+     * @dataProvider data_wp_widget_id_base
+     */
+    function test_wp_widget_id_base( $expected, $widget_class ) {
+        require_once DIR_TESTDATA . '/widgets/custom-widget-classes.php';
+
+        $widget = new $widget_class( '', 'Foo' );
+
+        $this->assertSame( $expected, $widget->id_base );
+    }
+
+    /**
+     * Data provider.
+     *
+     * Passes the expected `id_base` value and the class name.
+     *
+     * @since 5.8.0
+     *
+     * @return array {
+     *     @type array {
+     *         @type string $expected     The expected `id_base` value to be returned.
+     *         @type string $widget_class The widget class name for creating an instance.
+     *     }
+     * }
+     */
+    function data_wp_widget_id_base() {
+        return array(
+            array(
+                'search',
+                'WP_Widget_Search',
+            ),
+            array(
+                'test-sub-sub-namespaced_widget',
+                'Test\Sub\Sub\Namespaced_Widget',
+            ),
+            array(
+                'non_namespaced_widget',
+                'Non_Namespaced_Widget',
+            ),
+        );
+    }
+
+    /**
      * @see WP_Widget::get_field_name()
      * @dataProvider data_wp_widget_get_field_name
@@ -451 +495 @@
      */
     function data_wp_widget_get_field_name() {
-
         return array(
             array(