Uses
Uses | Description |
---|---|
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller | Core class to access posts via the REST API. |
Controller which provides a REST endpoint for the editor to read, create, edit and delete reusable blocks. Blocks are stored as posts with the wp_block post type.
File: wp-includes/rest-api/endpoints/class-wp-rest-blocks-controller.php
class WP_REST_Blocks_Controller extends WP_REST_Posts_Controller { /** * Checks if a block can be read. * * @since 5.0.0 * * @param WP_Post $post Post object that backs the block. * @return bool Whether the block can be read. */ public function check_read_permission( $post ) { // By default the read_post capability is mapped to edit_posts. if ( ! current_user_can( 'read_post', $post->ID ) ) { return false; } return parent::check_read_permission( $post ); } /** * Filters a response based on the context defined in the schema. * * @since 5.0.0 * * @param array $data Response data to fiter. * @param string $context Context defined in the schema. * @return array Filtered response. */ public function filter_response_by_context( $data, $context ) { $data = parent::filter_response_by_context( $data, $context ); /* * Remove `title.rendered` and `content.rendered` from the response. It * doesn't make sense for a reusable block to have rendered content on its * own, since rendering a block requires it to be inside a post or a page. */ unset( $data['title']['rendered'] ); unset( $data['content']['rendered'] ); return $data; } /** * Retrieves the block's schema, conforming to JSON Schema. * * @since 5.0.0 * * @return array Item schema data. */ public function get_item_schema() { // Do not cache this schema because all properties are derived from parent controller. $schema = parent::get_item_schema(); /* * Allow all contexts to access `title.raw` and `content.raw`. Clients always * need the raw markup of a reusable block to do anything useful, e.g. parse * it or display it in an editor. */ $schema['properties']['title']['properties']['raw']['context'] = array( 'view', 'edit' ); $schema['properties']['content']['properties']['raw']['context'] = array( 'view', 'edit' ); /* * Remove `title.rendered` and `content.rendered` from the schema. It doesn’t * make sense for a reusable block to have rendered content on its own, since * rendering a block requires it to be inside a post or a page. */ unset( $schema['properties']['title']['properties']['rendered'] ); unset( $schema['properties']['content']['properties']['rendered'] ); return $schema; } }
Version | Description |
---|---|
5.0.0 | Introduced. |
© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_blocks_controller