WP_REST_Block_Types_Controller

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 2

Every hook that fires from inside WP_REST_Block_Types_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 2

$block_registryWP_Block_Type_Registryprotected

Instance of WP_Block_Type_Registry.

$style_registryWP_Block_Styles_Registryprotected

Instance of WP_Block_Styles_Registry.

Methods · 12

• __construct()Constructor.
• register_routes()Registers the routes for block types.
• get_items_permissions_check()Checks whether a given request has permission to read post block types.
• get_items()Retrieves all post block types, depending on user context.
• get_item_permissions_check()Checks if a given request has access to read a block type.
• check_read_permission()Checks whether a given block type should be visible.
• get_block()Get the block, if the name is valid.
• get_item()Retrieves a specific block type.
• prepare_item_for_response()Prepares a block type object for serialization.
• prepare_links()Prepares links for the request.
• get_item_schema()Retrieves the block type' schema, conforming to JSON Schema.
• get_collection_params()Retrieves the query params for collections.

Source code

View on Trac ↗View on GitHub ↗

17class WP_REST_Block_Types_Controller extends WP_REST_Controller {18 19	const NAME_PATTERN = '^[a-z][a-z0-9-]*/[a-z][a-z0-9-]*$';20 21	/**22	 * Instance of WP_Block_Type_Registry.23	 *24	 * @since 5.5.025	 * @var WP_Block_Type_Registry26	 */27	protected $block_registry;28 29	/**30	 * Instance of WP_Block_Styles_Registry.31	 *32	 * @since 5.5.033	 * @var WP_Block_Styles_Registry34	 */35	protected $style_registry;36 37	/**38	 * Constructor.39	 *40	 * @since 5.5.041	 */42	public function __construct() {43		$this->namespace      = 'wp/v2';44		$this->rest_base      = 'block-types';45		$this->block_registry = WP_Block_Type_Registry::get_instance();46		$this->style_registry = WP_Block_Styles_Registry::get_instance();47	}48 49	/**50	 * Registers the routes for block types.51	 *52	 * @since 5.5.053	 *54	 * @see register_rest_route()55	 */56	public function register_routes() {57 58		register_rest_route(59			$this->namespace,60			'/' . $this->rest_base,61			array(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<namespace>[a-zA-Z0-9_-]+)',75			array(76				array(77					'methods'             => WP_REST_Server::READABLE,78					'callback'            => array( $this, 'get_items' ),79					'permission_callback' => array( $this, 'get_items_permissions_check' ),80					'args'                => $this->get_collection_params(),81				),82				'schema' => array( $this, 'get_public_item_schema' ),83			)84		);85 86		register_rest_route(87			$this->namespace,88			'/' . $this->rest_base . '/(?P<namespace>[a-zA-Z0-9_-]+)/(?P<name>[a-zA-Z0-9_-]+)',89			array(90				'args'   => array(91					'name'      => array(92						'description' => __( 'Block name.' ),93						'type'        => 'string',94					),95					'namespace' => array(96						'description' => __( 'Block namespace.' ),

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 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-block-types-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.