Changeset 43007

Timestamp:

04/27/2018 03:05:40 AM (6 years ago)

Author:

pento

Message:

REST API: Include viewable attribute on Post Type resource for edit context

For the block editor to be able to expose the Preview button correctly, it needs to know the is_post_type_viewable() setting, this change adds it to the Post Type response.

Props danielbachhuber.
Fixes #43739.

Location:

trunk

Files:

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

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

@@ -160 +160 @@
             'description'  => $post_type->description,
             'hierarchical' => $post_type->hierarchical,
+            'viewable'     => is_post_type_viewable( $post_type ),
             'labels'       => $post_type->labels,
             'name'         => $post_type->label,
@@ -230 +231 @@
                     'readonly'    => true,
                 ),
+                'viewable'     => array(
+                    'description' => __( 'Whether or not the post type can be viewed.' ),
+                    'type'        => 'boolean',
+                    'context'     => array( 'edit' ),
+                    'readonly'    => true,
+                ),
                 'labels'       => array(
                     'description' => __( 'Human-readable labels for the post type for various contexts.' ),

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

@@ -129 +129 @@
         $data       = $response->get_data();
         $properties = $data['schema']['properties'];
-        $this->assertEquals( 9, count( $properties ) );
+        $this->assertEquals( 10, count( $properties ) );
         $this->assertArrayHasKey( 'capabilities', $properties );
         $this->assertArrayHasKey( 'description', $properties );
         $this->assertArrayHasKey( 'hierarchical', $properties );
+        $this->assertArrayHasKey( 'viewable', $properties );
         $this->assertArrayHasKey( 'labels', $properties );
         $this->assertArrayHasKey( 'name', $properties );
@@ -192 +193 @@
             $this->assertEquals( $post_type_obj->cap, $data['capabilities'] );
             $this->assertEquals( $post_type_obj->labels, $data['labels'] );
+            if ( in_array( $post_type_obj->name, array( 'post', 'page' ), true ) ) {
+                $viewable = true;
+            } else {
+                $viewable = is_post_type_viewable( $post_type_obj );
+            }
+            $this->assertEquals( $viewable, $data['viewable'] );
             $this->assertEquals( get_all_post_type_supports( $post_type_obj->name ), $data['supports'] );
         } else {
             $this->assertFalse( isset( $data['capabilities'] ) );
+            $this->assertFalse( isset( $data['viewable'] ) );
             $this->assertFalse( isset( $data['labels'] ) );
             $this->assertFalse( isset( $data['supports'] ) );