Icons: Enforce strict name validation in register method

[im3dabasia]

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

Use of AI Tools

Copilot

Caution

Commit this PR after the wp/7.0 release branch has been created. This PR targets the 7.1 release.

[github-actions]

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.

[t-hamano]

Thanks for the PR! I think there are roughly two areas for improvement.

public function test() {
	$result = $this->register( 'invalid-name', array() );
	$this->assertFalse( $result );
}

This test appears correct at first glance, but note that the second argument is an empty array. If the second argument is empty, it will cause an error here. In other words, this test does not guarantee whether the error is caused by an invalid icon name.

Another suggestion is to use a data provider, which reduces the amount of code and allows us to cover more cases. For example:

public function test_invalid_icon_names( $icon_name ) {
	$settings = array(
		'label'   => 'Icon',
		'content' => '<svg></svg>',
	);

	$result = $this->register( $icon_name, $settings );
	$this->assertFalse( $result );
}

public function data_invalid_icon_names() {
	return array(
		'non-string name'      => array( 1 ),
		'no namespace'         => array( 'plus' ),
		'uppercase characters' => array( 'Core/Plus' ),
		'invalid characters'   => array( 'test/_doing_it_wrong' ),
	);
}

[im3dabasia]

Thanks for the continuous iterations on this PR. I have addressed the feedbacks in this commit bf30902

[github-actions]

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 im3dabasia1, wildworks, mukesh27.

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

[t-hamano]

LGTM!

Additionally, it would be great if you made the same changes to WordPress/gutenberg#76079.

[t-hamano]

@im3dabasia Since WordPress/gutenberg#76079 has now been merged, can you update this PR accordingly?

[t-hamano]

@im3dabasia Thanks for the update! As we are currently in the phase of preparing for the 7.0 release, let's commit this PR after the 7.0 release.

[mukeshpanchal27]

Add @ticket for new unit tests

[t-hamano]

Fixed in 93074fb

[mukeshpanchal27]

This it not correctly use of dataProvider. Make sure to correct it before commit.

[t-hamano]

Fixed in 3c40799

[t-hamano]

Trunk is now WordPress 7.1-alpha, so we can move this PR forward.

@im3dabasia, can you address @mukeshpanchal27's review and update this PR?