过滤API响应以仅包括一组列入白名单的响应对象字段。

原型

rest_filter_response_fields( WP_REST_Response $response, WP_REST_Server $server, WP_REST_Request $request )

参数

$response (WP_REST_Response) (Required) 当前的响应正在服务。

$server (WP_REST_Server) (Required) ResponseHandler实例(通常是WP_REST_Server)。

$request (WP_REST_Request) (Required) 用于进行当前响应的请求。

返回值

(WP_REST_Response)  响应服务,减少以包含字段的子集。

源文件

路径:wp-includes/rest-api.php

<?php
...
function rest_filter_response_fields( $response, $server, $request ) {
	if ( ! isset( $request['_fields'] ) || $response->is_error() ) {
		return $response;
	}
	$data = $response->get_data();
	$fields = is_array( $request['_fields']  ) ? $request['_fields'] : preg_split( '/[s,]+/', $request['_fields'] );
	if ( 0 === count( $fields ) ) {
		return $response;
	}
	// Trim off outside whitespace from the comma delimited list.
	$fields = array_map( 'trim', $fields );
	$fields_as_keyed = array_combine( $fields, array_fill( 0, count( $fields ), true ) );
	if ( wp_is_numeric_array( $data ) ) {
		$new_data = array();
		foreach ( $data as $item ) {
			$new_data[] = array_intersect_key( $item, $fields_as_keyed );
		}
	} else {
		$new_data = array_intersect_key( $data, $fields_as_keyed );
	}
	$response->set_data( $new_data );
	return $response;
}
...
?>

其他

英文文档:https://developer.wordpress.org/reference/functions/rest_filter_response_fields/