REST API: Filter responses based on the `_fields` parameter, before data is processed.

Historically, the REST API would generate the entire response object, including running expensive filters, then it would apply the `_fields` parameter, discarding the fields that weren't specificed.

This change causes `_fields` to be applied earlier, so that only requested fields are processed.

Merges [43087] to the 4.9 branch.

Props danielbachhuber.
See #43874.


Built from https://develop.svn.wordpress.org/branches/4.9@43445


git-svn-id: http://core.svn.wordpress.org/branches/4.9@43272 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Gary Pendergast 2018-07-13 06:51:27 +00:00
parent cb0ea9d291
commit 595cd450eb
11 changed files with 352 additions and 167 deletions

View File

@ -284,62 +284,84 @@ class WP_REST_Attachments_Controller extends WP_REST_Posts_Controller {
*/ */
public function prepare_item_for_response( $post, $request ) { public function prepare_item_for_response( $post, $request ) {
$response = parent::prepare_item_for_response( $post, $request ); $response = parent::prepare_item_for_response( $post, $request );
$data = $response->get_data(); $fields = $this->get_fields_for_response( $request );
$data = $response->get_data();
$data['description'] = array( if ( in_array( 'description', $fields, true ) ) {
'raw' => $post->post_content, $data['description'] = array(
'raw' => $post->post_content,
/** This filter is documented in wp-includes/post-template.php */
'rendered' => apply_filters( 'the_content', $post->post_content ),
);
}
if ( in_array( 'caption', $fields, true ) ) {
/** This filter is documented in wp-includes/post-template.php */ /** This filter is documented in wp-includes/post-template.php */
'rendered' => apply_filters( 'the_content', $post->post_content ), $caption = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) );
); $data['caption'] = array(
'raw' => $post->post_excerpt,
'rendered' => $caption,
);
}
/** This filter is documented in wp-includes/post-template.php */ if ( in_array( 'alt_text', $fields, true ) ) {
$caption = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) ); $data['alt_text'] = get_post_meta( $post->ID, '_wp_attachment_image_alt', true );
$data['caption'] = array( }
'raw' => $post->post_excerpt,
'rendered' => $caption,
);
$data['alt_text'] = get_post_meta( $post->ID, '_wp_attachment_image_alt', true ); if ( in_array( 'media_type', $fields, true ) ) {
$data['media_type'] = wp_attachment_is_image( $post->ID ) ? 'image' : 'file'; $data['media_type'] = wp_attachment_is_image( $post->ID ) ? 'image' : 'file';
$data['mime_type'] = $post->post_mime_type; }
$data['media_details'] = wp_get_attachment_metadata( $post->ID );
$data['post'] = ! empty( $post->post_parent ) ? (int) $post->post_parent : null;
$data['source_url'] = wp_get_attachment_url( $post->ID );
// Ensure empty details is an empty object. if ( in_array( 'mime_type', $fields, true ) ) {
if ( empty( $data['media_details'] ) ) { $data['mime_type'] = $post->post_mime_type;
$data['media_details'] = new stdClass; }
} elseif ( ! empty( $data['media_details']['sizes'] ) ) {
foreach ( $data['media_details']['sizes'] as $size => &$size_data ) { if ( in_array( 'media_details', $fields, true ) ) {
$data['media_details'] = wp_get_attachment_metadata( $post->ID );
if ( isset( $size_data['mime-type'] ) ) { // Ensure empty details is an empty object.
$size_data['mime_type'] = $size_data['mime-type']; if ( empty( $data['media_details'] ) ) {
unset( $size_data['mime-type'] ); $data['media_details'] = new stdClass;
} elseif ( ! empty( $data['media_details']['sizes'] ) ) {
foreach ( $data['media_details']['sizes'] as $size => &$size_data ) {
if ( isset( $size_data['mime-type'] ) ) {
$size_data['mime_type'] = $size_data['mime-type'];
unset( $size_data['mime-type'] );
}
// Use the same method image_downsize() does.
$image_src = wp_get_attachment_image_src( $post->ID, $size );
if ( ! $image_src ) {
continue;
}
$size_data['source_url'] = $image_src[0];
} }
// Use the same method image_downsize() does. $full_src = wp_get_attachment_image_src( $post->ID, 'full' );
$image_src = wp_get_attachment_image_src( $post->ID, $size );
if ( ! $image_src ) { if ( ! empty( $full_src ) ) {
continue; $data['media_details']['sizes']['full'] = array(
'file' => wp_basename( $full_src[0] ),
'width' => $full_src[1],
'height' => $full_src[2],
'mime_type' => $post->post_mime_type,
'source_url' => $full_src[0],
);
} }
} else {
$size_data['source_url'] = $image_src[0]; $data['media_details']['sizes'] = new stdClass;
} }
}
$full_src = wp_get_attachment_image_src( $post->ID, 'full' ); if ( in_array( 'post', $fields, true ) ) {
$data['post'] = ! empty( $post->post_parent ) ? (int) $post->post_parent : null;
}
if ( ! empty( $full_src ) ) { if ( in_array( 'source_url', $fields, true ) ) {
$data['media_details']['sizes']['full'] = array( $data['source_url'] = wp_get_attachment_url( $post->ID );
'file' => wp_basename( $full_src[0] ),
'width' => $full_src[1],
'height' => $full_src[2],
'mime_type' => $post->post_mime_type,
'source_url' => $full_src[0],
);
}
} else {
$data['media_details']['sizes'] = new stdClass;
} }
$context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $context = ! empty( $request['context'] ) ? $request['context'] : 'view';

