Add block types REST API. #21065

spacedmonkey · 2020-03-22T13:06:05Z

Description

Add a simple REST API to allow get registered Block types.

How has this been tested?

The REST API request a logged in user to have edit_post capability.
APIs

__experimental/block-types List of all blocks
__experimental/block-types/<namespace>/<block_type> ie __experimental/block-types/core/post-author". Get details on a single block type
__experimental/block-types/<namespace> ie __experimental/block-types/core . Get all blocks in a single name space.

fixes #2751
Trac ticket: #47620

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.
I've included developer documentation if appropriate.
I've updated all React Native files affected by any refactorings/renamings in this PR.

spacedmonkey · 2020-03-22T13:09:57Z

CC @kadamwhite for visibility.

aduth · 2020-03-23T20:44:33Z

Regarding the question at #2751 (comment):

Can anyone interested please take a look and see if this REST API has the required fields and data. Remember we can add fields later.

I don't know that it's been audited for accuracy lately, but the original Block Registration RFC might be a good source of properties expected to be needed?

https://github.com/WordPress/gutenberg/blob/master/docs/rfc/block-registration.md#block-api

@gziolo has been working on some of the specifics around block.json and may know more.

spacedmonkey · 2020-03-24T11:04:30Z

@aduth Worth noting the current fields that are in this API are based on what is currently register when you register a block on the PHP. I have a ticket in trac in #48529. This PR will only cover the existing fields for now. Adding the extra fields will covered in another PR or core patch.

gziolo · 2020-03-26T08:40:36Z

@aduth Worth noting the current fields that are in this API are based on what is currently register when you register a block on the PHP. I have a ticket in trac in #48529. This PR will only cover the existing fields for now. Adding the extra fields will covered in another PR or core patch.

Yes, we discussed it already. The work was divided into two parts on Trac and this one covers what we had before on the server before we started introducing block.json. It aligns with Block Registration RFC. is_dynamic is the only property that wasn't included there but it's fine as this is something that we use on the server only.

__experimental/block-types?namespace=<namespace> ie __experimental/block-types/?namespace=core . Get all blocks in a single name space.

I don't know what are patterns used for other endpoints in core, but I'm curious why not use __experimental/block-types/<namespace>?

lib/class-wp-rest-block-types-controller.php

TimothyBJacobs · 2020-03-26T20:56:58Z

I don't know what are patterns used for other endpoints in core, but I'm curious why not use __experimental/block-types/?

+1 to this pattern.

spacedmonkey · 2020-05-05T08:46:27Z

@aduth @gziolo Can either of you review this PR. A lot of work as gone into it and no eyes are on it yet.

lib/class-wp-rest-block-types-controller.php

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

aduth

@gziolo Anything you think is needed here, functionally-speaking?

lib/class-wp-rest-block-types-controller.php

aduth · 2020-05-08T13:06:16Z

Would we plan to include unit tests here? Or later in the experimental lifecycle?

gziolo

Anything you think is needed here, functionally-speaking?

I had some minor comments but nothing blocking. As far as I remember there was a follow-up on Track that adds the rest of block fields/properties.

lib/class-wp-rest-block-types-controller.php

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

lib/class-wp-rest-block-types-controller.php

TimothyBJacobs · 2020-05-25T17:08:21Z

Overall looks good, I'd really like to see tests on the prepare item with the different supported properties.

spacedmonkey · 2020-05-25T17:16:17Z

Overall looks good, I'd really like to see tests on the prepare item with the different supported properties.

@TimothyBJacobs Do you need these now before approval or before core merge?

TimothyBJacobs · 2020-05-25T17:17:55Z

I'd prefer to have them now, without them it is hard for me to tell if they are actually outputting what is expected.

spacedmonkey · 2020-05-25T17:18:20Z

I'd prefer to have them now, without them it is hard for me to tell if they are actually outputting what is expected.

@TimothyBJacobs Does this test cover prepare? https://github.com/WordPress/gutenberg/pull/21065/files#diff-c43bb246f80bf07e6c00d6fdb3427794R129-R149

TimothyBJacobs · 2020-05-25T17:20:36Z

That covers when invalid data is provided, but not the positive case.

spacedmonkey · 2020-05-25T20:47:21Z

That covers when invalid data is provided, but not the positive case.

Tests added for positive case. @TimothyBJacobs

aduth · 2020-05-27T22:02:41Z

lib/class-wp-rest-block-types-controller.php

+					'additionalProperties' => array(
+						'type' => 'object',
+					),
+					'default'              => array(),


I notice that, despite the fact the type is assigned as 'object', when the default value is returned by the endpoint, it is returned as a JSON array [] instead of {}. Having dealt with this in the past, I considered if casting it (object) array() would be enough, but it appears to make no difference.

Do you know if there's some way to force the default to return as an object?

Yeah this is an aggravating issue and there isn't a great way to do it. What can be done is check if attributes is empty in prepare_item_for_response and set an empty object instead, but I really don't like that because it means that the attributes property will sometimes be an array and sometimes be an object.

It is something I'd like to fix at some point, I'll try taking a look at this for 5.5.

Add block types REST API.

4c0c2dc

spacedmonkey requested a review from TimothyBJacobs as a code owner March 22, 2020 13:06

spacedmonkey mentioned this pull request Mar 22, 2020

Block API: Server-side awareness of block types #2751

Closed

aduth added the REST API Interaction Related to REST API label Mar 23, 2020

gziolo requested review from kadamwhite and hypest March 26, 2020 08:40

