Ticket #38985: 38985.diff

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

@@ -148 +148 @@
                         return new WP_Error( 'rest_no_search_term_defined', __( 'You need to define a search term to order by relevance.' ), array( 'status' => 400 ) );
                 }
 
+                // Ensure an include parameter is set in case the orderby is set to 'include'.
+                if ( ! empty( $request['orderby'] ) && 'include' === $request['orderby'] && empty( $request['include'] ) ) {
+                        return new WP_Error( 'rest_no_include_param_defined', __( 'You need to define an include parameter to order by include.' ), array( 'status' => 400 ) );
+                }
+
                 // Retrieve the list of registered collection query parameters.
                 $registered = $this->get_collection_params();
                 $args = array();
@@ -836 +841 @@
                         $query_args['ignore_sticky_posts'] = true;
                 }
 
+                // Map to proper WP_Query orderby param.
                 if ( 'include' === $query_args['orderby'] ) {
                         $query_args['orderby'] = 'post__in';
                 }
 
+                // Map to proper WP_Query orderby param.
+                if ( 'id' === $query_args['orderby'] ) {
+                        $query_args['orderby'] = 'ID';
+                }
+
+                // Map to proper WP_Query orderby param.
+                if ( 'slug' === $query_args['orderby'] ) {
+                        $query_args['orderby'] = 'post_name';
+                }
+
                 return $query_args;
         }
 

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

@@ -444 +444 @@
                 $this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
         }
 
+        public function test_get_items_with_orderby_include_without_include_param() {
+                $this->factory->post->create( array( 'post_status' => 'publish' ) );
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'orderby', 'include' );
+
+                $response = $this->server->dispatch( $request );
+
+                $this->assertErrorResponse( 'rest_no_include_param_defined', $response, 400 );
+        }
+
+        public function test_get_items_with_orderby_id() {
+                $id1 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_date' => '2016-01-13 02:26:48' ) );
+                $id2 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_date' => '2016-01-12 02:26:48' ) );
+                $id3 = $this->factory->post->create( array( 'post_status' => 'publish', 'post_date' => '2016-01-11 02:26:48' ) );
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'orderby', 'id' );
+                $request->set_param( 'include', array( $id1, $id2, $id3 ) );
+
+                $response = $this->server->dispatch( $request );
+                $data = $response->get_data();
+
+                // Default ORDER is DESC.
+                $this->assertEquals( $id3, $data[0]['id'] );
+                $this->assertEquals( $id2, $data[1]['id'] );
+                $this->assertEquals( $id1, $data[2]['id'] );
+        }
+
+        public function test_get_items_with_orderby_slug() {
+                $id1 = $this->factory->post->create( array( 'post_title' => 'ABC', 'post_name' => 'xyz', 'post_status' => 'publish' ) );
+                $id2 = $this->factory->post->create( array( 'post_title' => 'XYZ', 'post_name' => 'abc', 'post_status' => 'publish' ) );
+
+                $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+                $request->set_param( 'orderby', 'slug' );
+                $request->set_param( 'include', array( $id1, $id2 ) );
+
+                $response = $this->server->dispatch( $request );
+                $data = $response->get_data();
+
+                // Default ORDER is DESC.
+                $this->assertEquals( 'xyz', $data[0]['slug'] );
+                $this->assertEquals( 'abc', $data[1]['slug'] );
+        }
+
         public function test_get_items_with_orderby_relevance() {
                 $this->factory->post->create( array( 'post_title' => 'Title is more relevant', 'post_content' => 'Content is', 'post_status' => 'publish' ) );
                 $this->factory->post->create( array( 'post_title' => 'Title is', 'post_content' => 'Content is less relevant', 'post_status' => 'publish' ) );