Changeset 44268

Timestamp:

12/17/2018 05:21:05 PM (6 years ago)

Author:

desrosj

Message:

REST API: Always include title.raw/content.raw for Blocks in context=view.

Demarcations for reusable blocks are always expected to be accessible by clients.

Props noisysocks, youknowriad.

Merges [43917] to trunk.

See #45145 for the patch, #45098 for the original ticket.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-blocks-controller.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-blocks-controller.php (modified) (9 diffs)

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

@@ -37 +37 @@
         return parent::check_read_permission( $post );
     }
+
+    /**
+     * Filters a response based on the context defined in the schema.
+     *
+     * @since 5.0.0
+     *
+     * @param array  $data    Response data to fiter.
+     * @param string $context Context defined in the schema.
+     * @return array Filtered response.
+     */
+    public function filter_response_by_context( $data, $context ) {
+        $data = parent::filter_response_by_context( $data, $context );
+
+        /*
+         * Remove `title.rendered` and `content.rendered` from the response. It
+         * doesn't make sense for a reusable block to have rendered content on its
+         * own, since rendering a block requires it to be inside a post or a page.
+         */
+        unset( $data['title']['rendered'] );
+        unset( $data['content']['rendered'] );
+
+        return $data;
+    }
+
+    /**
+     * Retrieves the block's schema, conforming to JSON Schema.
+     *
+     * @since 5.0.0
+     *
+     * @return array Item schema data.
+     */
+    public function get_item_schema() {
+        $schema = parent::get_item_schema();
+
+        /*
+         * Allow all contexts to access `title.raw` and `content.raw`. Clients always
+         * need the raw markup of a reusable block to do anything useful, e.g. parse
+         * it or display it in an editor.
+         */
+        $schema['properties']['title']['properties']['raw']['context']   = array( 'view', 'edit' );
+        $schema['properties']['content']['properties']['raw']['context'] = array( 'view', 'edit' );
+
+        /*
+         * Remove `title.rendered` and `content.rendered` from the schema. It doesn’t
+         * make sense for a reusable block to have rendered content on its own, since
+         * rendering a block requires it to be inside a post or a page.
+         */
+        unset( $schema['properties']['title']['properties']['rendered'] );
+        unset( $schema['properties']['content']['properties']['rendered'] );
+
+        return $schema;
+    }
+
 }

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

@@ -30 +30 @@
 
     /**
-     * Our fake user's ID.
-     *
-     * @since 5.0.0
-     *
-     * @var int
-     */
-    protected static $user_id;
+     * Our fake user IDs, keyed by their role.
+     *
+     * @since 5.0.0
+     *
+     * @var array
+     */
+    protected static $user_ids;
 
     /**
@@ -51 +51 @@
                 'post_status'  => 'publish',
                 'post_title'   => 'My cool block',
-                'post_content' => '<!-- wp:core/paragraph --><p>Hello!</p><!-- /wp:core/paragraph -->',
+                'post_content' => '<!-- wp:paragraph --><p>Hello!</p><!-- /wp:paragraph -->',
             )
         );
 
-        self::$user_id = $factory->user->create(
-            array(
-                'role' => 'editor',
-            )
+        self::$user_ids = array(
+            'editor'      => $factory->user->create( array( 'role' => 'editor' ) ),
+            'author'      => $factory->user->create( array( 'role' => 'author' ) ),
+            'contributor' => $factory->user->create( array( 'role' => 'contributor' ) ),
         );
     }
@@ -70 +70 @@
         wp_delete_post( self::$post_id );
 
-        self::delete_user( self::$user_id );
+        foreach ( self::$user_ids as $user_id ) {
+            self::delete_user( $user_id );
+        }
     }
 
@@ -115 +117 @@
     public function test_capabilities( $action, $role, $expected_status ) {
         if ( $role ) {
-            $user_id = $this->factory->user->create( array( 'role' => $role ) );
+            $user_id = self::$user_ids[ $role ];
             wp_set_current_user( $user_id );
         } else {
@@ -127 +129 @@
                     array(
                         'title'   => 'Test',
-                        'content' => '<!-- wp:core/paragraph --><p>Test</p><!-- /wp:core/paragraph -->',
+                        'content' => '<!-- wp:paragraph --><p>Test</p><!-- /wp:paragraph -->',
                     )
                 );
@@ -150 +152 @@
                         'post_status'  => 'publish',
                         'post_title'   => 'My cool block',
-                        'post_content' => '<!-- wp:core/paragraph --><p>Hello!</p><!-- /wp:core/paragraph -->',
+                        'post_content' => '<!-- wp:paragraph --><p>Hello!</p><!-- /wp:paragraph -->',
                         'post_author'  => $user_id,
                     )
@@ -159 +161 @@
                     array(
                         'title'   => 'Test',
-                        'content' => '<!-- wp:core/paragraph --><p>Test</p><!-- /wp:core/paragraph -->',
+                        'content' => '<!-- wp:paragraph --><p>Test</p><!-- /wp:paragraph -->',
                     )
                 );
@@ -180 +182 @@
                     array(
                         'title'   => 'Test',
-                        'content' => '<!-- wp:core/paragraph --><p>Test</p><!-- /wp:core/paragraph -->',
+                        'content' => '<!-- wp:paragraph --><p>Test</p><!-- /wp:paragraph -->',
                     )
                 );
@@ -197 +199 @@
                 $this->fail( "'$action' is not a valid action." );
         }
-
-        if ( isset( $user_id ) ) {
-            self::delete_user( $user_id );
-        }
+    }
+
+    /**
+     * Check that the raw title and content of a block can be accessed when there
+     * is no set schema, and that the rendered content of a block is not included
+     * in the response.
+     */
+    public function test_content() {
+        wp_set_current_user( self::$user_ids['author'] );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/blocks/' . self::$post_id );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        $this->assertEquals(
+            array(
+                'raw' => 'My cool block',
+            ),
+            $data['title']
+        );
+        $this->assertEquals(
+            array(
+                'raw'       => '<!-- wp:paragraph --><p>Hello!</p><!-- /wp:paragraph -->',
+                'protected' => false,
+            ),
+            $data['content']
+        );
     }
 }