Icons: Reject icon names ending in a hyphen or underscore.

The name validation in `WP_Icons_Registry::register()` allowed unqualified icon names to end with a hyphen or an underscore, while the REST API route for icons did not, so an icon could be registered under a name that was unreachable through the REST API.

Tighten the regular expression so that an unqualified icon name must both start and end with a lowercase letter or digit.

Developed in: WordPress#12624

Follow-up to [62748].

Props mukesh27, tyxla, wildworks.
See #64847.


git-svn-id: https://develop.svn.wordpress.org/trunk@62821 602fd350-edb4-49c9-b593-d223f7449a82

Author: t-hamano

src/wp-includes/class-wp-icons-registry.php

@@ -92,10 +92,10 @@ public function register( $icon_name, $icon_properties ) {
 			return false;
 		}
 
-		if ( ! preg_match( '/^[a-z0-9][a-z0-9_-]*$/', $unqualified_name ) ) {
+		if ( ! preg_match( '/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?$/', $unqualified_name ) ) {
 			_doing_it_wrong(
 				__METHOD__,
-				__( 'Icon names must start with a lowercase letter or digit and contain only lowercase letters, digits, hyphens, and underscores.' ),
+				__( 'Icon names must start and end with a lowercase letter or digit and contain only lowercase letters, digits, hyphens, and underscores.' ),
 				'7.1.0'
 			);
 			return false;

tests/phpunit/tests/icons/wpIconsRegistry.php

@@ -75,20 +75,22 @@ private function create_temp_icon_file( $contents, $extension = 'svg' ) {
 	}
 
 	/**
-	 * Provides valid namespaced icon names, including names that contain or
-	 * start with digits, as well as underscores.
+	 * Provides valid namespaced icon names, including names that contain,
+	 * start or end with digits, as well as underscores and hyphens.
 	 *
 	 * @return array<string, array{0: string}>
 	 */
 	public function data_valid_icon_names() {
 		return array(
-			'simple name'            => array( 'test-collection/my-icon' ),
-			'digit at the start'     => array( 'test-collection/1-icon' ),
-			'digit in the name'      => array( 'test-collection/my-1-icon' ),
-			'digit at the end'       => array( 'test-collection/icon1' ),
-			'underscore in the name' => array( 'test-collection/my_icon' ),
-			'underscore at the end'  => array( 'test-collection/my-icon_' ),
-			'hyphen at the end'      => array( 'test-collection/my-icon-' ),
+			'single character'                => array( 'test-collection/a' ),
+			'simple name'                     => array( 'test-collection/icon' ),
+			'digit at the start'              => array( 'test-collection/1icon' ),
+			'digit in the name'               => array( 'test-collection/my1icon' ),
+			'digit at the end'                => array( 'test-collection/icon1' ),
+			'underscore in the name'          => array( 'test-collection/my_icon' ),
+			'hyphen in the name'              => array( 'test-collection/my-icon' ),
+			'digit adjacent to a hyphen'      => array( 'test-collection/my-1-icon' ),
+			'digit adjacent to an underscore' => array( 'test-collection/my_1_icon' ),
 		);
 	}
 
@@ -125,7 +127,9 @@ public function data_invalid_icon_names() {
 			'uppercase in the name'   => array( 'test-collection/my-Icon' ),
 			'uppercase at the end'    => array( 'test-collection/my-iconX' ),
 			'underscore at the start' => array( 'test-collection/_my-icon' ),
+			'underscore at the end'   => array( 'test-collection/my-icon_' ),
 			'hyphen at the start'     => array( 'test-collection/-my-icon' ),
+			'hyphen at the end'       => array( 'test-collection/my-icon-' ),
 		);
 	}