Changeset 62748 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-icons-controller.php

Timestamp:

07/15/2026 04:25:35 AM (8 weeks ago)

Author:

wildworks

Message:

Icons: Add APIs for collection and icon registration

Introduces a set of public APIs for registering icon collections and individual icons, allowing themes and plugins to register icons for consistent use across the block editor and the wider WordPress admin.

• Add the WP_Icon_Collections_Registry class, a singleton that manages the registration of icon collections. Each collection groups a set of icons under a namespace and is exposed through the REST API via the new WP_REST_Icon_Collections_Controller.
• Update the WP_Icons_Registry class to allow registering custom icons through public register() and unregister() methods, surfaced through WP_REST_Icons_Controller.
• Add four wrapper functions in icons.php: wp_register_icon_collection() and wp_unregister_icon_collection() for collections, and wp_register_icon() and wp_unregister_icon() for individual icons.
• Register the default collections and icons through _wp_register_default_icon_collections() and _wp_register_default_icons(), both hooked to the init action.

Props mcsf, tyxla, wildworks.
See #64847.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-icons-controller.php (modified) (15 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-icons-controller.php

@@ -1 +1 @@
 <?php
+
 /**
  * REST API: WP_REST_Icons_Controller class
@@ -10 +11 @@
 /**
  * Controller which provides a REST endpoint for the editor to read registered
- * icons. For the time being, only core icons are available, which are defined
- * in a single manifest file (wp-includes/assets/icon-library-manifest.php).
- * Icons are comprised of their SVG source, a name and a translatable label.
+ * icons. Icons are grouped into collections (the default one being `core`).
  *
  * @since 7.0.0
@@ -34 +33 @@
          *
          * @since 7.0.0
+         * @since 7.1.0 Added the `/icons/<collection>` collection-scoped route.
          */
         public function register_routes() {
@@ -52 +52 @@
                 register_rest_route(
                         $this->namespace,
-                        '/' . $this->rest_base . '/(?P<name>[a-z][a-z0-9-]*/[a-z][a-z0-9-]*)',
+                        '/' . $this->rest_base . '/(?P<collection>[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)',
+                        array(
+                                'args'   => array(
+                                        'collection' => array(
+                                                'description' => __( 'Icon collection slug.' ),
+                                                'type'        => 'string',
+                                        ),
+                                ),
+                                array(
+                                        'methods'             => WP_REST_Server::READABLE,
+                                        'callback'            => array( $this, 'get_items' ),
+                                        'permission_callback' => array( $this, 'get_items_permissions_check' ),
+                                        'args'                => $this->get_collection_params(),
+                                ),
+                                'schema' => array( $this, 'get_public_item_schema' ),
+                        )
+                );
+
+                register_rest_route(
+                        $this->namespace,
+                        '/' . $this->rest_base . '/(?P<name>[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?/[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)',
                         array(
                                 'args'   => array(
@@ -120 +140 @@
 
         /**
-         * Retrieves all icons.
-         *
-         * @since 7.0.0
+         * Retrieves all icons, optionally scoped to a collection.
+         *
+         * @since 7.0.0
+         * @since 7.1.0 Supports filtering by collection.
          *
          * @param WP_REST_Request $request Full details about the request.
@@ -128 +149 @@
          */
         public function get_items( $request ) {
+                $collection = $request->get_param( 'collection' );
+
+                if ( null !== $collection && ! WP_Icon_Collections_Registry::get_instance()->is_registered( $collection ) ) {
+                        return new WP_Error(
+                                'rest_icon_collection_not_found',
+                                sprintf(
+                                        /* translators: %s: Icon collection slug. */
+                                        __( 'Icon collection not found: "%s".' ),
+                                        $collection
+                                ),
+                                array( 'status' => 404 )
+                        );
+                }
+
                 $response = array();
                 $search   = $request->get_param( 'search' );
                 $icons    = WP_Icons_Registry::get_instance()->get_registered_icons( $search );
+
                 foreach ( $icons as $icon ) {
+                        if ( null !== $collection && ( ! isset( $icon['collection'] ) || $icon['collection'] !== $collection ) ) {
+                                continue;
+                        }
                         $prepared_icon = $this->prepare_item_for_response( $icon, $request );
                         $response[]    = $this->prepare_response_for_collection( $prepared_icon );
@@ -187 +226 @@
          *
          * @since 7.0.0
+         * @since 7.1.0 Added the `collection` field.
          *
          * @param array           $item    Raw icon as registered, before any changes.
@@ -195 +235 @@
                 $fields = $this->get_fields_for_response( $request );
                 $keys   = array(
-                        'name'    => 'name',
-                        'label'   => 'label',
-                        'content' => 'content',
+                        'name'       => 'name',
+                        'label'      => 'label',
+                        'content'    => 'content',
+                        'collection' => 'collection',
                 );
                 $data   = array();
@@ -216 +257 @@
          *
          * @since 7.0.0
+         * @since 7.1.0 Added the `collection` property.
          *
          * @return array Item schema data.
@@ -229 +271 @@
                         'type'       => 'object',
                         'properties' => array(
-                                'name'    => array(
+                                'name'       => array(
                                         'description' => __( 'The icon name.' ),
                                         'type'        => 'string',
@@ -235 +277 @@
                                         'context'     => array( 'view', 'edit', 'embed' ),
                                 ),
-                                'label'   => array(
+                                'label'      => array(
                                         'description' => __( 'The icon label.' ),
                                         'type'        => 'string',
@@ -241 +283 @@
                                         'context'     => array( 'view', 'edit', 'embed' ),
                                 ),
-                                'content' => array(
+                                'content'    => array(
                                         'description' => __( 'The icon content (SVG markup).' ),
                                         'type'        => 'string',
@@ -247 +289 @@
                                         'context'     => array( 'view', 'edit', 'embed' ),
                                 ),
+                                'collection' => array(
+                                        'description' => __( 'The slug of the collection this icon belongs to.' ),
+                                        'type'        => 'string',
+                                        'readonly'    => true,
+                                        'context'     => array( 'view', 'edit', 'embed' ),
+                                ),
                         ),
                 );
@@ -259 +307 @@
          *
          * @since 7.0.0
+         * @since 7.1.0 Added the `collection` parameter.
          *
          * @return array Collection parameters.
@@ -265 +314 @@
                 $query_params                       = parent::get_collection_params();
                 $query_params['context']['default'] = 'view';
+                $query_params['collection']         = array(
+                        'description' => __( 'Limit results to icons belonging to the given collection slug.' ),
+                        'type'        => 'string',
+                        'pattern'     => '^[a-z0-9]([a-z0-9_-]*[a-z0-9])?$',
+                );
                 return $query_params;
         }