Changeset 39182

Timestamp:

11/09/2016 07:12:01 AM (8 years ago)

Author:

rmccue

Message:

REST API: Include template in all post type schemas.

[38951] added templates to all post types, but didn't add them to the schema.

Props swissspidy.
Fixes #38698.

Location:

trunk

Files:

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

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

@@ -1095 +1095 @@
 
     /**
-     * Sets the template for a page.
+     * Sets the template for a post.
      *
      * @since 4.7.0
@@ -1923 +1923 @@
         }
 
-        if ( 'page' === $this->post_type ) {
-            $schema['properties']['template'] = array(
-                'description' => __( 'The theme file to use to display the object.' ),
-                'type'        => 'string',
-                'enum'        => array_keys( wp_get_theme()->get_page_templates() ),
-                'context'     => array( 'view', 'edit' ),
-            );
-        }
+        $schema['properties']['template'] = array(
+            'description' => __( 'The theme file to use to display the object.' ),
+            'type'        => 'string',
+            'enum'        => array_keys( wp_get_theme()->get_page_templates( null, $this->post_type ) ),
+            'context'     => array( 'view', 'edit' ),
+        );
 
         $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );

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

@@ -1042 +1042 @@
         $data = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 23, count( $properties ) );
+        $this->assertEquals( 24, count( $properties ) );
         $this->assertArrayHasKey( 'author', $properties );
         $this->assertArrayHasKey( 'alt_text', $properties );
@@ -1068 +1068 @@
         $this->assertArrayHasKey( 'slug', $properties );
         $this->assertArrayHasKey( 'source_url', $properties );
+        $this->assertArrayHasKey( 'template', $properties );
         $this->assertArrayHasKey( 'title', $properties );
         $this->assertArrayHasKey( 'raw', $properties['title']['properties'] );

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

@@ -1024 +1024 @@
 
         $this->check_create_post_response( $response );
+    }
+
+    /**
+     * @ticket 38698
+     */
+    public function test_create_item_with_template() {
+        wp_set_current_user( self::$editor_id );
+        add_filter( 'theme_post_templates', array( $this, 'filter_theme_post_templates' ) );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/posts' );
+        $params = $this->set_post_data( array(
+            'template' => 'post-my-test-template.php',
+        ) );
+        $request->set_body_params( $params );
+        $response = $this->server->dispatch( $request );
+
+        $data = $response->get_data();
+        $post_template = get_page_template_slug( get_post( $data['id'] ) );
+
+        remove_filter( 'theme_post_templates', array( $this, 'filter_theme_post_templates' ) );
+
+        $this->assertEquals( 'post-my-test-template.php', $data['template'] );
+        $this->assertEquals( 'post-my-test-template.php', $post_template );
+    }
+
+    /**
+     * @ticket 38698
+     */
+    public function test_create_item_with_template_none_available() {
+        wp_set_current_user( self::$editor_id );
+
+        $request = new WP_REST_Request( 'POST', '/wp/v2/posts' );
+        $params = $this->set_post_data( array(
+            'template' => 'post-my-test-template.php',
+        ) );
+        $request->set_body_params( $params );
+        $response = $this->server->dispatch( $request );
+
+        $data = $response->get_data();
+        $post_template = get_page_template_slug( get_post( $data['id'] ) );
+
+        $this->assertEquals( '', $data['template'] );
+        $this->assertEquals( '', $post_template );
     }
 
@@ -2318 +2361 @@
         $data = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 23, count( $properties ) );
+        $this->assertEquals( 24, count( $properties ) );
         $this->assertArrayHasKey( 'author', $properties );
         $this->assertArrayHasKey( 'comment_status', $properties );
@@ -2338 +2381 @@
         $this->assertArrayHasKey( 'status', $properties );
         $this->assertArrayHasKey( 'sticky', $properties );
+        $this->assertArrayHasKey( 'template', $properties );
         $this->assertArrayHasKey( 'title', $properties );
         $this->assertArrayHasKey( 'type', $properties );
@@ -2470 +2514 @@
     }
 
+    public function filter_theme_post_templates( $post_templates ) {
+        return array(
+            'post-my-test-template.php' => 'My Test Template',
+        );
+    }
 }