sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

REST API: Skip processing fields which are not present in the selected context. 

In `WP_REST_Controller::get_fields_for_response()`, exclude fields which are not registered to appear in the request's context.

In conjunction with r45705 this prevents the unnecessary computation of the sample permalink when making a request that is not context=edit.

Props dlh.
Fixes #45605.


git-svn-id: https://develop.svn.wordpress.org/trunk@45706 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
K. Adam White 2019-07-31 20:20:02 +00:00
parent 7aae0cfe56
commit a875f9dae7
2 changed files with 103 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php
View File

@ -517,18 +517,30 @@ abstract class WP_REST_Controller {
* @return array Fields to be included in the response. * @return array Fields to be included in the response.
*/ */
public function get_fields_for_response( $request ) { public function get_fields_for_response( $request ) {
$schema = $this->get_item_schema(); $schema = $this->get_item_schema();
$fields = isset( $schema['properties'] ) ? array_keys( $schema['properties'] ) : array(); $properties = isset( $schema['properties'] ) ? $schema['properties'] : array();
$additional_fields = $this->get_additional_fields(); $additional_fields = $this->get_additional_fields();
foreach ( $additional_fields as $field_name => $field_options ) { foreach ( $additional_fields as $field_name => $field_options ) {
// For back-compat, include any field with an empty schema // For back-compat, include any field with an empty schema
// because it won't be present in $this->get_item_schema(). // because it won't be present in $this->get_item_schema().
if ( is_null( $field_options['schema'] ) ) { if ( is_null( $field_options['schema'] ) ) {
$fields[] = $field_name; $properties[ $field_name ] = $field_options;
} }
} }
// Exclude fields that specify a different context than the request context.
$context = $request['context'];
if ( $context ) {
foreach ( $properties as $name => $options ) {
if ( ! empty( $options['context'] ) && ! in_array( $context, $options['context'], true ) ) {
unset( $properties[ $name ] );
}
}
}
$fields = array_keys( $properties );
if ( ! isset( $request['_fields'] ) ) { if ( ! isset( $request['_fields'] ) ) {
return $fields; return $fields;
} }

88
tests/phpunit/tests/rest-api/rest-controller.php
View File

@ -255,6 +255,94 @@ class WP_Test_REST_Controller extends WP_Test_REST_TestCase {
); );
} }
public function test_get_fields_for_response_filters_by_context() {
$controller = new WP_REST_Test_Controller();
$request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
$request->set_param( 'context', 'view' );
$schema = $controller->get_item_schema();
$field = 'somefield';
$listener = new MockAction();
$method = 'action';
register_rest_field(
$schema['title'],
$field,
array(
'schema' => array(
'type' => 'string',
'context' => array( 'embed' ),
),
'get_callback' => array( $listener, $method ),
)
);
$controller->prepare_item_for_response( array(), $request );
$this->assertSame( 0, $listener->get_call_count( $method ) );
$request->set_param( 'context', 'embed' );
$controller->prepare_item_for_response( array(), $request );
$this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
}
public function test_filtering_fields_for_response_by_context_returns_fields_with_no_context() {
$controller = new WP_REST_Test_Controller();
$request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
$request->set_param( 'context', 'view' );
$schema = $controller->get_item_schema();
$field = 'somefield';
$listener = new MockAction();
$method = 'action';
register_rest_field(
$schema['title'],
$field,
array(
'schema' => array(
'type' => 'string',
),
'get_callback' => array( $listener, $method ),
)
);
$controller->prepare_item_for_response( array(), $request );
$this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
}
public function test_filtering_fields_for_response_by_context_returns_fields_with_no_schema() {
$controller = new WP_REST_Test_Controller();
$request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
$request->set_param( 'context', 'view' );
$schema = $controller->get_item_schema();
$field = 'somefield';
$listener = new MockAction();
$method = 'action';
register_rest_field(
$schema['title'],
$field,
array(
'get_callback' => array( $listener, $method ),
)
);
$controller->prepare_item_for_response( array(), $request );
$this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
}
public function test_add_additional_fields_to_object_respects_fields_param() { public function test_add_additional_fields_to_object_respects_fields_param() {
$controller = new WP_REST_Test_Controller(); $controller = new WP_REST_Test_Controller();
$request = new WP_REST_Request( 'GET', '/wp/v2/testroute' ); $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );