Changeset 50961

Timestamp:

05/24/2021 09:50:30 AM (3 years ago)

Author:

SergeyBiryukov

Message:

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

This reverts the changes to id_base from [50953] due to backward compatibility concerns, and instead focuses on the id and class attributes specifically.

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

Follow-up to [50953].

Fixes #44098.

Location:

trunk

Files:

• src/wp-admin/includes/widgets.php (modified) (1 diff)
• src/wp-includes/class-wp-widget.php (modified) (2 diffs)
• src/wp-includes/widgets.php (modified) (1 diff)
• tests/phpunit/tests/widgets.php (modified) (3 diffs)

trunk/src/wp-admin/includes/widgets.php

@@ -163 +163 @@
 
     foreach ( $wp_registered_widgets as $widget_id => $widget ) {
-        if ( preg_match( '/' . $id_base . '-([0-9]+)$/', $widget_id, $matches ) ) {
+        if ( preg_match( '/' . preg_quote( $id_base, '/' ) . '-([0-9]+)$/', $widget_id, $matches ) ) {
             $number = max( $number, $matches[1] );
         }

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

@@ -165 +165 @@
         } else {
             $id_base = preg_replace( '/(wp_)?widget_/', '', strtolower( get_class( $this ) ) );
-            $id_base = str_replace( '\\', '-', $id_base );
         }
 
@@ -174 +173 @@
             $widget_options,
             array(
-                'classname'                   => $this->option_name,
+                'classname'                   => str_replace( '\\', '_', $this->option_name ),
                 'customize_selective_refresh' => false,
             )

trunk/src/wp-includes/widgets.php

@@ -754 +754 @@
             }
         }
-        $classname_                 = ltrim( $classname_, '_' );
-        $params[0]['before_widget'] = sprintf( $params[0]['before_widget'], $id, $classname_ );
+        $classname_ = ltrim( $classname_, '_' );
+
+        $params[0]['before_widget'] = sprintf(
+            $params[0]['before_widget'],
+            str_replace( '\\', '_', $id ),
+            $classname_
+        );
 
         /**

trunk/tests/phpunit/tests/widgets.php

@@ -429 +429 @@
      * @ticket 44098
      * @see WP_Widget::__construct()
-     * @dataProvider data_wp_widget_id_base
-     */
-    function test_wp_widget_id_base( $expected, $widget_class ) {
+     * @dataProvider data_wp_widget_classname
+     */
+    function test_wp_widget_classname( $expected, $widget_class ) {
         require_once DIR_TESTDATA . '/widgets/custom-widget-classes.php';
 
         $widget = new $widget_class( '', 'Foo' );
 
-        $this->assertSame( $expected, $widget->id_base );
+        $this->assertSame( $expected, $widget->widget_options['classname'] );
     }
 
@@ -442 +442 @@
      * Data provider.
      *
-     * Passes the expected `id_base` value and the class name.
+     * Passes the expected `classname` value and the PHP class name.
      *
      * @since 5.8.0
@@ -448 +448 @@
      * @return array {
      *     @type array {
-     *         @type string $expected     The expected `id_base` value to be returned.
+     *         @type string $expected     The expected `classname` value to be returned.
      *         @type string $widget_class The widget class name for creating an instance.
      *     }
      * }
      */
-    function data_wp_widget_id_base() {
+    function data_wp_widget_classname() {
         return array(
             array(
-                'search',
+                'widget_search',
                 'WP_Widget_Search',
             ),
             array(
-                'test-sub-sub-namespaced_widget',
+                'widget_test_sub_sub_namespaced_widget',
                 'Test\Sub\Sub\Namespaced_Widget',
             ),
             array(
-                'non_namespaced_widget',
+                'widget_non_namespaced_widget',
                 'Non_Namespaced_Widget',
             ),