Changeset 39191

Timestamp:

11/10/2016 02:20:09 AM (8 years ago)

Author:

joehoyle

Message:

REST API: Add rest_base to response objects of wp/v2/taxonomies and wp/v2/types

Though we have the _links.collection available, having this value can be useful to know post type / taxonomy urls if you need to build them another way.

Props youknowriad, jnylen0.
Fixes #38607.

Location:

trunk

Files:

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

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

@@ -149 +149 @@
         $taxonomies = wp_list_filter( get_object_taxonomies( $post_type->name, 'objects' ), array( 'show_in_rest' => true ) );
         $taxonomies = wp_list_pluck( $taxonomies, 'name' );
+        $base = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name;
         $data = array(
             'capabilities' => $post_type->cap,
@@ -157 +158 @@
             'slug'         => $post_type->name,
             'taxonomies'   => array_values( $taxonomies ),
+            'rest_base'    => $base,
         );
         $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
@@ -164 +166 @@
         // Wrap the data in a response object.
         $response = rest_ensure_response( $data );
-
-        $base = ! empty( $post_type->rest_base ) ? $post_type->rest_base : $post_type->name;
 
         $response->add_links( array(
@@ -252 +252 @@
                     'readonly'     => true,
                 ),
+                'rest_base'            => array(
+                    'description'  => __( 'REST base route for the resource.' ),
+                    'type'         => 'string',
+                    'context'      => array( 'view', 'edit', 'embed' ),
+                    'readonly'     => true,
+                ),
             ),
         );

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

@@ -178 +178 @@
      */
     public function prepare_item_for_response( $taxonomy, $request ) {
-
+        $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
         $data = array(
             'name'         => $taxonomy->label,
@@ -188 +188 @@
             'show_cloud'   => $taxonomy->show_tagcloud,
             'hierarchical' => $taxonomy->hierarchical,
+            'rest_base'    => $base,
         );
 
@@ -197 +198 @@
         $response = rest_ensure_response( $data );
 
-        $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
         $response->add_links( array(
             'collection'                => array(
@@ -286 +286 @@
                     'readonly'     => true,
                 ),
+                'rest_base'            => array(
+                    'description'  => __( 'REST base route for the resource.' ),
+                    'type'         => 'string',
+                    'context'      => array( 'view', 'edit', 'embed' ),
+                    'readonly'     => true,
+                ),
             ),
         );

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

@@ -120 +120 @@
         $data = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 7, count( $properties ) );
+        $this->assertEquals( 8, count( $properties ) );
         $this->assertArrayHasKey( 'capabilities', $properties );
         $this->assertArrayHasKey( 'description', $properties );
@@ -128 +128 @@
         $this->assertArrayHasKey( 'slug', $properties );
         $this->assertArrayHasKey( 'taxonomies', $properties );
+        $this->assertArrayHasKey( 'rest_base', $properties );
     }
 
@@ -171 +172 @@
         $this->assertEquals( $post_type_obj->description, $data['description'] );
         $this->assertEquals( $post_type_obj->hierarchical, $data['hierarchical'] );
+        $this->assertEquals( $post_type_obj->rest_base, $data['rest_base'] );
 
         $links = test_rest_expand_compact_links( $links );

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

@@ -46 +46 @@
         $this->assertEquals( 'post_tag', $data['post_tag']['slug'] );
         $this->assertEquals( false, $data['post_tag']['hierarchical'] );
+        $this->assertEquals( 'tags', $data['post_tag']['rest_base'] );
     }
 
@@ -135 +136 @@
         $data = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 8, count( $properties ) );
+        $this->assertEquals( 9, count( $properties ) );
         $this->assertArrayHasKey( 'capabilities', $properties );
         $this->assertArrayHasKey( 'description', $properties );
@@ -144 +145 @@
         $this->assertArrayHasKey( 'show_cloud', $properties );
         $this->assertArrayHasKey( 'types', $properties );
+        $this->assertArrayHasKey( 'rest_base', $properties );
     }
 
@@ -169 +171 @@
         $this->assertEquals( $tax_obj->description, $data['description'] );
         $this->assertEquals( $tax_obj->hierarchical, $data['hierarchical'] );
+        $this->assertEquals( $tax_obj->rest_base, $data['rest_base'] );
         $this->assertEquals( rest_url( 'wp/v2/taxonomies' ), $links['collection'][0]['href'] );
         $this->assertArrayHasKey( 'https://api.w.org/items', $links );