Changeset 43087 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Timestamp:

05/02/2018 01:24:30 AM (8 years ago)

Author:

pento

Message:

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.

Props danielbachhuber.
See #43874.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (10 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

@@ -1409 +1409 @@
                 setup_postdata( $post );
 
-                $schema = $this->get_item_schema();
+                $fields = $this->get_fields_for_response( $request );
 
                 // Base fields for every post.
                 $data = array();
 
-                if ( ! empty( $schema['properties']['id'] ) ) {
+                if ( in_array( 'id', $fields, true ) ) {
                         $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 );
                 }
 
-                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
                         // date of the draft should be updated each time it is saved (see
@@ -1435 +1435 @@
                 }
 
-                if ( ! empty( $schema['properties']['guid'] ) ) {
+                if ( in_array( 'guid', $fields, true ) ) {
                         $data['guid'] = array(
                                 /** This filter is documented in wp-includes/post-template.php */
@@ -1443 +1443 @@
                 }
 
-                if ( ! empty( $schema['properties']['modified'] ) ) {
+                if ( in_array( 'modified', $fields, true ) ) {
                         $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
                         // `post_date_gmt` comments above).  In this case, shim the value
@@ -1460 +1460 @@
                 }
 
-                if ( ! empty( $schema['properties']['password'] ) ) {
+                if ( in_array( 'password', $fields, true ) ) {
                         $data['password'] = $post->post_password;
                 }
 
-                if ( ! empty( $schema['properties']['slug'] ) ) {
+                if ( in_array( 'slug', $fields, true ) ) {
                         $data['slug'] = $post->post_name;
                 }
 
-                if ( ! empty( $schema['properties']['status'] ) ) {
+                if ( in_array( 'status', $fields, true ) ) {
                         $data['status'] = $post->post_status;
                 }
 
-                if ( ! empty( $schema['properties']['type'] ) ) {
+                if ( in_array( 'type', $fields, true ) ) {
                         $data['type'] = $post->post_type;
                 }
 
-                if ( ! empty( $schema['properties']['link'] ) ) {
+                if ( in_array( 'link', $fields, true ) ) {
                         $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' ) );
 
@@ -1500 +1500 @@
                 }
 
-                if ( ! empty( $schema['properties']['content'] ) ) {
+                if ( in_array( 'content', $fields, true ) ) {
                         $data['content'] = array(
                                 'raw'       => $post->post_content,
@@ -1509 +1509 @@
                 }
 
-                if ( ! empty( $schema['properties']['excerpt'] ) ) {
+                if ( in_array( 'excerpt', $fields, true ) ) {
                         /** This filter is documented in wp-includes/post-template.php */
                         $excerpt         = apply_filters( 'the_excerpt', apply_filters( 'get_the_excerpt', $post->post_excerpt, $post ) );
@@ -1524 +1524 @@
                 }
 
-                if ( ! empty( $schema['properties']['author'] ) ) {
+                if ( in_array( 'author', $fields, true ) ) {
                         $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 );
                 }
 
-                if ( ! empty( $schema['properties']['parent'] ) ) {
+                if ( in_array( 'parent', $fields, true ) ) {
                         $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;
                 }
 
-                if ( ! empty( $schema['properties']['comment_status'] ) ) {
+                if ( in_array( 'comment_status', $fields, true ) ) {
                         $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;
                 }
 
-                if ( ! empty( $schema['properties']['sticky'] ) ) {
+                if ( in_array( 'sticky', $fields, true ) ) {
                         $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 ) ) {
                                 $data['template'] = $template;
@@ -1560 +1560 @@
                 }
 
-                if ( ! empty( $schema['properties']['format'] ) ) {
+                if ( in_array( 'format', $fields, true ) ) {
                         $data['format'] = get_post_format( $post->ID );
 
@@ -1569 +1569 @@
                 }
 
-                if ( ! empty( $schema['properties']['meta'] ) ) {
+                if ( in_array( 'meta', $fields, true ) ) {
                         $data['meta'] = $this->meta->get_value( $post->ID, $request );
                 }
@@ -1578 +1578 @@
                         $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 );
                                 $data[ $base ] = $terms ? array_values( wp_list_pluck( $terms, 'term_id' ) ) : array();