Changeset 39093

Timestamp:

11/02/2016 07:13:24 AM (8 years ago)

Author:

rmccue

Message:

REST API: Allow querying for multiple slug values.

Props jnylen0, rachelbaker.
Fixes #38579.

Location:

trunk

Files:

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

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

@@ -170 +170 @@
             'parent_exclude' => 'post_parent__not_in',
             'search'         => 's',
-            'slug'           => 'name',
+            'slug'           => 'post_name__in',
             'status'         => 'post_status',
         );
@@ -883 +883 @@
             'posts_per_page',
             'date_query',
+            'post_name__in',
         );
 
@@ -2113 +2114 @@
 
         $params['slug'] = array(
-            'description'       => __( 'Limit result set to posts with a specific slug.' ),
-            'type'              => 'string',
-            'validate_callback' => 'rest_validate_request_arg',
+            'description'       => __( 'Limit result set to posts with one or more specific slugs.' ),
+            'type'              => 'array',
+            'sanitize_callback' => 'wp_parse_slug_list',
         );
 

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

@@ -253 +253 @@
         $this->assertEquals( 1, count( $data ) );
         $this->assertEquals( 'Apple', $data[0]['title']['rendered'] );
+    }
+
+    public function test_get_items_multiple_slugs_array_query() {
+        $this->factory->post->create( array( 'post_title' => 'Apple', 'post_status' => 'publish' ) );
+        $this->factory->post->create( array( 'post_title' => 'Banana', 'post_status' => 'publish' ) );
+        $this->factory->post->create( array( 'post_title' => 'Peach', 'post_status' => 'publish' ) );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'slug', array( 'banana', 'peach' ) );
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $this->assertEquals( 2, count( $data ) );
+        $titles = array(
+            $data[0]['title']['rendered'],
+            $data[1]['title']['rendered'],
+        );
+        sort( $titles );
+        $this->assertEquals( array( 'Banana', 'Peach' ), $titles );
+    }
+
+    public function test_get_items_multiple_slugs_string_query() {
+        $this->factory->post->create( array( 'post_title' => 'Apple', 'post_status' => 'publish' ) );
+        $this->factory->post->create( array( 'post_title' => 'Banana', 'post_status' => 'publish' ) );
+        $this->factory->post->create( array( 'post_title' => 'Peach', 'post_status' => 'publish' ) );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'slug', 'apple,banana' );
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $this->assertEquals( 2, count( $data ) );
+        $titles = array(
+            $data[0]['title']['rendered'],
+            $data[1]['title']['rendered'],
+        );
+        sort( $titles );
+        $this->assertEquals( array( 'Apple', 'Banana' ), $titles );
     }