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

Timestamp:

10/26/2016 09:36:29 PM (8 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.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-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 ) );