Repository navigation
Widgets: Prevent dynamic_sidebar() name collision - #12166
SainathPoojary wants to merge 4 commits into
Conversation
|
Hi there! 👋 Thank you for your contribution to WordPress! 💖 It looks like this is your first pull request to No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description. Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making. More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook. Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook. If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook. The Developer Hub also documents the various coding standards that are followed:
Thank you, |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
There was a problem hiding this comment.
Pull request overview
This PR addresses a long-standing edge case in dynamic_sidebar() where a sidebar lookup by a sanitized name could incorrectly override a direct match on a registered sidebar ID (Trac #22116). The change ensures that if the sanitized $index matches an existing sidebar ID, that ID match is used without falling back to a name-based scan.
Changes:
- Update
dynamic_sidebar()to only resolve by sanitized sidebar name when there is no direct sidebar ID match. - Add a PHPUnit regression test covering the ID-vs-sanitized-name collision scenario (Trac #22116).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
src/wp-includes/widgets.php |
Prioritizes direct $wp_registered_sidebars[ $index ] ID match before falling back to sanitized-name resolution. |
tests/phpunit/tests/widgets.php |
Adds a regression test that reproduces the ID/name-collision and asserts correct ID precedence. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
t-hamano
left a comment
t-hamano
left a comment
There was a problem hiding this comment.
I support this PR because the approach of always prioritizing matching by ID makes sense.
However, this changes the behavior of a function that has remained the same for over 10 years, so I am concerned about the extent of its impact. For example, this PR could introduce new problems as edge cases.
register_sidebar( array( 'id' => 'widget-area-121', 'name' => 'Main Sidebar' ) );
register_sidebar( array( 'id' => 'footer', 'name' => 'Widget Area 121' ) );
// Intended to look up the sidebar by name.
dynamic_sidebar( 'Widget Area 121' );
// Before: 'footer' is displayed (as intended).
// After: 'widget-area-121' is displayed (not what was intended).
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 #12166. Follow-up to r5474. Props sainathpoojary, wildworks, alexvorn2, markoheijnen, dilip2615, mosescursor, im3dabasia1, SergeyBiryukov. Fixes #22116. git-svn-id: https://develop.svn.wordpress.org/trunk@64681 602fd350-edb4-49c9-b593-d223f7449a82
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 WordPress/wordpress-develop#12166. Follow-up to r5474. Props sainathpoojary, wildworks, alexvorn2, markoheijnen, dilip2615, mosescursor, im3dabasia1, SergeyBiryukov. Fixes #22116. Built from https://develop.svn.wordpress.org/trunk@64681 git-svn-id: http://core.svn.wordpress.org/trunk@63831 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Trac ticket: #22116
Use of AI Tools
AI assistance: Yes
Tool(s): GitHub Copilot
Model(s): Gemini, Claude
Used for: Checking for potential edge cases, drafting the PR description, and assisting with local code review. The final implementation and testing were written and executed manually by me.
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.