vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-05-29 15:44:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

REST API: Support more JSON Schemas when filtering a response by context.

Browse Source 
The array type, multi-types, and the additional properties keyword are now supported. Additionally, the filter recurses to an infinite depth.

Fixes #48819.


git-svn-id: https://develop.svn.wordpress.org/trunk@47758 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs
2020-05-04 02:44:44 +00:00
parent 9a903f7e73
commit 8153d15f09
3 changed files with 382 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
src/wp-includes/rest-api.php
View File

@@ -1658,3 +1658,63 @@ function rest_parse_embed_param( $embed ) {
return $rels;
}
/**
* Filters the response to remove any fields not available in the given context.
*
* @since 5.5.0
*
* @param array|object $data The response data to modify.
* @param array $schema The schema for the endpoint used to filter the response.
* @param string $context The requested context.
* @return array|object The filtered response data.
*/
function rest_filter_response_by_context( $data, $schema, $context ) {
if ( ! is_array( $data ) && ! is_object( $data ) ) {
return $data;
}
if ( isset( $schema['type'] ) ) {
$type = $schema['type'];
} elseif ( isset( $schema['properties'] ) ) {
$type = 'object'; // Back compat if a developer accidentally omitted the type.
} else {
return $data;
}
foreach ( $data as $key => $value ) {
$check = array();
if ( 'array' === $type || ( is_array( $type ) && in_array( 'array', $type, true ) ) ) {
$check = isset( $schema['items'] ) ? $schema['items'] : array();
} elseif ( 'object' === $type || ( is_array( $type ) && in_array( 'object', $type, true ) ) ) {
if ( isset( $schema['properties'][ $key ] ) ) {
$check = $schema['properties'][ $key ];
} elseif ( isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] ) ) {
$check = $schema['additionalProperties'];
}
}
if ( ! isset( $check['context'] ) ) {
continue;
}
if ( ! in_array( $context, $check['context'], true ) ) {
if ( is_object( $data ) ) {
unset( $data->$key );
} else {
unset( $data[ $key ] );
}
} elseif ( is_array( $value ) || is_object( $value ) ) {
$new_value = rest_filter_response_by_context( $value, $check, $context );
if ( is_object( $data ) ) {
$data->$key = $new_value;
} else {
$data[ $key ] = $new_value;
}
}
}
return $data;
}