Opened 7 years ago
Closed 6 years ago
#43887 closed enhancement (fixed)
Expose Gutenberg Data Format version in the REST API
Reported by: | danielbachhuber | Owned by: | desrosj |
---|---|---|---|
Milestone: | 5.0 | Priority: | normal |
Severity: | normal | Version: | |
Component: | REST API | Keywords: | has-patch has-unit-tests fixed-5.0 |
Focuses: | rest-api | Cc: |
Description
From https://github.com/WordPress/gutenberg/issues/6435
More advanced REST API consumers will want to switch how they handle post_content depending on whether the content contains blocks or not, and (in the future) will likely want to switch based on which version of the block format it contains.
Rather than requiring consumers to duplicate how Gutenberg determines whether to parse blocks or not, we can expose the same information in post objects returned by the REST API.
Currently, it would return:
0
: Thepost_content
does not contain blocks, it can be treated as classic content.1
: Thepost_content
contains blocks, it should be treated appropriately.If the block format has back compat breaking changes in the future, we can increment this value as needed.
For an immediate practical use, this would be useful for the WordPress mobile apps to decide how to handle the
post_content
: https://github.com/wordpress-mobile/WordPress-iOS/pull/9194
Attachments (4)
Change History (18)
#2
@
7 years ago
A possible direct approach, where we explicitly set the available values 0 or 1 instead of type casting, could be:
if ( ! empty( $schema['properties']['block'] ) ) { $data['block'] = ( false !== strpos( $post->post_content, '<!-- wp:' ) ) ? 1 : 0; }
where:
$schema['properties']['block'] = array( 'description' => __( 'Whether or not the object has blocks.' ), 'type' => 'integer', 'context' => array( 'view', 'edit' ), 'readonly' => true, );
assuming the same context as the rendered content.
The integer
type sounds like a better choice than boolean
, if it can increment in the future.
Actually there's a version function in Gutenberg:
/** * Returns the current version of the block format that the content string is using. * * If the string doesn't contain blocks, it returns 0. * * @since 2.8.0 * @see gutenberg_content_has_blocks() * * @param string $content Content to test. * @return int The block format version. */ function gutenberg_content_block_version( $content ) { return gutenberg_content_has_blocks( $content ) ? 1 : 0; }
When Gutenberg merges into core, I guess the function gutenberg_content_block_version()
will not change it's name. So one could use:
if ( function_exists( 'gutenberg_content_block_version' ) ) { $data['block'] = gutenberg_content_block_version( $post ); }
with above as a fallback (depending on when implemented).
One could also consider a wrapper method:
if ( ! empty( $schema['properties']['block'] ) ) { $data['block'] = $this->get_content_block_version( $post ); }
if there need to be fallback checks.
#3
@
7 years ago
This seems to belong to the content property:
if ( ! empty( $schema['properties']['content'] ) ) { $data['content'] = array( 'raw' => $post->post_content, /** This filter is documented in wp-includes/post-template.php */ 'rendered' => post_password_required( $post ) ? '' : apply_filters( 'the_content', $post->post_content ), 'protected' => (bool) $post->post_password, /** @todo: Replace with `gutenberg_content_block_version()` when Gutenberg merges into core. */ 'block_version' => ( false !== strpos( $post->post_content, '<!-- wp:' ) ) ? 1 : 0, ); }
#4
@
7 years ago
- Keywords has-patch has-unit-tests added; needs-patch needs-unit-tests removed
43887.diff is a first pass that:
- Adds the readonly
block_version
property of integer type, under the postcontent
property, withview
andedit
context. - Adds a block content check with
strpos().
- Adds a @todo to consider the
gutenberg_content_block_version()
if implemented after the Gutenberg merge. - Adds tests.
This ticket was mentioned in Slack in #core-restapi by danielbachhuber. View the logs.
6 years ago
#6
@
6 years ago
- Keywords needs-patch needs-unit-tests added; has-patch has-unit-tests removed
This needs a new patch with unit tests that uses the new Block functions.
This ticket was mentioned in Slack in #core-restapi by danielbachhuber. View the logs.
6 years ago
#9
@
6 years ago
- Keywords has-unit-tests has-patch added; needs-patch needs-unit-tests removed
- Moves the
gutenberg_content_block_version()
function intowp-includes/blocks.php
and renames itblock_version()
. Maybe it's a too general name? - I couldn't find Gutenberg unit tests for the
gutenberg_content_block_version()
function, so I added a some intotests/phpunit/tests/blocks.php
. - Updates the 43887.diff with
block_version()
.
#10
@
6 years ago
In 43887.3.2.diff
:
- Limited
context
to solely'edit'
, asblock_version
is meant for the editor and not public consumption. - Fixes the errant comma in schema description.
- Regenerates
wp-api-generated.js
.
For reference here are Gutenberg's functions to determine if the post or the content has blocks: