WP_REST_Icons_Controller
- Since
- 7.0.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-icons-controller.php:21
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).
Description
Icons are comprised of their SVG source, a name and a translatable label.
Compatibility
- WordPress
- since 7.0.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in 2 of the 5 tracked releases, added in 7.0.0.
Methods · 10
- __construct()Constructs the controller.
- register_routes()Registers the routes for the objects of the controller.
- get_items_permissions_check()Checks whether a given request has permission to read icons.
- get_item_permissions_check()Checks if a given request has access to read a specific icon.
- get_items()Retrieves all icons.
- get_item()Retrieves a specific icon.
- get_icon()Retrieves a specific icon from the registry.
- prepare_item_for_response()Prepare a raw icon before it gets output in a REST API response.
- get_item_schema()Retrieves the icon schema, conforming to JSON Schema.
- get_collection_params()Retrieves the query params for the icons collection.
Source code
class WP_REST_Icons_Controller extends WP_REST_Controller { /** * Constructs the controller. */ public function __construct() { $this->namespace = 'wp/v2'; $this->rest_base = 'icons'; } /** * Registers the routes for the objects of the controller. */ public function register_routes() { register_rest_route( $this->namespace, '/' . $this->rest_base, array( 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-z][a-z0-9-]*/[a-z][a-z0-9-]*)', array( 'args' => array( 'name' => array( 'description' => __( 'Icon name.' ), 'type' => 'string', ), ), array( 'methods' => WP_REST_Server::READABLE, 'callback' => array( $this, 'get_item' ), 'permission_callback' => array( $this, 'get_item_permissions_check' ), 'args' => array( 'context' => $this->get_context_param( array( 'default' => 'view' ) ), ), ), 'schema' => array( $this, 'get_public_item_schema' ), ) ); } /** * Checks whether a given request has permission to read icons. * * @param WP_REST_Request $request Full details about the request. * @return true|WP_Error True if the request has read access, WP_Error object otherwise. */ public function get_items_permissions_check( // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable $request ) { if ( current_user_can( 'edit_posts' ) ) { return true; } foreach ( get_post_types( array( 'show_in_rest' => true ), 'objects' ) as $post_type ) { if ( current_user_can( $post_type->cap->edit_posts ) ) { return true; } } return new WP_Error( 'rest_cannot_view', __( 'Sorry, you are not allowed to view the registered icons.' ), array( 'status' => rest_authorization_required_code() ) ); } /** * Checks if a given request has access to read a specific icon.Changelog
Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.
Signature, return type and hooks compared across 2 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-icons-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.