WP_REST_Pattern_Directory_Controller::prepare_item_for_response( object $raw_pattern, WP_REST_Request $request )
Prepare a raw pattern before it’s output in an API response.
Parameters
- $raw_pattern
-
(object) (Required) A pattern from api.wordpress.org, before any changes.
- $request
-
(WP_REST_Request) (Required) Request object.
Return
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php
public function prepare_item_for_response( $raw_pattern, $request ) { $prepared_pattern = array( 'id' => absint( $raw_pattern->id ), 'title' => sanitize_text_field( $raw_pattern->title->rendered ), 'content' => wp_kses_post( $raw_pattern->pattern_content ), 'categories' => array_map( 'sanitize_title', $raw_pattern->category_slugs ), 'keywords' => array_map( 'sanitize_title', $raw_pattern->keyword_slugs ), 'description' => sanitize_text_field( $raw_pattern->meta->wpop_description ), 'viewport_width' => absint( $raw_pattern->meta->wpop_viewport_width ), ); $prepared_pattern = $this->add_additional_fields_to_object( $prepared_pattern, $request ); $response = new WP_REST_Response( $prepared_pattern ); /** * Filters the REST API response for a pattern. * * @since 5.8.0 * * @param WP_REST_Response $response The response object. * @param object $raw_pattern The unprepared pattern. * @param WP_REST_Request $request The request object. */ return apply_filters( 'rest_prepare_block_pattern', $response, $raw_pattern, $request ); }
Changelog
Version | Description |
---|---|
5.8.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_rest_pattern_directory_controller/prepare_item_for_response