Changeset 40427

Timestamp:

04/14/2017 08:53:11 AM (7 years ago)

Author:

swissspidy

Message:

REST API: Allow fetching multiple terms at once via the slug parameter.

This matches a similar change previously made for posts (#38579) and an upcoming change for users (#40213).

Props wonderboymusic, MatheusGimenez, curdin.
Fixes #40027.

Merges [40376] to the 4.7 branch.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-tags-controller.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (2 diffs)

branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

@@ -980 +980 @@
         $query_params['slug'] = array(
             'description'       => __( 'Limit result set to terms with a specific slug.' ),
-            'type'              => 'string',
+            'type'              => 'array',
+            'items'             => array(
+                'type'          => 'string'
+            ),
         );
 

branches/4.7/tests/phpunit/tests/rest-api/rest-tags-controller.php

@@ -375 +375 @@
         $this->assertEquals( 1, count( $data ) );
         $this->assertEquals( 'Apple', $data[0]['name'] );
+    }
+
+    public function test_get_items_slug_array_arg() {
+        $id1 = $this->factory->tag->create( array( 'name' => 'Taco' ) );
+        $id2 = $this->factory->tag->create( array( 'name' => 'Enchilada' ) );
+        $id3 = $this->factory->tag->create( array( 'name' => 'Burrito' ) );
+        $this->factory->tag->create( array( 'name' => 'Pizza' ) );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/tags' );
+        $request->set_param( 'slug', array(
+            'taco',
+            'burrito',
+            'enchilada',
+        ) );
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $names = wp_list_pluck( $data, 'name' );
+        sort( $names );
+        $this->assertEquals( array( 'Burrito', 'Enchilada', 'Taco' ), $names );
+    }
+
+    public function test_get_items_slug_csv_arg() {
+        $id1 = $this->factory->tag->create( array( 'name' => 'Taco' ) );
+        $id2 = $this->factory->tag->create( array( 'name' => 'Enchilada' ) );
+        $id3 = $this->factory->tag->create( array( 'name' => 'Burrito' ) );
+        $this->factory->tag->create( array( 'name' => 'Pizza' ) );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/tags' );
+        $request->set_param( 'slug', 'taco,burrito, enchilada');
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $names = wp_list_pluck( $data, 'name' );
+        sort( $names );
+        $this->assertEquals( array( 'Burrito', 'Enchilada', 'Taco' ), $names );
     }
 

branches/4.7/tests/qunit/fixtures/wp-api-generated.js

@@ -1991 +1991 @@
                             "required": false,
                             "description": "Limit result set to terms with a specific slug.",
-                            "type": "string"
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
                         }
                     }
@@ -2226 +2229 @@
                             "required": false,
                             "description": "Limit result set to terms with a specific slug.",
-                            "type": "string"
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
                         }
                     }