backport Rename Reusable blocks to Patterns #4646

glendaviesnz · 2023-06-20T05:05:21Z

Renames the Reusable blocks to Patterns. Also adds the option to convert a block or collection of blocks to a non-synced Pattern. This then behaves as imported Patterns do in that once inserted they can be edited completely independently of any other instances of the Pattern. The synced version of the Pattern works as the existing Reusable blocks do in that editing one instance updates all instances.

From: WordPress/gutenberg#51144

Trac ticket: https://core.trac.wordpress.org/ticket/58577

Testing

Full testing would require GB plugin 16.1 installing.

Before switching to PR branch add some reusable blocks
Switch to branch and make sure the existing reusable blocks still work as expected
Go to /wp-admin/edit.php?post_type=wp_block and check that the existing blocks have Sync Status set to Synced in the right post properties panel
Add a new post and add a block or collection of blocks
Select the block(s) and in the block toolbar overflow menu select the Create a pattern menu option
The sync toggle will be off by default - leave it that way and add the new pattern
In the block inspector search for the new pattern name and insert
Check that inserted blocks are independent/stand-alone blocks and not a synced reusable block
Repeat the above but toggle sync on and make sure the saved block behaves the same as the existing reusable blocks
Go to /wp-admin/edit.php?post_type=wp_block and make sure the synced and unsynced Patterns show. Edit Patterns from this page and check that toggling the sync status in right panel works as expected

This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

…these run

glendaviesnz · 2023-06-21T03:13:32Z

Any thoughts on how to best test this? I did look at adding a unit test to tests/phpunit/tests/rest-api/rest-blocks-controller.php but the wp_register_wp_block_postmeta filter is not run there because they are unit tests so the postmeta is not returned.

tellthemachines

Changes LGTM! Just one small nit below.

Testing locally, I'm seeing the changes in /wp-admin/edit.php?post_type=wp_block.

src/wp-includes/block-editor.php

tellthemachines · 2023-06-23T02:19:15Z

src/wp-includes/post.php

