fix: ensure that figure and figcaption elements have unique IDs#11940
fix: ensure that figure and figcaption elements have unique IDs#11940SteelWagstaff wants to merge 14 commits into
Conversation
|
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. |
|
Hi @SteelWagstaff! 👋 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. |
* trunk: Blocks: Include the offending block name in registration error notices.
The assertions expected a "-[0-9a-f]{2}" suffix, but wp_unique_id()
returns the prefix directly concatenated with a decimal counter (e.g.
"myId1"), so the regexes never matched and the tests failed.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…test Replace the brittle regex extraction in the per-instance uniqueness test with a WP_HTML_Tag_Processor helper that locates the caption wrapper and caption text elements by their class names, which is robust to both the HTML5 (figure/figcaption) and legacy (div/p) caption markup. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
When reviewing this, Claude pointed out something useful:
It seems we should only add the unique suffix for when the ID is truly going to be a duplicate. This will preserve existing CSS which may be targeting an element by a given ID. This would preserve back-compat while also fixing the accessibility issue. |
Co-authored-by: Weston Ruter <westonruter@gmail.com>
Add increment count for reused IDs to ensure they are unique and avoid breaking previously implemented selectors. Co-authored-by: Weston Ruter <westonruter@gmail.com>
|
Looks like the unit tests need to be updated now. |
Ensure that figure and figcaption elements have unique IDs when inserted into a page.
Problem:
and elements receive duplicate HTML IDs. This violates HTML validity requirements (IDs must be unique) and breaks accessibility features like aria-describedby that depend on ID referencesWhen the same image is inserted multiple times on a page, the
Trac ticket: https://core.trac.wordpress.org/ticket/65315#ticket
Demonstration of HTML changes
Before PR (notice duplicate figure ID and figcaption ID attributes for all three images:

After PR (notice unique figure ID and figcaption ID attributes for each image occurence.

Use of AI Tools
AI assistance: Yes
Tool(s): GitHub Copilot Pro (integrated in IDE), Skills provided by obra/superpowers
Model(s): Claude Haiku 4.5
Used for: Writing tests; code changes and comments written by me.