Changeset 39097

Timestamp:

11/02/2016 09:50:08 PM (8 years ago)

Author:

joehoyle

Message:

REST API: Include taxonomies as an attribute of post types.

Add the taxonomies for a post type to the /wp/v2/types endpoint, so clients know which taxonomies are available for which post types.

Props danielbachhuber.
Fixes #38438, #38631.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-post-types-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-post-types-controller.php (modified) (4 diffs)

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

@@ -147 +147 @@
      */
     public function prepare_item_for_response( $post_type, $request ) {
+        $taxonomies = wp_list_filter( get_object_taxonomies( $post_type->name, 'objects' ), array( 'show_in_rest' => true ) );
+        $taxonomies = wp_list_pluck( $taxonomies, 'name' );
         $data = array(
             'capabilities' => $post_type->cap,
@@ -154 +156 @@
             'name'         => $post_type->label,
             'slug'         => $post_type->name,
+            'taxonomies'   => array_values( $taxonomies ),
         );
         $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
@@ -204 +207 @@
                     'description'  => __( 'All capabilities used by the resource.' ),
                     'type'         => 'array',
+                    'items'        => array(
+                        'type' => 'string',
+                    ),
                     'context'      => array( 'edit' ),
                     'readonly'     => true,
@@ -237 +243 @@
                     'readonly'     => true,
                 ),
+                'taxonomies'       => array(
+                    'description'  => __( 'Taxonomies associated with resource.' ),
+                    'type'         => 'array',
+                    'items'        => array(
+                        'type' => 'string',
+                    ),
+                    'context'      => array( 'view', 'edit' ),
+                    'readonly'     => true,
+                ),
             ),
         );

trunk/tests/phpunit/tests/rest-api/rest-post-types-controller.php

@@ -59 +59 @@
         $response = $this->server->dispatch( $request );
         $this->check_post_type_object_response( 'view', $response );
+        $data = $response->get_data();
+        $this->assertEquals( array( 'category', 'post_tag' ), $data['taxonomies'] );
+    }
+
+    public function test_get_item_page() {
+        $request = new WP_REST_Request( 'GET', '/wp/v2/types/page' );
+        $response = $this->server->dispatch( $request );
+        $this->check_post_type_object_response( 'view', $response, 'page' );
+        $data = $response->get_data();
+        $this->assertEquals( array(), $data['taxonomies'] );
     }
 
@@ -110 +120 @@
         $data = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 6, count( $properties ) );
+        $this->assertEquals( 7, count( $properties ) );
         $this->assertArrayHasKey( 'capabilities', $properties );
         $this->assertArrayHasKey( 'description', $properties );
@@ -117 +127 @@
         $this->assertArrayHasKey( 'name', $properties );
         $this->assertArrayHasKey( 'slug', $properties );
+        $this->assertArrayHasKey( 'taxonomies', $properties );
     }
 
@@ -173 +184 @@
     }
 
-    protected function check_post_type_object_response( $context, $response ) {
+    protected function check_post_type_object_response( $context, $response, $post_type = 'post' ) {
         $this->assertEquals( 200, $response->get_status() );
         $data = $response->get_data();
-        $obj = get_post_type_object( 'post' );
+        $obj = get_post_type_object( $post_type );
         $this->check_post_type_obj( $context, $obj, $data, $response->get_links() );
     }