Fix Ticket - 57902 - REST API index does not respect fields #4483
Conversation
|
|
||
| if ( ! empty( $links ) ) { | ||
| if ( ! empty( $_GET['_fields'] ) ) { |
There was a problem hiding this comment.
$_GET is not going to be reliable for checking _fields because REST API requests can be dispatched within PHP, not just with the browser.
Also, I think relying on $_GET here would mean that all responses from the server would use the same set of fields, ignoring the _fields passed to individual requests, which I don't think is the desired outcome.
I think we'll want to use the fields that are in the request object, not globals.
There was a problem hiding this comment.
Thank you, @dlh01 , for your feedback. I have made the necessary updates by replacing the use of $_GET with the $request object. Additionally, I have addressed the issue where the old logic failed to include the _links when the ?_fields query variable was not passed. The updated code resolves both of these issues. Please review it on your end and let me know if any further changes are required.
There was a problem hiding this comment.
Thanks for the updates! I'll try to review the PR again this weekend.
to validate the _links is requested or not in _fields query parameter, request object is pass to function response_to_data as function parameter and assign null as default value to the third parameter for the compatibility
| * @return array { | ||
| * Data with sub-requests embedded. | ||
| * | ||
| * @type array $_links Links. | ||
| * @type array $_embedded Embedded objects. | ||
| * } | ||
| */ | ||
| public function response_to_data( $response, $embed ) { | ||
| public function response_to_data( $response, $embed, $request = null ) { | ||
| $data = $response->get_data(); | ||
| $links = self::get_compact_response_links( $response ); |
There was a problem hiding this comment.
Is it better to check that links are needed in the first place before getting them?
There was a problem hiding this comment.
Agreed, it would be more efficient to skip getting the links at all if we know they are not requested. That would avoid wasted effort generating a links object we don't go on to use.
There was a problem hiding this comment.
Right, it's respecting the _fields in function rest_filter_response_fields but
$links = self::get_compact_response_links( $response );
if ( ! empty( $links ) ) {
$data['_links'] = $links;
}
This code will add the _links anyway, it's not validating the _fields. so I decide to add the $request object as parameter.
Trac ticket: https://core.trac.wordpress.org/ticket/57902
Description
This PR introduces validation for the
_linksfield in the_fieldsquery parameter. If the_linksfield is present, it will be appended to the response object. Otherwise, it will not be included.Test Case
Case 1
/wp-json?_fields[]=name&_fields[]=_linksCase 2
/wp-json?_fields[]=nameCase 3
/wp-json?_fields=nameCase 4
/wp-json?_fields=name,_linksCase 5
/wp-json_links