Move /posts WP_Query vars to filter param

joehoyle · joehoyle · commit 6b31826acf2e · 2015-07-23T16:39:06.000-10:00
Currently, `/wp/v2/posts` allows WP_Query params and a few of our own
"per_page" etc. This is confusing and inconsistant. I think we discussed
a while back that we'd put all the WP_Query (internal) named collection
params under a `filter` param (inspired by v1) and implement
standardized collection params for posts that's inline with the params
for `terms`, `users` and `comments`.
diff --git a/lib/endpoints/class-wp-rest-posts-controller.php b/lib/endpoints/class-wp-rest-posts-controller.php
@@ -27,14 +27,9 @@ public function register_routes() {
 				'default'           => 10,
 				'sanitize_callback' => 'absint',
 			),
+			'filter'                => array(),
 		);
 
-		foreach ( $this->get_allowed_query_vars() as $var ) {
-			if ( ! isset( $posts_args[ $var ] ) ) {
-				$posts_args[ $var ] = array();
-			}
-		}
-
 		register_rest_route( 'wp/v2', '/' . $base, array(
 			array(
 				'methods'         => WP_REST_Server::READABLE,
@@ -89,12 +84,17 @@ public function register_routes() {
 	 * @return WP_Error|WP_REST_Response
 	 */
 	public function get_items( $request ) {
-		$args = (array) $request->get_params();
-		$args['post_type'] = $this->post_type;
-		$args['paged'] = $args['page'];
-		$args['posts_per_page'] = $args['per_page'];
+		$args                   = array();
+		$args['post_type']      = $this->post_type;
+		$args['paged']          = $request['page'];
+		$args['posts_per_page'] = $request['per_page'];
 		unset( $args['page'] );
 
+		if ( isset( $request['filter'] ) ) {
+			$args = array_merge( $args, $request['filter'] );
+			unset( $args['filter'] );
+		}
+
 		/**
 		 * Alter the query arguments for a request.
 		 *
diff --git a/tests/test-rest-posts-controller.php b/tests/test-rest-posts-controller.php
@@ -50,11 +50,9 @@ public function test_get_items() {
 	public function test_get_items_empty_query() {
 		$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
 		$request->set_query_params( array(
-			'type'           => 'post',
-			'year'           => 2008,
+			'filter' => array( 'year' => 2008 ),
 		) );
 		$response = $this->server->dispatch( $request );
-
 		$this->assertEquals( array(), $response->get_data() );
 		$this->assertEquals( 200, $response->get_status() );
 	}