jasonbahl reviewed Mar 26, 2020

View reviewed changes

lib/class-wp-rest-block-types-controller.php Show resolved Hide resolved

aduth reviewed May 7, 2020

View reviewed changes

spacedmonkey and others added 4 commits May 7, 2020 16:50

Remove space

32b995d

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

Change comment.

4ec1eea

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

Change comment.

81ae460

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

Change title.

1be9aaa

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

aduth reviewed May 8, 2020

View reviewed changes

lib/class-wp-rest-block-types-controller.php Outdated Show resolved Hide resolved

lib/class-wp-rest-block-types-controller.php Show resolved Hide resolved

gziolo reviewed May 8, 2020

View reviewed changes

lib/class-wp-rest-block-types-controller.php Outdated Show resolved Hide resolved

lib/class-wp-rest-block-types-controller.php Show resolved Hide resolved

lib/class-wp-rest-block-types-controller.php Show resolved Hide resolved

spacedmonkey and others added 9 commits May 8, 2020 17:41

Change comment.

371ce8d

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

Remove array_shift.

9afefda

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

Change comment to 5.5.0

348ff88

Fixes.

df16a9f

Formatting.

98b5e99

Merge branch 'master' into feautre/block-api

a86db36

More tweaks

c83d05b

Fix lints

730acc5

Tweak fields.

3905157

TimothyBJacobs reviewed May 25, 2020

View reviewed changes

lib/class-wp-rest-block-types-controller.php Outdated Show resolved Hide resolved

Refactor permision check

6db18c8

spacedmonkey added 5 commits May 25, 2020 18:58

Add more tests.

fcb6a1d

Remove unused method.

296efe6

Fix tests.

b98d04c

Use correct name.

bfd9650

Improve tests.

2744ebf

TimothyBJacobs self-requested a review May 25, 2020 20:49

TimothyBJacobs approved these changes May 25, 2020

View reviewed changes

spacedmonkey merged commit 6b8e980 into WordPress:master May 26, 2020

spacedmonkey deleted the feautre/block-api branch May 26, 2020 13:39

github-actions bot added this to the Gutenberg 8.3 milestone May 26, 2020

gziolo mentioned this pull request May 26, 2020

block.json string extraction wp-cli/i18n-command#210

Merged

1 task

johnbillion mentioned this pull request May 27, 2020

Expose available blocks via an API #4116

Closed

spacedmonkey mentioned this pull request May 27, 2020

Add script and style REST APIs #21244

Open

6 tasks

aduth reviewed May 27, 2020

View reviewed changes

aduth mentioned this pull request May 27, 2020

Add context properties to block types REST endpoint #22686

Merged

This was referenced Jun 1, 2020

Replace unstable__bootstrapServerSideBlockDefinitions with call to block type REST API #22812

Open

REST API: Expose blocks registered on the server WordPress/wordpress-develop#317

Closed

ellatrix mentioned this pull request Jun 16, 2020

WP 5.5: merge all PHP changes #23210

Closed

12 tasks

johnbillion mentioned this pull request Jul 2, 2020

Gutenberg-related commands wp-cli/ideas#119

Open

This was referenced Jul 20, 2020

REST API: Apply allowed_block_types filter to Block Types endpoint #24076

Closed

Post Content Block: Disable when editing content (server-side approach) #24114

Closed

skorasaurus mentioned this pull request Feb 4, 2021

Default values should be serialized and sent across Block Renderer to the front end. #12951

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add block types REST API. #21065

Add block types REST API. #21065

spacedmonkey commented Mar 22, 2020 •

edited

Loading

spacedmonkey commented Mar 22, 2020

aduth commented Mar 23, 2020

spacedmonkey commented Mar 24, 2020

gziolo commented Mar 26, 2020

TimothyBJacobs commented Mar 26, 2020

spacedmonkey commented May 5, 2020

aduth left a comment

aduth commented May 8, 2020

gziolo left a comment •

edited

Loading

TimothyBJacobs commented May 25, 2020

spacedmonkey commented May 25, 2020

TimothyBJacobs commented May 25, 2020

spacedmonkey commented May 25, 2020 •

edited

Loading

TimothyBJacobs commented May 25, 2020

spacedmonkey commented May 25, 2020

aduth May 27, 2020

TimothyBJacobs May 28, 2020

Add block types REST API. #21065

Add block types REST API. #21065

Conversation

spacedmonkey commented Mar 22, 2020 • edited Loading

Description

How has this been tested?

Checklist:

spacedmonkey commented Mar 22, 2020

aduth commented Mar 23, 2020

spacedmonkey commented Mar 24, 2020

gziolo commented Mar 26, 2020

TimothyBJacobs commented Mar 26, 2020

spacedmonkey commented May 5, 2020

aduth left a comment

Choose a reason for hiding this comment

aduth commented May 8, 2020

gziolo left a comment • edited Loading

Choose a reason for hiding this comment

TimothyBJacobs commented May 25, 2020

spacedmonkey commented May 25, 2020

TimothyBJacobs commented May 25, 2020

spacedmonkey commented May 25, 2020 • edited Loading

TimothyBJacobs commented May 25, 2020

spacedmonkey commented May 25, 2020

aduth May 27, 2020

Choose a reason for hiding this comment

TimothyBJacobs May 28, 2020

Choose a reason for hiding this comment

spacedmonkey commented Mar 22, 2020 •

edited

Loading

gziolo left a comment •

edited

Loading

spacedmonkey commented May 25, 2020 •

edited

Loading