@@ -282,26 +282,26 @@ function create_initial_post_types() {
 		'wp_block',
 		array(
 			'labels'                => array(


I was going to say this one could have a @since 6.3.0 note too, but then I checked the create_initial_post_types doc block and there were no additions of the sort for previous changes, so I guess we might as well be consistent and leave it out 😅

peterwilsoncc · 2023-06-23T03:34:49Z

src/wp-includes/post.php

+ *
+ * @return void


Suggested change

*

* @return void

WP-Dev doesn't include @return void annotations.

peterwilsoncc · 2023-06-23T03:37:11Z

src/wp-includes/post.php

+ *
+ * @since 6.3.0
+ *
+ * @see https://github.com/WordPress/gutenberg/pull/51144


Suggested change

* @see https://github.com/WordPress/gutenberg/pull/51144

* @link https://github.com/WordPress/gutenberg/pull/51144

Nit but I think @see is intended for internal function and hook links.

peterwilsoncc · 2023-06-23T03:49:21Z

src/wp-includes/post.php

+ *
+ * @return void
+ */
+function wp_register_wp_block_postmeta() {


Suggested change

function wp_register_wp_block_postmeta() {

function wp_register_initial_post_meta() {

WP registers all the post types in one function (along with statuses), create_initial_post_types, so I'm leaning towards using a generic function name to allow for additional meta data to be registered in the future.

Obviously if this changes then the equivalent is needed in default-actions.php -- would this cause problems in GB?

That makes sense. Done. I am not sure if it affects GB. @tellthemachines do you know if we need to update the GB gutenberg_wp_block_register_post_meta to gutenberg_register_initial_post_meta to match this change?

Do we want to stick with the create_initial naming pattern? We did most recently in create_initial_theme_features.

Yeah, that makes sense to me. Sorry for the bad steer, Glen.

no worries, have changed to _create_initial_

do you know if we need to update the GB gutenberg_wp_block_register_post_meta to gutenberg_register_initial_post_meta to match this change

I don't think so, but we'll need to preserve the existing code in GB in the compat folder for use with previous versions of WP.

TimothyBJacobs · 2023-06-23T04:29:46Z

src/wp-includes/post.php

+			'show_in_rest'      => array(
+				'schema' => array(
+					'type'       => 'string',
+					'properties' => array(
+						'sync_status' => array(
+							'type' => 'string',
+						),
+					),
+				),
+			),


Suggested change

'show_in_rest' => array(

'schema' => array(

'type' => 'string',

'properties' => array(

'sync_status' => array(

'type' => 'string',

),

),

),

),

'show_in_rest' => array(

'schema' => array(

'type' => 'string',

'enum' => array( 'fully', 'unsynced' ),

),

),

This schema entry is incorrect. It's using the properties keyword which would only be used when registering a meta key with a type of object.

We should add an enum keyword that describes the possible values the meta field can contain.

Thanks @TimothyBJacobs. It was initially set as an object, but we reverted to a string, but didn't update the schema correctly. I have updated and set the enum to array( 'partial', 'unsynced' ) as at this point there won't be a fully option as the fully synced blocks don't set the post meta in order to maintain backwards compat with existing reusable blocks. We will be adding a partial option post 6.3 though. Should we add that now, or should I just leave the enum as array( 'unsynced' ) for now?

We will be adding a partial option post 6.3 though. Should we add that now, or should I just leave the enum as array( 'unsynced' ) for now?

No, we shouldn't add it until it becomes available as an option.

at this point there won't be a fully option as the fully synced blocks don't set the post meta in order to maintain backwards compat with existing reusable blocks.

Have ya'll considered setting the default to fully in register_post_meta? What does the client send when they want to set the reusable block to the equivalent of "fully"?

TimothyBJacobs · 2023-06-23T04:34:25Z

I would say exposing this value through meta is a bit odd for Core. Since this is a first party field, we can expose it as top-level property like sync_status. That'd happen through either modifying the WP_REST_Blocks_Controller or using register_rest_field.

src/wp-includes/post.php

glendaviesnz · 2023-06-23T04:54:33Z

I would say exposing this value through meta is a bit odd for Core. Since this is a first party field, we can expose it as top-level property like sync_status. That'd happen through either modifying the WP_REST_Blocks_Controller or using register_rest_field.

That makes sense @TimothyBJacobs, but would require changes to Gutenberg which I think is about to have the RC version cut. Can we keep it as is for the first beta and update it after that is out? It is a minor implementation detail and doesn't affect the underlying data structure so doesn't seem like it will have any impact to do this as a follow up. What do you think?

TimothyBJacobs · 2023-06-23T12:59:23Z

Yep that seems fine to me.

felixarntz

@glendaviesnz Nothing crucial to add to previous reviews, LGTM!

Just two tiny documentation standard nit-picks that would be good to address.

src/wp-includes/post.php

src/wp-includes/block-editor.php

Co-authored-by: Felix Arntz <felixarntz@users.noreply.github.com>

glendaviesnz · 2023-06-25T22:29:21Z

Thanks for the reviews everyone!

src/wp-includes/post.php

Co-authored-by: Peter Wilson <519727+peterwilsoncc@users.noreply.github.com>

peterwilsoncc

LGTM, thanks Glen!

tellthemachines · 2023-06-26T08:57:56Z

Committed in r56030 / b524268.

carlomanf · 2023-06-27T06:46:35Z

src/wp-includes/post.php

@@ -328,6 +328,7 @@ function create_initial_post_types() {
 				'title',
 				'editor',
 				'revisions',
+				'custom-fields',


Is custom fields support actually needed?

In my testing the postmeta sync_status field was not returned without this.

We are however going to look at returning it via REST as a top-level sync_status field rather than as post meta so we may be able to drop custom fields support if we go that way.

glendaviesnz added 2 commits June 20, 2023 17:03

Rename Reusable blocks to Patterns

daeb820

Update fixture

4c0252a

glendaviesnz mentioned this pull request Jun 20, 2023

Plugin: Synchronize PHP changes for WordPress 6.3 release WordPress/gutenberg#51077

Closed

glendaviesnz added 8 commits June 20, 2023 17:31

Add postmeta

30d7fad

remove whitespace

531eacb

add meta to fixture

1c4ebfc

Revert fixture change

2dcc313

Add rebuilt js fixture

4fdf7fb

Add test to check new postmeta sync_status is returned in API

615e369

Remove whitespace

f50707b

Remove unit tests as the filter isn't added to add the postmeta when …

82226cc

…these run

glendaviesnz marked this pull request as ready for review June 21, 2023 03:14

tellthemachines requested review from felixarntz, dream-encode and audrasjb June 23, 2023 02:33

tellthemachines reviewed Jun 23, 2023

View reviewed changes

peterwilsoncc reviewed Jun 23, 2023

View reviewed changes

Changes from review

4a1dcf3

TimothyBJacobs reviewed Jun 23, 2023

View reviewed changes

src/wp-includes/post.php Outdated Show resolved Hide resolved

glendaviesnz added 2 commits June 23, 2023 16:38

Fix rest schema

acc702f

remove auth callback

49fea36

change to wp_create_initial_post_meta

e5919fb

felixarntz approved these changes Jun 23, 2023

View reviewed changes

src/wp-includes/post.php Outdated Show resolved Hide resolved

src/wp-includes/block-editor.php Outdated Show resolved Hide resolved

glendaviesnz and others added 2 commits June 26, 2023 09:56

Remove surplus doc line

5d9e2de

Co-authored-by: Felix Arntz <felixarntz@users.noreply.github.com>

Add punctuation to doc comment

e2b0ec5

Co-authored-by: Felix Arntz <felixarntz@users.noreply.github.com>

peterwilsoncc reviewed Jun 26, 2023

View reviewed changes

src/wp-includes/post.php Outdated Show resolved Hide resolved

hard code block type for register_post_meta call

53337c7

Co-authored-by: Peter Wilson <519727+peterwilsoncc@users.noreply.github.com>

peterwilsoncc approved these changes Jun 26, 2023

View reviewed changes

tellthemachines closed this Jun 26, 2023

glendaviesnz mentioned this pull request Jun 27, 2023

Reusable blocks: Rename to 'Patterns' and add option to also add a non-synced Pattern WordPress/gutenberg#51144

Merged

carlomanf reviewed Jun 27, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

backport Rename Reusable blocks to Patterns #4646

backport Rename Reusable blocks to Patterns #4646

glendaviesnz commented Jun 20, 2023 •

edited

Loading

glendaviesnz commented Jun 21, 2023 •

edited

Loading

tellthemachines left a comment

tellthemachines Jun 23, 2023

peterwilsoncc Jun 23, 2023

glendaviesnz Jun 23, 2023

peterwilsoncc Jun 23, 2023

glendaviesnz Jun 23, 2023

peterwilsoncc Jun 23, 2023

glendaviesnz Jun 23, 2023 •

edited

Loading

TimothyBJacobs Jun 23, 2023

peterwilsoncc Jun 23, 2023

glendaviesnz Jun 23, 2023

tellthemachines Jun 26, 2023

TimothyBJacobs Jun 23, 2023

glendaviesnz Jun 23, 2023 •

edited

Loading

TimothyBJacobs Jun 23, 2023

TimothyBJacobs commented Jun 23, 2023

glendaviesnz commented Jun 23, 2023

TimothyBJacobs commented Jun 23, 2023

felixarntz left a comment

glendaviesnz commented Jun 25, 2023

peterwilsoncc left a comment

tellthemachines commented Jun 26, 2023

carlomanf Jun 27, 2023

glendaviesnz Jun 27, 2023

glendaviesnz Jun 27, 2023

	* @see https://github.com/WordPress/gutenberg/pull/51144
	* @link https://github.com/WordPress/gutenberg/pull/51144

	function wp_register_wp_block_postmeta() {
	function wp_register_initial_post_meta() {

backport Rename Reusable blocks to Patterns #4646

backport Rename Reusable blocks to Patterns #4646

Conversation

glendaviesnz commented Jun 20, 2023 • edited Loading

Testing

glendaviesnz commented Jun 21, 2023 • edited Loading

tellthemachines left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glendaviesnz Jun 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glendaviesnz Jun 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TimothyBJacobs commented Jun 23, 2023

glendaviesnz commented Jun 23, 2023

TimothyBJacobs commented Jun 23, 2023

felixarntz left a comment

Choose a reason for hiding this comment

glendaviesnz commented Jun 25, 2023

peterwilsoncc left a comment

Choose a reason for hiding this comment

tellthemachines commented Jun 26, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glendaviesnz commented Jun 20, 2023 •

edited

Loading

glendaviesnz commented Jun 21, 2023 •

edited

Loading

glendaviesnz Jun 23, 2023 •

edited

Loading

glendaviesnz Jun 23, 2023 •

edited

Loading