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

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)

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;
+    }
+
 }