WP_REST_Icons_Controller

Compatibility

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, optionally scoped to a collection.
• 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

View on Trac ↗View on GitHub ↗

19class WP_REST_Icons_Controller extends WP_REST_Controller {20 21	/**22	 * Constructs the controller.23	 *24	 * @since 7.0.025	 */26	public function __construct() {27		$this->namespace = 'wp/v2';28		$this->rest_base = 'icons';29	}30 31	/**32	 * Registers the routes for the objects of the controller.33	 *34	 * @since 7.0.035	 * @since 7.1.0 Added the `/icons/<collection>` collection-scoped route.36	 */37	public function register_routes() {38		register_rest_route(39			$this->namespace,40			'/' . $this->rest_base,41			array(42				array(43					'methods'             => WP_REST_Server::READABLE,44					'callback'            => array( $this, 'get_items' ),45					'permission_callback' => array( $this, 'get_items_permissions_check' ),46					'args'                => $this->get_collection_params(),47				),48				'schema' => array( $this, 'get_public_item_schema' ),49			)50		);51 52		register_rest_route(53			$this->namespace,54			'/' . $this->rest_base . '/(?P<collection>[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)',55			array(56				'args'   => array(57					'collection' => array(58						'description' => __( 'Icon collection slug.' ),59						'type'        => 'string',60					),61				),62				array(63					'methods'             => WP_REST_Server::READABLE,64					'callback'            => array( $this, 'get_items' ),65					'permission_callback' => array( $this, 'get_items_permissions_check' ),66					'args'                => $this->get_collection_params(),67				),68				'schema' => array( $this, 'get_public_item_schema' ),69			)70		);71 72		register_rest_route(73			$this->namespace,74			'/' . $this->rest_base . '/(?P<name>[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?/[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)',75			array(76				'args'   => array(77					'name' => array(78						'description' => __( 'Icon name.' ),79						'type'        => 'string',80					),81				),82				array(83					'methods'             => WP_REST_Server::READABLE,84					'callback'            => array( $this, 'get_item' ),85					'permission_callback' => array( $this, 'get_item_permissions_check' ),86					'args'                => array(87						'context' => $this->get_context_param( array( 'default' => 'view' ) ),88					),89				),90				'schema' => array( $this, 'get_public_item_schema' ),91			)92		);93	}94 95	/**96	 * Checks whether a given request has permission to read icons.97	 *98	 * @since 7.0.0

Changelog

Introduced in 7.0.0. Unchanged from 7.0.4 through 7.1.0.

1. 7.0.4
2. 7.1.0

Signature, return type and hooks compared across 2 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 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.