Skip to content

fix: ensure that figure and figcaption elements have unique IDs#11940

Open
SteelWagstaff wants to merge 14 commits into
WordPress:trunkfrom
SteelWagstaff:fix/avoid-duplicate-ids-media-caption
Open

fix: ensure that figure and figcaption elements have unique IDs#11940
SteelWagstaff wants to merge 14 commits into
WordPress:trunkfrom
SteelWagstaff:fix/avoid-duplicate-ids-media-caption

Conversation

@SteelWagstaff
Copy link
Copy Markdown

@SteelWagstaff SteelWagstaff commented May 22, 2026

Ensure that figure and figcaption elements have unique IDs when inserted into a page.

Problem:
When the same image is inserted multiple times on a page, the

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 references

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:
Screenshot_2026-05-22_02-13-28

After PR (notice unique figure ID and figcaption ID attributes for each image occurence.
Screenshot_2026-05-22_02-09-01

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.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 22, 2026

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 props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props steelwagstaff, westonruter, mukesh27.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link
Copy Markdown

Hi @SteelWagstaff! 👋

Thank you for your contribution to WordPress! 💖

It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

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,
The WordPress Project

@github-actions
Copy link
Copy Markdown

Test using WordPress Playground

The 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

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Comment thread src/wp-includes/media.php Outdated
Comment thread src/wp-includes/media.php
Comment thread src/wp-includes/media.php Outdated
Comment thread src/wp-includes/media.php Outdated
Comment thread src/wp-includes/media.php Outdated
Comment thread src/wp-includes/media.php Outdated
SteelWagstaff and others added 8 commits June 2, 2026 18:13
* 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>
@westonruter
Copy link
Copy Markdown
Member

When reviewing this, Claude pointed out something useful:

A thought on stability of the id for the single-caption case (non-blocking)

Just want to flag something for consideration — not a blocker, and the approach here makes sense for the problem it's solving.

In src/wp-includes/media.php:

if ( $atts['id'] ) {
    $unique_id_value = wp_unique_id( sanitize_html_class( $atts['id'] ) );
    $id              = 'id="' . esc_attr( $unique_id_value ) . '" ';
}

Since this runs every caption's id through wp_unique_id(), the suffix gets appended unconditionally — including the very common case of a single [caption id="attachment_123"] on a page, where the id was already unique. So the output shifts from:

<figure id="attachment_123">

to something like:

<figure id="attachment_1231">

…with the suffix depending on how many times wp_unique_id() was called earlier in the request.

The reason I mention it: the id is no longer the author-supplied value, so anything that referenced it by its literal id could be affected — e.g. in-content anchors (#attachment_123), theme/plugin CSS (#attachment_123 { … }), or JS (getElementById). Probably an edge case in practice, but worth being aware of since the id had historically been stable.

To be clear, this isn't an accessibility regression — the aria-describedby ↔ figcaption id linkage stays internally consistent (both come from the same $caption_id_value), so the association still resolves correctly.

If preserving backward compatibility for the common path feels worthwhile, one option would be to only disambiguate on an actual collision (suffix the 2nd+ occurrence, leave the first as-is). That's more logic than the current approach, though, and may not be worth it depending on how often duplicate captions actually occur — happy to defer to your judgment here.

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.

Comment thread src/wp-includes/media.php Outdated
Comment thread src/wp-includes/media.php Outdated
SteelWagstaff and others added 2 commits June 3, 2026 09:11
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>
@westonruter
Copy link
Copy Markdown
Member

Looks like the unit tests need to be updated now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants