Skip to content

Icons: Allow registering icons that are hidden from the REST API with public property - #13453

Draft
fushar wants to merge 1 commit into
WordPress:trunkfrom
fushar:icons-public-false
Draft

Icons: Allow registering icons that are hidden from the REST API with public property#13453
fushar wants to merge 1 commit into
WordPress:trunkfrom
fushar:icons-public-false

Conversation

@fushar

@fushar fushar commented Sep 9, 2026

Copy link
Copy Markdown

Backport from WordPress/gutenberg#82634

What

This PR adds an optional boolean public property to icon registration. Icons registered with public: false will still be available through wp_get_icon(), but the icons REST API hides them, so they aren't exposed in the Icon block.

As a back-compatibility, if we don't provide a public property, the default is true and the behavior will be the same as the existing behavior.

Here's a summary of the behavior:

Registered with Registry /wp_get_icon() REST API / Icon block
public omitted or true yes yes
'public: false yes no

Why

WIP

Changes

WIP

Testing instructions

WIP

npm run test:php -- --group icons

⚠️ Draft until a Trac ticket exists. The new tests carry @ticket TODO placeholders that need to be replaced with the real number.

@fushar
fushar force-pushed the icons-public-false branch from 9618327 to 69d9e07 Compare September 9, 2026 13:22
@fushar fushar changed the title WIP PR Icons: Add a non-public state to the icon public property Sep 9, 2026
@github-actions

github-actions Bot commented Sep 9, 2026

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.

Icons can now be registered with `'public' => false`, which keeps them in the
registry and reachable from server-side code via `wp_get_icon()`, while hiding
them from the icons REST API and therefore from the editor's icon picker.

This mirrors the tri-state `public` property in the Gutenberg icons manifest:

- omitted: the icon stays in the JS library and is not shipped to core
- `true`:  shipped to core and exposed through the REST API
- `false`: shipped to core and registered, but not exposed through the REST API

`WP_Icons_Registry::register()` accepts and validates the new property,
`_wp_register_default_icons()` forwards it when the core manifest carries it,
and `WP_REST_Icons_Controller` omits non-public icons from `get_items()` and
reports them as not found from `get_icon()`.

Without this, a synced `icon-library-manifest.php` carrying `'public' => false`
would fail to register the flagged icons at all, since the registry rejects a
registration containing any unknown property.
@fushar
fushar force-pushed the icons-public-false branch from 69d9e07 to c092f31 Compare September 9, 2026 14:10
@fushar fushar changed the title Icons: Add a non-public state to the icon public property Icons: Allow registering icons that are hidden from the REST API Sep 10, 2026
@fushar fushar changed the title Icons: Allow registering icons that are hidden from the REST API Icons: Allow registering icons that are hidden from the REST API with public property Sep 10, 2026
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