WP_REST_Controller::filter_response_by_context() – Method

WP_REST_Controller::filter_response_by_context( array $response_data, string $context ): array

Filters a response based on the context defined in the schema.

Parameters

$response_dataarrayrequired: Response data to filter.
$contextstringrequired: Context defined in the schema.

Return

array Filtered response.

Source

public function filter_response_by_context( $response_data, $context ) {

	$schema = $this->get_item_schema();

	return rest_filter_response_by_context( $response_data, $schema, $context );
}

View all references View on Trac View on GitHub

Uses	Description
rest_filter_response_by_context()`wp-includes/rest-api.php`	Filters the response to remove any fields not available in the given context.
WP_REST_Controller::get_item_schema()`wp-includes/rest-api/endpoints/class-wp-rest-controller.php`	Retrieves the item’s schema, conforming to JSON Schema.

Changelog

Version	Description
4.7.0	Introduced.

User Contributed Notes

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