WP_REST_Block_Pattern_Categories_Controller::prepare_item_for_response( array $item, WP_REST_Request $request ): WP_REST_Response|WP_Error

Prepare a raw block pattern category before it gets output in a REST API response.


Parameters

$item array Required
Raw category as registered, before any changes.
$request WP_REST_Request Required
Request object.

Top ↑

Return

WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-block-pattern-categories-controller.php. View all references

public function prepare_item_for_response( $item, $request ) {
	$fields = $this->get_fields_for_response( $request );
	$keys   = array( 'name', 'label', 'description' );
	$data   = array();
	foreach ( $keys as $key ) {
		if ( isset( $item[ $key ] ) && rest_is_field_included( $key, $fields ) ) {
			$data[ $key ] = $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 );
}


Top ↑

Changelog

Changelog
Version Description
6.0.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.