Skip to content

Icons API: Add wp_get_icon() to render registered icons as inline SVG#12010

Open
t-hamano wants to merge 2 commits into
WordPress:trunkfrom
t-hamano:64847-wp-icon-function
Open

Icons API: Add wp_get_icon() to render registered icons as inline SVG#12010
t-hamano wants to merge 2 commits into
WordPress:trunkfrom
t-hamano:64847-wp-icon-function

Conversation

@t-hamano
Copy link
Copy Markdown
Contributor

@t-hamano t-hamano commented May 29, 2026

This PR adds wp_get_icon(), a procedural wrapper around WP_Icons_Registry that returns a registered icon as an inline SVG string.

Based on WordPress/gutenberg#78332.

Trac ticket: https://core.trac.wordpress.org/ticket/64847

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 4.8
Used for: Porting the function and PHPUnit tests from the referenced Gutenberg PR to core conventions. I reviewed and tested the result; all 9 tests pass.


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.

Introduce a procedural wrapper around `WP_Icons_Registry` so themes and
plugins can render any registered core icon as an inline SVG from PHP,
mirroring the React `<Icon>` component. This bridges the gap for PHP
contexts that otherwise depend on the deprecated dashicons font.

`wp_get_icon()` looks up the icon content via the registry and uses
`WP_HTML_Tag_Processor` to apply configurable `size` and `class`
attributes, plus accessibility handling: a `label` produces
`role="img"` and `aria-label`, while its absence marks the icon
`aria-hidden="true"`.

The function lives in a new `icons.php`, following the established
registry-class-plus-procedural-API pairing used by connectors.php and
abilities.php.

Props ...

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@t-hamano t-hamano marked this pull request as ready for review May 29, 2026 06:46
@github-actions
Copy link
Copy Markdown

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 wildworks.

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

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.

The test file only covers wp_get_icon(); the_wp_icon() does not exist.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.

1 participant