Changeset 64681

Timestamp:

10/22/2026 08:29:24 PM (4 hours ago)

Author:

SergeyBiryukov

Message:

Widgets: Avoid sidebar name collision in dynamic_sidebar().

This ensures that dynamic_sidebar() displays the correct sidebar when it has the same ID as the sanitized name of another sidebar registered earlier.

An exact sidebar ID match is now prioritized over a sanitized name match, which may be less accurate.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12166.

Follow-up to r5474.

Props sainathpoojary, wildworks, alexvorn2, markoheijnen, dilip2615, mosescursor, im3dabasia1, SergeyBiryukov.
Fixes #22116.

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

@@ -703 +703 @@
         } else {
                 $index = sanitize_title( $index );
-                foreach ( (array) $wp_registered_sidebars as $key => $value ) {
-                        if ( sanitize_title( $value['name'] ) === $index ) {
-                                $index = $key;
-                                break;
+
+                if ( empty( $wp_registered_sidebars[ $index ] ) ) {
+                        foreach ( (array) $wp_registered_sidebars as $key => $value ) {
+                                if ( sanitize_title( $value['name'] ) === $index ) {
+                                        $index = $key;
+                                        break;
+                                }
                         }
                 }

trunk/tests/phpunit/tests/widgets.php

@@ -407 +407 @@
 
                 $this->assertSame( $sidebar_id, $this->sidebar_index );
+        }
+
+        /**
+         * @group sidebar
+         * @ticket 22116
+         */
+        public function test_dynamic_sidebar_id_takes_priority_over_sanitized_name() {
+                // Register a sidebar with the name 'Widget Area 121' (sanitizes to 'widget-area-121').
+                register_sidebar(
+                        array(
+                                'id'   => 'widget-area-127',
+                                'name' => 'Widget Area 121',
+                        )
+                );
+
+                /*
+                 * Register a second sidebar whose ID is 'widget-area-121' —
+                 * the same as the sanitized name of the first sidebar.
+                 */
+                register_sidebar(
+                        array(
+                                'id'   => 'widget-area-121',
+                                'name' => 'Widget Area 121',
+                        )
+                );
+
+                add_action( 'dynamic_sidebar_before', array( $this, 'retrieve_sidebar_id' ), 10, 2 );
+
+                /*
+                 * Passing 'widget-area-121' as an exact ID should resolve to that sidebar directly,
+                 * not to 'widget-area-127' whose sanitized name also equals 'widget-area-121'.
+                 */
+                dynamic_sidebar( 'widget-area-121' );
+
+                $this->assertSame( 'widget-area-121', $this->sidebar_index );
         }