Changeset 39047

Timestamp:

10/31/2016 03:52:08 AM (7 years ago)

Author:

rmccue

Message:

REST API: Support password on non-post post types.

The password field was incorrectly only added to "post" post types, but is supported for all post types in the Dashboard UI.

Props jnylen0.
Fixes #38582.

Location:

trunk

Files:

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

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

@@ -420 +420 @@
         );
 
+        unset( $schema['properties']['password'] );
+
         return $schema;
     }

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

@@ -1748 +1748 @@
                     'readonly'    => true,
                 ),
+                'password'        => array(
+                    'description' => __( 'A password to protect access to the content and excerpt.' ),
+                    'type'        => 'string',
+                    'context'     => array( 'edit' ),
+                ),
             ),
         );
@@ -1949 +1954 @@
                 'context'     => array( 'view', 'edit' ),
             );
-
-            $schema['properties']['password'] = array(
-                'description' => __( 'A password to protect access to the content and excerpt.' ),
-                'type'        => 'string',
-                'context'     => array( 'edit' ),
-            );
         }
 

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

@@ -359 +359 @@
     }
 
+    public function test_get_page_with_password() {
+        $page_id = $this->factory->post->create( array(
+            'post_type'     => 'page',
+            'post_password' => '$inthebananastand',
+        ) );
+
+        $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/pages/%d', $page_id ) );
+        $response = $this->server->dispatch( $request );
+
+        $data = $response->get_data();
+        $this->assertEquals( '', $data['content']['rendered'] );
+        $this->assertTrue( $data['content']['protected'] );
+        $this->assertEquals( '', $data['excerpt']['rendered'] );
+        $this->assertTrue( $data['excerpt']['protected'] );
+    }
+
+    public function test_get_page_with_password_using_password() {
+        $page_id = $this->factory->post->create( array(
+            'post_type'     => 'page',
+            'post_password' => '$inthebananastand',
+            'post_content'  => 'Some secret content.',
+            'post_excerpt'  => 'Some secret excerpt.',
+        ) );
+
+        $page = get_post( $page_id );
+        $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/pages/%d', $page_id ) );
+        $request->set_param( 'password', '$inthebananastand' );
+        $response = $this->server->dispatch( $request );
+
+        $data = $response->get_data();
+        $this->assertEquals( wpautop( $page->post_content ), $data['content']['rendered'] );
+        $this->assertTrue( $data['content']['protected'] );
+        $this->assertEquals( wpautop( $page->post_excerpt ), $data['excerpt']['rendered'] );
+        $this->assertTrue( $data['excerpt']['protected'] );
+    }
+
+    public function test_get_page_with_password_using_incorrect_password() {
+        $page_id = $this->factory->post->create( array(
+            'post_type'     => 'page',
+            'post_password' => '$inthebananastand',
+        ) );
+
+        $page = get_post( $page_id );
+        $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/pages/%d', $page_id ) );
+        $request->set_param( 'password', 'wrongpassword' );
+        $response = $this->server->dispatch( $request );
+
+        $this->assertErrorResponse( 'rest_post_incorrect_password', $response, 403 );
+    }
+
+    public function test_get_page_with_password_without_permission() {
+        $page_id = $this->factory->post->create( array(
+            'post_type'     => 'page',
+            'post_password' => '$inthebananastand',
+            'post_content'  => 'Some secret content.',
+            'post_excerpt'  => 'Some secret excerpt.',
+        ) );
+        $request = new WP_REST_Request( 'GET', sprintf( '/wp/v2/pages/%d', $page_id ) );
+        $response = $this->server->dispatch( $request );
+        $data = $response->get_data();
+        $this->assertEquals( '', $data['content']['rendered'] );
+        $this->assertTrue( $data['content']['protected'] );
+        $this->assertEquals( '', $data['excerpt']['rendered'] );
+        $this->assertTrue( $data['excerpt']['protected'] );
+    }
+
     public function test_get_item_schema() {
         $request = new WP_REST_Request( 'OPTIONS', '/wp/v2/pages' );
@@ -364 +430 @@
         $data = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 21, count( $properties ) );
+        $this->assertEquals( 22, count( $properties ) );
         $this->assertArrayHasKey( 'author', $properties );
         $this->assertArrayHasKey( 'comment_status', $properties );
@@ -380 +446 @@
         $this->assertArrayHasKey( 'modified_gmt', $properties );
         $this->assertArrayHasKey( 'parent', $properties );
+        $this->assertArrayHasKey( 'password', $properties );
         $this->assertArrayHasKey( 'ping_status', $properties );
         $this->assertArrayHasKey( 'slug', $properties );

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

@@ -771 +771 @@
 
         $data = $response->get_data();
+        $this->assertEquals( '', $data['content']['rendered'] );
         $this->assertTrue( $data['content']['protected'] );
+        $this->assertEquals( '', $data['excerpt']['rendered'] );
         $this->assertTrue( $data['excerpt']['protected'] );
     }
@@ -791 +793 @@
         $data = $response->get_data();
         $this->assertEquals( wpautop( $post->post_content ), $data['content']['rendered'] );
+        $this->assertTrue( $data['content']['protected'] );
         $this->assertEquals( wpautop( $post->post_excerpt ), $data['excerpt']['rendered'] );
+        $this->assertTrue( $data['excerpt']['protected'] );
     }
 
@@ -818 +822 @@
         $this->check_get_post_response( $response, 'view' );
         $this->assertEquals( '', $data['content']['rendered'] );
+        $this->assertTrue( $data['content']['protected'] );
         $this->assertEquals( '', $data['excerpt']['rendered'] );
-
+        $this->assertTrue( $data['excerpt']['protected'] );
     }