-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor Reusable Blocks controller to use WP_REST_Posts_Controller
We can remove a lot of code by subclassing WP_REST_Posts_Controller, which gives us methods for creating, reading, updating and deleting posts (in this case, blocks) for free. This also adds support for DELETEing a block to the API, and renames the 'name' field to 'title'.
- Loading branch information
1 parent
64ac510
commit 6074606
Showing
15 changed files
with
373 additions
and
631 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,116 @@ | ||
| <?php | ||
| /** | ||
| * Reusable Blocks REST API: WP_REST_Blocks_Controller class | ||
| * | ||
| * @package gutenberg | ||
| * @since 0.10.0 | ||
| */ | ||
|
|
||
| /** | ||
| * Controller which provides a REST endpoint for Gutenberg to read, create, | ||
| * edit and delete reusable blocks. Blocks are stored as posts with the | ||
| * wp_block post type. | ||
| * | ||
| * @since 0.10.0 | ||
| * | ||
| * @see WP_REST_Controller | ||
| */ | ||
| class WP_REST_Blocks_Controller extends WP_REST_Posts_Controller { | ||
| /** | ||
| * Given an update or create request, build the post object that is saved to | ||
| * the database. | ||
| * | ||
| * @since 1.10.0 | ||
| * | ||
| * @param WP_REST_Request $request Request object. | ||
| * @return stdClass|WP_Error Post object or WP_Error. | ||
| */ | ||
| protected function prepare_item_for_database( $request ) { | ||
| $prepared_post = new stdClass; | ||
|
|
||
| if ( isset( $request['id'] ) ) { | ||
| $existing_post = $this->get_post( $request['id'] ); | ||
| if ( is_wp_error( $existing_post ) ) { | ||
| return $existing_post; | ||
| } | ||
|
|
||
| $prepared_post->ID = $existing_post->ID; | ||
| } | ||
|
|
||
| $prepared_post->post_title = $request['title']; | ||
| $prepared_post->post_content = $request['content']; | ||
| $prepared_post->post_type = $this->post_type; | ||
| $prepared_post->post_status = 'publish'; | ||
|
|
||
| return apply_filters( "rest_pre_insert_{$this->post_type}", $prepared_post, $request ); | ||
| } | ||
|
|
||
| /** | ||
| * Given a post from the database, build the array that is returned from an | ||
| * API response. | ||
| * | ||
| * @since 1.10.0 | ||
| * | ||
| * @param WP_Post $post Post object. | ||
| * @param WP_REST_Request $request Request object. | ||
| * @return WP_REST_Response Response object. | ||
| */ | ||
| public function prepare_item_for_response( $post, $request ) { | ||
| $data = array( | ||
| 'id' => $post->ID, | ||
| 'title' => $post->post_title, | ||
| 'content' => $post->post_content, | ||
| ); | ||
|
|
||
| $response = rest_ensure_response( $data ); | ||
|
|
||
| return apply_filters( "rest_prepare_{$this->post_type}", $response, $post, $request ); | ||
| } | ||
|
|
||
| /** | ||
| * Handle a DELETE request. | ||
| * | ||
| * @since 1.10.0 | ||
| * | ||
| * @param WP_REST_Request $request Full details about the request. | ||
| * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure. | ||
| */ | ||
| public function delete_item( $request ) { | ||
| // Always hard-delete a block. | ||
| $request->set_param( 'force', true ); | ||
|
|
||
| return parent::delete_item( $request ); | ||
| } | ||
|
|
||
| /** | ||
| * Builds the block's schema, conforming to JSON Schema. | ||
| * | ||
| * @since 1.10.0 | ||
| * | ||
| * @return array Item schema data. | ||
| */ | ||
| public function get_item_schema() { | ||
| return array( | ||
| '$schema' => 'http://json-schema.org/schema#', | ||
| 'title' => $this->post_type, | ||
| 'type' => 'object', | ||
| 'properties' => array( | ||
| 'id' => array( | ||
| 'description' => __( 'Unique identifier for the block.', 'gutenberg' ), | ||
| 'type' => 'integer', | ||
| 'readonly' => true, | ||
| ), | ||
| 'title' => array( | ||
| 'description' => __( 'The block\'s title.', 'gutenberg' ), | ||
| 'type' => 'string', | ||
| 'required' => true, | ||
| ), | ||
| 'content' => array( | ||
| 'description' => __( 'The block\'s HTML content.', 'gutenberg' ), | ||
| 'type' => 'string', | ||
| 'required' => true, | ||
| ), | ||
| ), | ||
| ); | ||
| } | ||
| } |
Oops, something went wrong.