WordPress.org

Make WordPress Core

Changeset 43736


Ignore:
Timestamp:
10/17/2018 02:40:23 AM (5 months ago)
Author:
danielbachhuber
Message:

REST API: Don't add fields to object when not included in ?_fields=.

In [43087], we improved REST API performance by only rendering the fields specified in the request. Similarly, any fields registered with register_rest_field() should only be rendered when included in ?_fields=.

Props dlh.
Fixes #45099.

Location:
branches/5.0
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • branches/5.0/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php

    r43445 r43736  
    386386        $additional_fields = $this->get_additional_fields();
    387387
     388        $requested_fields = $this->get_fields_for_response( $request );
     389
    388390        foreach ( $additional_fields as $field_name => $field_options ) {
    389391
    390392            if ( ! $field_options['get_callback'] ) {
     393                continue;
     394            }
     395
     396            if ( ! in_array( $field_name, $requested_fields, true ) ) {
    391397                continue;
    392398            }
  • branches/5.0/tests/phpunit/tests/rest-api/rest-controller.php

    r43445 r43736  
    214214        ), $fields );
    215215    }
     216
     217    public function test_add_additional_fields_to_object_respects_fields_param() {
     218        $controller = new WP_REST_Test_Controller();
     219        $request    = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
     220        $schema     = $controller->get_item_schema();
     221        $field      = 'somefield';
     222
     223        $listener = new MockAction();
     224        $method = 'action';
     225
     226        register_rest_field(
     227            $schema['title'],
     228            $field,
     229            array(
     230                'get_callback' => array( $listener, $method ),
     231                'schema'       => array(
     232                    'type' => 'string',
     233                ),
     234            )
     235        );
     236
     237        $item = array();
     238
     239        $controller->prepare_item_for_response( $item, $request );
     240
     241        $first_call_count = $listener->get_call_count( $method );
     242
     243        $this->assertTrue( $first_call_count > 0 );
     244
     245        $request->set_param( '_fields', 'somestring' );
     246
     247        $controller->prepare_item_for_response( $item, $request );
     248
     249        $this->assertSame( $first_call_count, $listener->get_call_count( $method ) );
     250
     251        $request->set_param( '_fields', $field );
     252
     253        $controller->prepare_item_for_response( $item, $request );
     254
     255        $this->assertTrue( $listener->get_call_count( $method ) > $first_call_count );
     256    }
    216257}
  • branches/5.0/tests/phpunit/tests/rest-api/rest-test-controller.php

    r38832 r43736  
    1111 */
    1212class WP_REST_Test_Controller extends WP_REST_Controller {
     13    /**
     14     * Prepares the item for the REST response.
     15     *
     16     * @param mixed           $item    WordPress representation of the item.
     17     * @param WP_REST_Request $request Request object.
     18     * @return WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.
     19     */
     20    public function prepare_item_for_response( $item, $request ) {
     21        $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
     22        $item = $this->add_additional_fields_to_object( $item, $request );
     23        $item = $this->filter_response_by_context( $item, $context );
     24        $response = rest_ensure_response( $item );
     25        return $response;
     26    }
    1327
    1428    /**
    15      * Get the Post type's schema, conforming to JSON Schema
     29     * Get the item's schema, conforming to JSON Schema.
    1630     *
    1731     * @return array
     
    7387        );
    7488
    75         return $schema;
     89        return $this->add_additional_fields_schema( $schema );
    7690    }
    7791
Note: See TracChangeset for help on using the changeset viewer.