Changeset 38968

Timestamp:

10/26/2016 09:36:29 PM (9 years ago)

Author:

rachelbaker

Message:

REST API: Remove experimental filter wrapper parameter from the Posts Controller class.

Hiding WP_Query params under the filter key (instead of allowing them to be top-level params) was one of our biggest complaints from users of v1 of our REST API. This walks back the re-introduction of the filter param during Beta 15, which introduced an "inconsistent mess" and "exposing WP_Query through filter has and will continue to be difficult to support." See ​https://github.com/WP-API/WP-API/issues/2799.

Props websupporter, rachelbaker.
Fixes #38378.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (5 diffs)
• tests/phpunit/tests/rest-api/rest-attachments-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-pages-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-posts-controller.php (modified) (5 diffs)

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

@@ -112 +112 @@
 
         // Make sure a search string is set in case the orderby is set to 'relevance'.
-        if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) && empty( $request['filter']['s'] ) ) {
+        if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {
             return new WP_Error( 'rest_no_search_term_defined', __( 'You need to define a search term to order by relevance.' ), array( 'status' => 400 ) );
         }
@@ -162 +162 @@
         }
 
-        if ( isset( $registered['filter'] ) && is_array( $request['filter'] ) ) {
-            $args = array_merge( $args, $request['filter'] );
-            unset( $args['filter'] );
-        }
-
         // Ensure our per_page parameter overrides any provided posts_per_page filter.
         if ( isset( $registered['per_page'] ) ) {
@@ -270 +265 @@
         }
 
-        $max_pages = ceil( $total_posts / (int) $query_args['posts_per_page'] );
+        $max_pages = ceil( $total_posts / (int) $posts_query->query_vars['posts_per_page'] );
 
         $response = rest_ensure_response( $posts );
@@ -277 +272 @@
 
         $request_params = $request->get_query_params();
-        if ( ! empty( $request_params['filter'] ) ) {
-            // Normalize the pagination params.
-            unset( $request_params['filter']['posts_per_page'], $request_params['filter']['paged'] );
-        }
         $base = add_query_arg( $request_params, rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ) );
 
@@ -1911 +1902 @@
             'validate_callback' => array( $this, 'validate_user_can_query_private_statuses' ),
         );
-        $params['filter'] = array(
-            'description'       => __( 'Use WP Query arguments to modify the response; private query vars require appropriate authorization.' ),
-        );
 
         $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );

trunk/tests/phpunit/tests/rest-api/rest-attachments-controller.php

@@ -125 +125 @@
             'context',
             'exclude',
-            'filter',
             'include',
             'media_type',

trunk/tests/phpunit/tests/rest-api/rest-pages-controller.php

@@ -60 +60 @@
             'context',
             'exclude',
-            'filter',
             'include',
             'menu_order',
@@ -180 +179 @@
         $draft_id = $this->factory->post->create( array( 'post_status' => 'draft', 'post_type' => 'page' ) );
         $request = new WP_REST_Request( 'GET', '/wp/v2/pages' );
-        $request->set_param( 'filter', array( 'post_status' => 'draft' ) );
-        $response = $this->server->dispatch( $request );
-        $data = $response->get_data();
-        $this->assertCount( 1, $data );
-        $this->assertEquals( $page_id, $data[0]['id'] );
+        $request->set_param( 'status', 'draft' );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+
         // But they are accessible to authorized users
         wp_set_current_user( $this->editor_id );

trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php

@@ -68 +68 @@
             'context',
             'exclude',
-            'filter',
             'include',
             'offset',
@@ -98 +97 @@
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
         $request->set_query_params( array(
-            'filter' => array( 'year' => 2008 ),
-        ) );
-        $response = $this->server->dispatch( $request );
-        $this->assertEquals( array(), $response->get_data() );
+            'author' => REST_TESTS_IMPOSSIBLY_HIGH_NUMBER,
+        ) );
+        $response = $this->server->dispatch( $request );
+
+        $this->assertEmpty( $response->get_data() );
         $this->assertEquals( 200, $response->get_status() );
     }
@@ -310 +310 @@
         // Permit stickies
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
-        $request->set_param( 'filter', array( 'ignore_sticky_posts' => false ) );
+        $request->set_param( 'ignore_sticky_posts', false );
         $response = $this->server->dispatch( $request );
         $data = $response->get_data();
@@ -577 +577 @@
     }
 
-    public function test_get_items_private_filter_query_var() {
+    public function test_get_items_private_status_query_var() {
         // Private query vars inaccessible to unauthorized users
         wp_set_current_user( 0 );
         $draft_id = $this->factory->post->create( array( 'post_status' => 'draft' ) );
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
-        $request->set_param( 'filter', array( 'post_status' => 'draft' ) );
-        $response = $this->server->dispatch( $request );
-        $data = $response->get_data();
-        $this->assertCount( 1, $data );
-        $this->assertEquals( $this->post_id, $data[0]['id'] );
+        $request->set_param( 'status', 'draft' );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
+
         // But they are accessible to authorized users
         wp_set_current_user( $this->editor_id );
@@ -600 +599 @@
         $response = $this->server->dispatch( $request );
         $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
-    }
-
-    public function test_get_items_invalid_posts_per_page_ignored() {
-        // This test ensures that filter[posts_per_page] is ignored, and that -1
-        // cannot be used to sidestep per_page's valid range to retrieve all posts
-        for ( $i = 0; $i < 20; $i++ ) {
-            $this->factory->post->create( array( 'post_status' => 'publish' ) );
-        }
-        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
-        $request->set_query_params( array( 'filter' => array( 'posts_per_page' => -1 ) ) );
-        $response = $this->server->dispatch( $request );
-        $this->assertCount( 10, $response->get_data() );
     }