Icons: Enforce strict name validation in `register` method by im3dabasia · Pull Request #76079 · WordPress/gutenberg

im3dabasia · 2026-03-03T11:39:52Z

What?

Improves validation in WP_Icons_Registry::register and adds comprehensive unit tests for icon registration, including duplicate and invalid name handling.

Why?

This PR ensures icon names are strictly validated (must be strings, namespace-prefixed, and lowercase), mirroring the approach used in WP_Block_Type_Registry. It also adds tests to verify that invalid names and duplicate registrations are correctly rejected, improving reliability and consistency.

How?

Refactored register() to enforce:
- Only string names are accepted.
- Names must be namespace-prefixed (plugin/icon).
- No uppercase characters allowed.
- Duplicate registrations are rejected.
Added PHPUnit tests for:
- Non-string names
- Names without namespace
- Names with uppercase characters
- Duplicate registration (ensures count does not increase)
- Valid registration

github-actions · 2026-03-03T11:40:27Z

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.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: im3dabasia <im3dabasia1@git.wordpress.org>
Co-authored-by: mcsf <mcsf@git.wordpress.org>
Co-authored-by: t-hamano <wildworks@git.wordpress.org>

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

im3dabasia

Hey @mcsf ,

I picked up one of the follow-up related issue from here: #72215 (comment). When you have a chance, I’d love to hear your thoughts on this PR.

im3dabasia · 2026-03-03T11:41:56Z

phpunit/experimental/class-gutenberg-icons-registry-7-1-test.php

I am not sure if this is the best filename. Please guide me in naming this correctly; I will update it.

This looks fine, thanks. :)

im3dabasia · 2026-03-03T11:44:58Z

phpunit/experimental/wpIconsRegistry.php