View File

@ -851,35 +851,79 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
* @return WP_REST_Response Response object. * @return WP_REST_Response Response object.
*/ */
public function prepare_item_for_response( $comment, $request ) { public function prepare_item_for_response( $comment, $request ) {
$data = array(
'id' => (int) $comment->comment_ID, $fields = $this->get_fields_for_response( $request );
'post' => (int) $comment->comment_post_ID, $data = array();
'parent' => (int) $comment->comment_parent,
'author' => (int) $comment->user_id, if ( in_array( 'id', $fields, true ) ) {
'author_name' => $comment->comment_author, $data['id'] = (int) $comment->comment_ID;
'author_email' => $comment->comment_author_email, }
'author_url' => $comment->comment_author_url,
'author_ip' => $comment->comment_author_IP, if ( in_array( 'post', $fields, true ) ) {
'author_user_agent' => $comment->comment_agent, $data['post'] = (int) $comment->comment_post_ID;
'date' => mysql_to_rfc3339( $comment->comment_date ), }
'date_gmt' => mysql_to_rfc3339( $comment->comment_date_gmt ),
'content' => array( if ( in_array( 'parent', $fields, true ) ) {
$data['parent'] = (int) $comment->comment_parent;
}
if ( in_array( 'author', $fields, true ) ) {
$data['author'] = (int) $comment->user_id;
}
if ( in_array( 'author_name', $fields, true ) ) {
$data['author_name'] = $comment->comment_author;
}
if ( in_array( 'author_email', $fields, true ) ) {
$data['author_email'] = $comment->comment_author_email;
}
if ( in_array( 'author_url', $fields, true ) ) {
$data['author_url'] = $comment->comment_author_url;
}
if ( in_array( 'author_ip', $fields, true ) ) {
$data['author_ip'] = $comment->comment_author_IP;
}
if ( in_array( 'author_user_agent', $fields, true ) ) {
$data['author_user_agent'] = $comment->comment_agent;
}
if ( in_array( 'date', $fields, true ) ) {
$data['date'] = mysql_to_rfc3339( $comment->comment_date );
}
if ( in_array( 'date_gmt', $fields, true ) ) {
$data['date_gmt'] = mysql_to_rfc3339( $comment->comment_date_gmt );
}
if ( in_array( 'content', $fields, true ) ) {
$data['content'] = array(
/** This filter is documented in wp-includes/comment-template.php */ /** This filter is documented in wp-includes/comment-template.php */
'rendered' => apply_filters( 'comment_text', $comment->comment_content, $comment ), 'rendered' => apply_filters( 'comment_text', $comment->comment_content, $comment ),
'raw' => $comment->comment_content, 'raw' => $comment->comment_content,
), );
'link' => get_comment_link( $comment ), }
'status' => $this->prepare_status_response( $comment->comment_approved ),
'type' => get_comment_type( $comment->comment_ID ),
);
$schema = $this->get_item_schema(); if ( in_array( 'link', $fields, true ) ) {
$data['link'] = get_comment_link( $comment );
}
if ( ! empty( $schema['properties']['author_avatar_urls'] ) ) { if ( in_array( 'status', $fields, true ) ) {
$data['status'] = $this->prepare_status_response( $comment->comment_approved );
}
if ( in_array( 'type', $fields, true ) ) {
$data['type'] = get_comment_type( $comment->comment_ID );
}
if ( in_array( 'author_avatar_urls', $fields, true ) ) {
$data['author_avatar_urls'] = rest_get_avatar_urls( $comment->comment_author_email ); $data['author_avatar_urls'] = rest_get_avatar_urls( $comment->comment_author_email );
} }
if ( ! empty( $schema['properties']['meta'] ) ) { if ( in_array( 'meta', $fields, true ) ) {
$data['meta'] = $this->meta->get_value( $comment->comment_ID, $request ); $data['meta'] = $this->meta->get_value( $comment->comment_ID, $request );
} }

View File

@ -505,6 +505,35 @@ abstract class WP_REST_Controller {
return $schema['title']; return $schema['title'];
} }
/**
* Gets an array of fields to be included on the response.
*
* Included fields are based on item schema and `_fields=` request argument.
*
* @since 4.9.6
*
* @param WP_REST_Request $request Full details about the request.
* @return array Fields to be included in the response.
*/
public function get_fields_for_response( $request ) {
$schema = $this->get_item_schema();
$fields = isset( $schema['properties'] ) ? array_keys( $schema['properties'] ) : array();
if ( ! isset( $request['_fields'] ) ) {
return $fields;
}
$requested_fields = is_array( $request['_fields'] ) ? $request['_fields'] : preg_split( '/[\s,]+/', $request['_fields'] );
if ( 0 === count( $requested_fields ) ) {
return $fields;
}
// Trim off outside whitespace from the comma delimited list.
$requested_fields = array_map( 'trim', $requested_fields );
// Always persist 'id', because it can be needed for add_additional_fields_to_object().
if ( in_array( 'id', $fields, true ) ) {
$requested_fields[] = 'id';
}
return array_intersect( $fields, $requested_fields );
}
/** /**
* Retrieves an array of endpoint arguments from the item schema for the controller. * Retrieves an array of endpoint arguments from the item schema for the controller.
* *

View File

@ -195,15 +195,36 @@ class WP_REST_Post_Statuses_Controller extends WP_REST_Controller {
*/ */
public function prepare_item_for_response( $status, $request ) { public function prepare_item_for_response( $status, $request ) {
$data = array( $fields = $this->get_fields_for_response( $request );
'name' => $status->label, $data = array();
'private' => (bool) $status->private,
'protected' => (bool) $status->protected, if ( in_array( 'name', $fields, true ) ) {
'public' => (bool) $status->public, $data['name'] = $status->label;
'queryable' => (bool) $status->publicly_queryable, }
'show_in_list' => (bool) $status->show_in_admin_all_list,
'slug' => $status->name, if ( in_array( 'private', $fields, true ) ) {
); $data['private'] = (bool) $status->private;
}
if ( in_array( 'protected', $fields, true ) ) {
$data['protected'] = (bool) $status->protected;
}
if ( in_array( 'public', $fields, true ) ) {
$data['public'] = (bool) $status->public;
}
if ( in_array( 'queryable', $fields, true ) ) {
$data['queryable'] = (bool) $status->publicly_queryable;
}
if ( in_array( 'show_in_list', $fields, true ) ) {
$data['show_in_list'] = (bool) $status->show_in_admin_all_list;
}
if ( in_array( 'slug', $fields, true ) ) {
$data['slug'] = $status->name;
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->add_additional_fields_to_object( $data, $request );

View File

@ -151,18 +151,49 @@ class WP_REST_Post_Types_Controller extends WP_REST_Controller {
$base = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name; $base = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name;
$supports = get_all_post_type_supports( $post_type->name ); $supports = get_all_post_type_supports( $post_type->name );
$data = array( $fields = $this->get_fields_for_response( $request );
'capabilities' => $post_type->cap, $data = array();
'description' => $post_type->description,
'hierarchical' => $post_type->hierarchical, if ( in_array( 'capabilities', $fields, true ) ) {
'viewable' => is_post_type_viewable( $post_type ), $data['capabilities'] = $post_type->cap;
'labels' => $post_type->labels, }
'name' => $post_type->label,
'slug' => $post_type->name, if ( in_array( 'description', $fields, true ) ) {
'supports' => $supports, $data['description'] = $post_type->description;
'taxonomies' => array_values( $taxonomies ), }
'rest_base' => $base,
); if ( in_array( 'hierarchical', $fields, true ) ) {
$data['hierarchical'] = $post_type->hierarchical;
}
if ( in_array( 'viewable', $fields, true ) ) {
$data['viewable'] = is_post_type_viewable( $post_type );
}
if ( in_array( 'labels', $fields, true ) ) {
$data['labels'] = $post_type->labels;
}
if ( in_array( 'name', $fields, true ) ) {
$data['name'] = $post_type->label;
}
if ( in_array( 'slug', $fields, true ) ) {
$data['slug'] = $post_type->name;
}
if ( in_array( 'supports', $fields, true ) ) {
$data['supports'] = $supports;
}
if ( in_array( 'taxonomies', $fields, true ) ) {
$data['taxonomies'] = array_values( $taxonomies );
}
if ( in_array( 'rest_base', $fields, true ) ) {
$data['rest_base'] = $base;
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context ); $data = $this->filter_response_by_context( $data, $context );

View File

@ -1400,20 +1400,20 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
setup_postdata( $post ); setup_postdata( $post );
$schema = $this->get_item_schema(); $fields = $this->get_fields_for_response( $request );
// Base fields for every post. // Base fields for every post.
$data = array(); $data = array();
if ( ! empty( $schema['properties']['id'] ) ) { if ( in_array( 'id', $fields, true ) ) {
$data['id'] = $post->ID; $data['id'] = $post->ID;
} }
if ( ! empty( $schema['properties']['date'] ) ) { if ( in_array( 'date', $fields, true ) ) {
$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date ); $data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );
} }
if ( ! empty( $schema['properties']['date_gmt'] ) ) { if ( in_array( 'date_gmt', $fields, true ) ) {
// For drafts, `post_date_gmt` may not be set, indicating that the // For drafts, `post_date_gmt` may not be set, indicating that the
// date of the draft should be updated each time it is saved (see // date of the draft should be updated each time it is saved (see
// #38883). In this case, shim the value based on the `post_date` // #38883). In this case, shim the value based on the `post_date`
@ -1426,7 +1426,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
$data['date_gmt'] = $this->prepare_date_response( $post_date_gmt ); $data['date_gmt'] = $this->prepare_date_response( $post_date_gmt );
} }
if ( ! empty( $schema['properties']['guid'] ) ) { if ( in_array( 'guid', $fields, true ) ) {
$data['guid'] = array( $data['guid'] = array(
/** This filter is documented in wp-includes/post-template.php */ /** This filter is documented in wp-includes/post-template.php */
'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ), 'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ),
@ -1434,11 +1434,11 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
); );
} }
if ( ! empty( $schema['properties']['modified'] ) ) { if ( in_array( 'modified', $fields, true ) ) {
$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified ); $data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );
} }
if ( ! empty( $schema['properties']['modified_gmt'] ) ) { if ( in_array( 'modified_gmt', $fields, true ) ) {
// For drafts, `post_modified_gmt` may not be set (see // For drafts, `post_modified_gmt` may not be set (see
// `post_date_gmt` comments above). In this case, shim the value // `post_date_gmt` comments above). In this case, shim the value
// based on the `post_modified` field with the site's timezone // based on the `post_modified` field with the site's timezone
@ -1451,27 +1451,27 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
$data['modified_gmt'] = $this->prepare_date_response( $post_modified_gmt ); $data['modified_gmt'] = $this->prepare_date_response( $post_modified_gmt );
} }
if ( ! empty( $schema['properties']['password'] ) ) { if ( in_array( 'password', $fields, true ) ) {
$data['password'] = $post->post_password; $data['password'] = $post->post_password;
} }
if ( ! empty( $schema['properties']['slug'] ) ) { if ( in_array( 'slug', $fields, true ) ) {
$data['slug'] = $post->post_name; $data['slug'] = $post->post_name;
} }
if ( ! empty( $schema['properties']['status'] ) ) { if ( in_array( 'status', $fields, true ) ) {
$data['status'] = $post->post_status; $data['status'] = $post->post_status;
} }
if ( ! empty( $schema['properties']['type'] ) ) { if ( in_array( 'type', $fields, true ) ) {
$data['type'] = $post->post_type; $data['type'] = $post->post_type;
} }
if ( ! empty( $schema['properties']['link'] ) ) { if ( in_array( 'link', $fields, true ) ) {
$data['link'] = get_permalink( $post->ID ); $data['link'] = get_permalink( $post->ID );
} }
if ( ! empty( $schema['properties']['title'] ) ) { if ( in_array( 'title', $fields, true ) ) {
add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) ); add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
$data['title'] = array( $data['title'] = array(
@ -1491,7 +1491,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
$has_password_filter = true; $has_password_filter = true;
} }
if ( ! empty( $schema['properties']['content'] ) ) { if ( in_array( 'content', $fields, true ) ) {
$data['content'] = array( $data['content'] = array(
'raw' => $post->post_content, 'raw' => $post->post_content,
/** This filter is documented in wp-includes/post-template.php */ /** This filter is documented in wp-includes/post-template.php */
@ -1500,7 +1500,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
); );
} }
if ( ! empty( $schema['properties']['excerpt'] ) ) { if ( in_array( 'excerpt', $fields, true ) ) {
/** This filter is documented in wp-includes/post-template.php */ /** This filter is documented in wp-includes/post-template.php */
$excerpt = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) ); $excerpt = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) );
$data['excerpt'] = array( $data['excerpt'] = array(
@ -1515,35 +1515,35 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
remove_filter( 'post_password_required', '__return_false' ); remove_filter( 'post_password_required', '__return_false' );
} }
if ( ! empty( $schema['properties']['author'] ) ) { if ( in_array( 'author', $fields, true ) ) {
$data['author'] = (int) $post->post_author; $data['author'] = (int) $post->post_author;
} }
if ( ! empty( $schema['properties']['featured_media'] ) ) { if ( in_array( 'featured_media', $fields, true ) ) {
$data['featured_media'] = (int) get_post_thumbnail_id( $post->ID ); $data['featured_media'] = (int) get_post_thumbnail_id( $post->ID );
} }
if ( ! empty( $schema['properties']['parent'] ) ) { if ( in_array( 'parent', $fields, true ) ) {
$data['parent'] = (int) $post->post_parent; $data['parent'] = (int) $post->post_parent;
} }
if ( ! empty( $schema['properties']['menu_order'] ) ) { if ( in_array( 'menu_order', $fields, true ) ) {
$data['menu_order'] = (int) $post->menu_order; $data['menu_order'] = (int) $post->menu_order;
} }
if ( ! empty( $schema['properties']['comment_status'] ) ) { if ( in_array( 'comment_status', $fields, true ) ) {
$data['comment_status'] = $post->comment_status; $data['comment_status'] = $post->comment_status;
} }
if ( ! empty( $schema['properties']['ping_status'] ) ) { if ( in_array( 'ping_status', $fields, true ) ) {
$data['ping_status'] = $post->ping_status; $data['ping_status'] = $post->ping_status;
} }
if ( ! empty( $schema['properties']['sticky'] ) ) { if ( in_array( 'sticky', $fields, true ) ) {
$data['sticky'] = is_sticky( $post->ID ); $data['sticky'] = is_sticky( $post->ID );
} }
if ( ! empty( $schema['properties']['template'] ) ) { if ( in_array( 'template', $fields, true ) ) {
if ( $template = get_page_template_slug( $post->ID ) ) { if ( $template = get_page_template_slug( $post->ID ) ) {
$data['template'] = $template; $data['template'] = $template;
} else { } else {
@ -1551,7 +1551,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
} }
} }
if ( ! empty( $schema['properties']['format'] ) ) { if ( in_array( 'format', $fields, true ) ) {
$data['format'] = get_post_format( $post->ID ); $data['format'] = get_post_format( $post->ID );
// Fill in blank post format. // Fill in blank post format.
@ -1560,7 +1560,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
} }
} }
if ( ! empty( $schema['properties']['meta'] ) ) { if ( in_array( 'meta', $fields, true ) ) {
$data['meta'] = $this->meta->get_value( $post->ID, $request ); $data['meta'] = $this->meta->get_value( $post->ID, $request );
} }
@ -1569,7 +1569,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
foreach ( $taxonomies as $taxonomy ) { foreach ( $taxonomies as $taxonomy ) {
$base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name; $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
if ( ! empty( $schema['properties'][ $base ] ) ) { if ( in_array( $base, $fields, true ) ) {
$terms = get_the_terms( $post, $taxonomy->name ); $terms = get_the_terms( $post, $taxonomy->name );
$data[ $base ] = $terms ? array_values( wp_list_pluck( $terms, 'term_id' ) ) : array(); $data[ $base ] = $terms ? array_values( wp_list_pluck( $terms, 'term_id' ) ) : array();
} }

View File

@ -331,43 +331,42 @@ class WP_REST_Revisions_Controller extends WP_REST_Controller {
setup_postdata( $post ); setup_postdata( $post );
$schema = $this->get_item_schema(); $fields = $this->get_fields_for_response( $request );
$data = array();
$data = array(); if ( in_array( 'author', $fields, true ) ) {
if ( ! empty( $schema['properties']['author'] ) ) {
$data['author'] = (int) $post->post_author; $data['author'] = (int) $post->post_author;
} }
if ( ! empty( $schema['properties']['date'] ) ) { if ( in_array( 'date', $fields, true ) ) {
$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date ); $data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );
} }
if ( ! empty( $schema['properties']['date_gmt'] ) ) { if ( in_array( 'date_gmt', $fields, true ) ) {
$data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt ); $data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt );
} }
if ( ! empty( $schema['properties']['id'] ) ) { if ( in_array( 'id', $fields, true ) ) {
$data['id'] = $post->ID; $data['id'] = $post->ID;
} }
if ( ! empty( $schema['properties']['modified'] ) ) { if ( in_array( 'modified', $fields, true ) ) {
$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified ); $data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );
} }
if ( ! empty( $schema['properties']['modified_gmt'] ) ) { if ( in_array( 'modified_gmt', $fields, true ) ) {
$data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt ); $data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt );
} }
if ( ! empty( $schema['properties']['parent'] ) ) { if ( in_array( 'parent', $fields, true ) ) {
$data['parent'] = (int) $post->post_parent; $data['parent'] = (int) $post->post_parent;
} }
if ( ! empty( $schema['properties']['slug'] ) ) { if ( in_array( 'slug', $fields, true ) ) {
$data['slug'] = $post->post_name; $data['slug'] = $post->post_name;
} }
if ( ! empty( $schema['properties']['guid'] ) ) { if ( in_array( 'guid', $fields, true ) ) {
$data['guid'] = array( $data['guid'] = array(
/** This filter is documented in wp-includes/post-template.php */ /** This filter is documented in wp-includes/post-template.php */
'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ), 'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ),
@ -375,14 +374,14 @@ class WP_REST_Revisions_Controller extends WP_REST_Controller {
); );
} }
if ( ! empty( $schema['properties']['title'] ) ) { if ( in_array( 'title', $fields, true ) ) {
$data['title'] = array( $data['title'] = array(
'raw' => $post->post_title, 'raw' => $post->post_title,
'rendered' => get_the_title( $post->ID ), 'rendered' => get_the_title( $post->ID ),
); );
} }
if ( ! empty( $schema['properties']['content'] ) ) { if ( in_array( 'content', $fields, true ) ) {
$data['content'] = array( $data['content'] = array(
'raw' => $post->post_content, 'raw' => $post->post_content,
@ -391,7 +390,7 @@ class WP_REST_Revisions_Controller extends WP_REST_Controller {
); );
} }
if ( ! empty( $schema['properties']['excerpt'] ) ) { if ( in_array( 'excerpt', $fields, true ) ) {
$data['excerpt'] = array( $data['excerpt'] = array(
'raw' => $post->post_excerpt, 'raw' => $post->post_excerpt,
'rendered' => $this->prepare_excerpt_response( $post->post_excerpt, $post ), 'rendered' => $this->prepare_excerpt_response( $post->post_excerpt, $post ),

View File

@ -177,17 +177,56 @@ class WP_REST_Taxonomies_Controller extends WP_REST_Controller {
*/ */
public function prepare_item_for_response( $taxonomy, $request ) { public function prepare_item_for_response( $taxonomy, $request ) {
$base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name; $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
$data = array(
'name' => $taxonomy->label, $fields = $this->get_fields_for_response( $request );
'slug' => $taxonomy->name, $data = array();
'capabilities' => $taxonomy->cap,
'description' => $taxonomy->description, if ( in_array( 'name', $fields, true ) ) {
'labels' => $taxonomy->labels, $data['name'] = $taxonomy->label;
'types' => $taxonomy->object_type, }
'show_cloud' => $taxonomy->show_tagcloud,
'hierarchical' => $taxonomy->hierarchical, if ( in_array( 'slug', $fields, true ) ) {
'rest_base' => $base, $data['slug'] = $taxonomy->name;
); }
if ( in_array( 'capabilities', $fields, true ) ) {
$data['capabilities'] = $taxonomy->cap;
}
if ( in_array( 'description', $fields, true ) ) {
$data['description'] = $taxonomy->description;
}
if ( in_array( 'labels', $fields, true ) ) {
$data['labels'] = $taxonomy->labels;
}
if ( in_array( 'types', $fields, true ) ) {
$data['types'] = $taxonomy->object_type;
}
if ( in_array( 'show_cloud', $fields, true ) ) {
$data['show_cloud'] = $taxonomy->show_tagcloud;
}
if ( in_array( 'hierarchical', $fields, true ) ) {
$data['hierarchical'] = $taxonomy->hierarchical;
}
if ( in_array( 'rest_base', $fields, true ) ) {
$data['rest_base'] = $base;
}
if ( in_array( 'visibility', $fields, true ) ) {
$data['visibility'] = array(
'public' => (bool) $taxonomy->public,
'publicly_queryable' => (bool) $taxonomy->publicly_queryable,
'show_admin_column' => (bool) $taxonomy->show_admin_column,
'show_in_nav_menus' => (bool) $taxonomy->show_in_nav_menus,
'show_in_quick_edit' => (bool) $taxonomy->show_in_quick_edit,
'show_ui' => (bool) $taxonomy->show_ui,
);
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view'; $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request ); $data = $this->add_additional_fields_to_object( $data, $request );

View File

@ -685,42 +685,42 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*/ */
public function prepare_item_for_response( $item, $request ) { public function prepare_item_for_response( $item, $request ) {
$schema = $this->get_item_schema(); $fields = $this->get_fields_for_response( $request );
$data = array(); $data = array();
if ( ! empty( $schema['properties']['id'] ) ) { if ( in_array( 'id', $fields, true ) ) {
$data['id'] = (int) $item->term_id; $data['id'] = (int) $item->term_id;
} }
if ( ! empty( $schema['properties']['count'] ) ) { if ( in_array( 'count', $fields, true ) ) {
$data['count'] = (int) $item->count; $data['count'] = (int) $item->count;
} }
if ( ! empty( $schema['properties']['description'] ) ) { if ( in_array( 'description', $fields, true ) ) {
$data['description'] = $item->description; $data['description'] = $item->description;
} }
if ( ! empty( $schema['properties']['link'] ) ) { if ( in_array( 'link', $fields, true ) ) {
$data['link'] = get_term_link( $item ); $data['link'] = get_term_link( $item );
} }
if ( ! empty( $schema['properties']['name'] ) ) { if ( in_array( 'name', $fields, true ) ) {
$data['name'] = $item->name; $data['name'] = $item->name;
} }
if ( ! empty( $schema['properties']['slug'] ) ) { if ( in_array( 'slug', $fields, true ) ) {
$data['slug'] = $item->slug; $data['slug'] = $item->slug;
} }
if ( ! empty( $schema['properties']['taxonomy'] ) ) { if ( in_array( 'taxonomy', $fields, true ) ) {
$data['taxonomy'] = $item->taxonomy; $data['taxonomy'] = $item->taxonomy;
} }
if ( ! empty( $schema['properties']['parent'] ) ) { if ( in_array( 'parent', $fields, true ) ) {
$data['parent'] = (int) $item->parent; $data['parent'] = (int) $item->parent;
} }
if ( ! empty( $schema['properties']['meta'] ) ) { if ( in_array( 'meta', $fields, true ) ) {
$data['meta'] = $this->meta->get_value( $item->term_id, $request ); $data['meta'] = $this->meta->get_value( $item->term_id, $request );
} }

View File

@ -837,78 +837,78 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
public function prepare_item_for_response( $user, $request ) { public function prepare_item_for_response( $user, $request ) {
$data = array(); $data = array();
$schema = $this->get_item_schema(); $fields = $this->get_fields_for_response( $request );
if ( ! empty( $schema['properties']['id'] ) ) { if ( in_array( 'id', $fields, true ) ) {
$data['id'] = $user->ID; $data['id'] = $user->ID;
} }
if ( ! empty( $schema['properties']['username'] ) ) { if ( in_array( 'username', $fields, true ) ) {
$data['username'] = $user->user_login; $data['username'] = $user->user_login;
} }
if ( ! empty( $schema['properties']['name'] ) ) { if ( in_array( 'name', $fields, true ) ) {
$data['name'] = $user->display_name; $data['name'] = $user->display_name;
} }
if ( ! empty( $schema['properties']['first_name'] ) ) { if ( in_array( 'first_name', $fields, true ) ) {
$data['first_name'] = $user->first_name; $data['first_name'] = $user->first_name;
} }
if ( ! empty( $schema['properties']['last_name'] ) ) { if ( in_array( 'last_name', $fields, true ) ) {
$data['last_name'] = $user->last_name; $data['last_name'] = $user->last_name;
} }
if ( ! empty( $schema['properties']['email'] ) ) { if ( in_array( 'email', $fields, true ) ) {
$data['email'] = $user->user_email; $data['email'] = $user->user_email;
} }
if ( ! empty( $schema['properties']['url'] ) ) { if ( in_array( 'url', $fields, true ) ) {
$data['url'] = $user->user_url; $data['url'] = $user->user_url;
} }
if ( ! empty( $schema['properties']['description'] ) ) { if ( in_array( 'description', $fields, true ) ) {
$data['description'] = $user->description; $data['description'] = $user->description;
} }
if ( ! empty( $schema['properties']['link'] ) ) { if ( in_array( 'link', $fields, true ) ) {
$data['link'] = get_author_posts_url( $user->ID, $user->user_nicename ); $data['link'] = get_author_posts_url( $user->ID, $user->user_nicename );
} }
if ( ! empty( $schema['properties']['locale'] ) ) { if ( in_array( 'locale', $fields, true ) ) {
$data['locale'] = get_user_locale( $user ); $data['locale'] = get_user_locale( $user );
} }
if ( ! empty( $schema['properties']['nickname'] ) ) { if ( in_array( 'nickname', $fields, true ) ) {
$data['nickname'] = $user->nickname; $data['nickname'] = $user->nickname;
} }
if ( ! empty( $schema['properties']['slug'] ) ) { if ( in_array( 'slug', $fields, true ) ) {
$data['slug'] = $user->user_nicename; $data['slug'] = $user->user_nicename;
} }
if ( ! empty( $schema['properties']['roles'] ) ) { if ( in_array( 'roles', $fields, true ) ) {
// Defensively call array_values() to ensure an array is returned. // Defensively call array_values() to ensure an array is returned.
$data['roles'] = array_values( $user->roles ); $data['roles'] = array_values( $user->roles );
} }
if ( ! empty( $schema['properties']['registered_date'] ) ) { if ( in_array( 'registered_date', $fields, true ) ) {
$data['registered_date'] = date( 'c', strtotime( $user->user_registered ) ); $data['registered_date'] = date( 'c', strtotime( $user->user_registered ) );
} }
if ( ! empty( $schema['properties']['capabilities'] ) ) { if ( in_array( 'capabilities', $fields, true ) ) {
$data['capabilities'] = (object) $user->allcaps; $data['capabilities'] = (object) $user->allcaps;
} }
if ( ! empty( $schema['properties']['extra_capabilities'] ) ) { if ( in_array( 'extra_capabilities', $fields, true ) ) {
$data['extra_capabilities'] = (object) $user->caps; $data['extra_capabilities'] = (object) $user->caps;
} }
if ( ! empty( $schema['properties']['avatar_urls'] ) ) { if ( in_array( 'avatar_urls', $fields, true ) ) {
$data['avatar_urls'] = rest_get_avatar_urls( $user->user_email ); $data['avatar_urls'] = rest_get_avatar_urls( $user->user_email );
} }
if ( ! empty( $schema['properties']['meta'] ) ) { if ( in_array( 'meta', $fields, true ) ) {
$data['meta'] = $this->meta->get_value( $user->ID, $request ); $data['meta'] = $this->meta->get_value( $user->ID, $request );
} }

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9.8-alpha-43444'; $wp_version = '4.9.8-alpha-43445';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.