WP_REST_Block_Patterns_Controller::prepare_item_for_response() WordPress Method
The WP_REST_Block_Patterns_Controller::prepare_item_for_response() method is used to prepare a single block pattern for response.
WP_REST_Block_Patterns_Controller::prepare_item_for_response( array $item, WP_REST_Request $request ) #
Prepare a raw block pattern before it gets output in a REST API response.
Parameters
- $item
(array)(Required)Raw pattern as registered, before any changes.
- $request
(WP_REST_Request)(Required)Request object.
Return
(WP_REST_Response|WP_Error) Response object on success, or WP_Error object on failure.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-block-patterns-controller.php
public function prepare_item_for_response( $item, $request ) { $fields = $this->get_fields_for_response( $request ); $keys = array( 'name' => 'name', 'title' => 'title', 'description' => 'description', 'viewportWidth' => 'viewport_width', 'blockTypes' => 'block_types', 'categories' => 'categories', 'keywords' => 'keywords', 'content' => 'content', 'inserter' => 'inserter', ); $data = array(); foreach ( $keys as $item_key => $rest_key ) { if ( isset( $item[ $item_key ] ) && rest_is_field_included( $rest_key, $fields ) ) { $data[ $rest_key ] = $item[ $item_key ]; } } $context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->filter_response_by_context( $data, $context ); return rest_ensure_response( $data ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
6.0.0 | Introduced. |