+ *
+ * @group icons
+ */
+class Tests_Icons_WpIconsRegistry extends WP_UnitTestCase {


Similarly, I think the class name is not the correct one here.

I think we should use Gutenberg_Icons_Registry_7_1 instead.

phpunit/experimental/class-gutenberg-icons-registry-7-1-test.php

t-hamano

Thanks for the PR!

We're currently working on some structural changes to further develop the icon registry on the Gutenberg plugin, so it might be worth coming back to this PR once that's complete.

t-hamano

Hi @im3dabasia, since #75878 has been merged, can you update this PR accordingly? We should update lib/compat/wordpress-7.1/class-gutenberg-icons-registry-7-1.php instead.

We also need to submit a core PR. See this core ticket: https://core.trac.wordpress.org/ticket/64847

If there's anything you don't understand, please feel free to ask 👍

t-hamano · 2026-03-12T07:02:49Z

phpunit/experimental/wpIconsRegistry.php

+ *
+ * @group icons
+ */
+class Tests_Icons_WpIconsRegistry extends WP_UnitTestCase {


I think we should use Gutenberg_Icons_Registry_7_1 instead.

lib/compat/wordpress-7.0/class-wp-icons-registry.php

…_name

im3dabasia · 2026-03-13T08:30:51Z

@t-hamano, I have updated the PR based on the feedback and also learned quite a bit from this PR (#75550), which is in a similar position to mine. I would appreciate your feedback on this PR whenever you have a moment.

t-hamano

Thanks for the update!

We also need to submit a core PR. See this core ticket: https://core.trac.wordpress.org/ticket/64847

Can you confirm this point? Specifically, the following steps are required:

Create a core PR that is the same as this PR. Link the pull request you created to https://core.trac.wordpress.org/ticket/64847.
Create a backport changelog (ref)

im3dabasia · 2026-03-13T11:35:41Z

Create a core PR that is the same as this PR. Link the pull request you created to PR

I added the exact same test cases in Core under a more suitable file name: wpIconsRegistry.php. I also changed the class name to match what Core uses and used WP_Icons_Registry in set_up() instead of what this PR uses.

I chose to keep the tests in a separate file because they are not related to the REST API. The other file in that directory contains tests related to the REST API, whereas my tests directly test the functions without using the API. I believe having a separate file for this should not be an issue, but please let me know what you think.

I would appreciate some quick feedback on my PR (the Trac one). This is my first time doing this, and I really appreciate your constant guidance. Thanks!

Create a backport changelog (ref)

I did this in the following commit: 6b9cd32

`core/plus` is a real icon, so use the `test/` namespace instead.

mcsf

Thanks for your contribution, @im3dabasia!

I pushed some commits directly to your fork. Have a look: it was all related to the test suite.

I also spot some small issues with the registration checks themselves. Once you've addressed those and once CI clears, we should be good to merge.

mcsf · 2026-03-24T18:28:17Z

phpunit/experimental/class-gutenberg-icons-registry-7-1-test.php

This looks fine, thanks. :)

mcsf · 2026-03-24T18:36:38Z

lib/compat/wordpress-7.1/class-gutenberg-icons-registry-7-1.php

+			return false;
+		}
+
+		$name_matcher = '/^[a-z0-9-]+\/[a-z0-9-]+$/';


It's best to use the same pattern found in the REST controller, not just for consistency but because it's stricter:

gutenberg/lib/compat/wordpress-7.1/class-gutenberg-rest-icons-controller-7-1.php

Line 25 in 4eeb1d5

'/' . $this->rest_base . '/(?P<name>[a-z][a-z0-9-]*/[a-z][a-z0-9-]*)',

mcsf · 2026-03-24T18:37:00Z

lib/compat/wordpress-7.1/class-gutenberg-icons-registry-7-1.php

+			return false;
+		}
+
+		if ( preg_match( '/[A-Z]+/', $icon_name ) ) {


Nit: the + is unnecessary.

Suggested change

if ( preg_match( '/[A-Z]+/', $icon_name ) ) {

if ( preg_match( '/[A-Z]/', $icon_name ) ) {

im3dabasia requested a review from spacedmonkey as a code owner March 3, 2026 11:39

im3dabasia added the [Package] Icons /packages/icons label Mar 3, 2026

github-actions bot removed the [Package] Icons /packages/icons label Mar 3, 2026

im3dabasia commented Mar 3, 2026

View reviewed changes

im3dabasia added [Package] Icons /packages/icons [Type] Experimental Experimental feature or API. labels Mar 3, 2026

github-actions bot removed the [Package] Icons /packages/icons label Mar 3, 2026

im3dabasia requested review from mcsf and t-hamano March 3, 2026 12:05

t-hamano mentioned this pull request Mar 3, 2026

Icons API: Support searching in labels; extend classes post-7.0 work #75878

Merged

t-hamano reviewed Mar 3, 2026

View reviewed changes

t-hamano added [Type] Enhancement A suggestion for improvement. [Feature] Icon Related to Icon registration API and Icon REST API and removed [Type] Experimental Experimental feature or API. labels Mar 3, 2026

t-hamano mentioned this pull request Mar 12, 2026

SVG Icon API: Iteration for WordPress 7.1 #75715

Open

18 tasks

t-hamano reviewed Mar 12, 2026

View reviewed changes

im3dabasia added 5 commits March 12, 2026 19:04

feat: Updated registry method with rigid checks

5e9eca6

fix: Updated test_register_icon_twice test

7693957

fix: PHP lint errors fix

5c559bd

chore: Move register regex checks to 7.1 and renamed tests class/file…

9bedf37

…_name

chore: Added register function in wp-7.1/

6f1de67

im3dabasia force-pushed the fix/followup-72215 branch from c091bf3 to 6f1de67 Compare March 12, 2026 13:38

chore: Update tests

398b9d0

im3dabasia requested a review from t-hamano March 13, 2026 08:28

t-hamano reviewed Mar 13, 2026

View reviewed changes

im3dabasia changed the title ~~Icons Registry: Enforce strict name validation in register method~~ Icons: Enforce strict name validation in register method Mar 13, 2026

docs: Add changelog for backport

6b9cd32

t-hamano mentioned this pull request Mar 17, 2026

Icons: Enforce strict name validation in register method WordPress/wordpress-develop#11245

Open

im3dabasia and others added 6 commits March 19, 2026 13:02

chore: Feedbacks addressed as per upstream suggestions

ef7d67c

Remove broken code and comment use of PHP_VERSION_ID

8d42b86

Fix test case to avoid name collisions

f455376

`core/plus` is a real icon, so use the `test/` namespace instead.

Actually test the cases in data_invalid_icon_names

23ca8a2

Fix comments

a7c0f37

Remove test in favour of test_register_invalid_name

ac6fe80

mcsf reviewed Mar 24, 2026

View reviewed changes

	if ( preg_match( '/[A-Z]+/', $icon_name ) ) {
	if ( preg_match( '/[A-Z]/', $icon_name ) ) {

Conversation

im3dabasia commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Uh oh!

github-actions bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

im3dabasia left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

t-hamano left a comment

Choose a reason for hiding this comment

Uh oh!

t-hamano left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

im3dabasia commented Mar 13, 2026

Uh oh!

t-hamano left a comment

Choose a reason for hiding this comment

Uh oh!

im3dabasia commented Mar 13, 2026

Uh oh!

mcsf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

im3dabasia commented Mar 3, 2026 •

edited

Loading

github-actions bot commented Mar 3, 2026 •

edited

Loading