POC: Implement partially synced patterns using the block bindings API by talldan · Pull Request #55807 · WordPress/gutenberg

talldan · 2023-11-02T13:37:13Z

Props to @kevin940726 and @aaronrobertshaw for their work on this.

What?

See #53705

Implements partially synced patterns using some of the available parts of the block bindings API.

The PR is a technical prototype, with the user experience still requiring lots of development.

Why?

See more of the rationale for block bindings in #54536.

How?

This uses the system implemented in #53241 to declare connections (which will probably be renamed to bindings) on the blocks within a pattern (when the user is designing the pattern).

Users can insert these patterns into a post, and when editing a 'connected' attribute of a block, the values are saved to the pattern block instance in a dynamicContent attribute instead of to the block being edited. This allows multiple instances of the same synced pattern to have different content.

The PR also opts partially synced patterns into using the HTML API to dynamically replace block values in PHP.

Testing Instructions

Watch the video for a walkthrough.
Prerequisite: Enable the 'Connections' experiment

Create a Pattern (Edit Site > Patterns > Use the '+' button to create a synced pattern
Add a heading and a paragraph to the pattern, and give them some default text
For both the heading and the paragraph, use the block inspector to change the heading and paragraph connections to a source of 'Pattern attributes' and add a unique value for the 'key' (using preferably kebab case or camel case).
Save the pattern
Switch to editing a post and insert the pattern twice
Update the text in the two instances of the patterns, and note that they can be made distinct, unlike synced patterns that don't have connections.
Preview the post, your changes should be reflected in the frontend.

Testing Instructions for Keyboard

Screenshots or screencast

Kapture.2023-10-20.at.14.18.11.mp4

gziolo

Thank you so much for putting this working prototype together. I have the impression that it's very close to landing behind the existing experiments with the sub-registry that narrows down places where the store deals with the dynamic content for the Partially Synced Pattern. It definitely requires some testing and polishing, but conceptually, I'm pretty happy with how it all looks. I left some comments that might help to clarify how it finally might work.

gziolo · 2023-11-03T13:05:06Z

packages/block-library/src/heading/block.json

 			"type": "string",
 			"source": "html",
-			"selector": "h1,h2,h3,h4,h5,h6",
+			"selector": "h2",


I assume it was added for testing purposes and it will get reverted.

Yep! The processor API doesn't yet support arbitrary CSS selector.

gziolo · 2023-11-03T13:11:24Z

packages/block-library/src/block/index.php


+	$filter_block_context = static function( $context ) use ( $attributes ) {
+		if ( isset( $attributes['dynamicContent'] ) && $attributes['dynamicContent'] ) {
+			$context['dynamicContent'] = $attributes['dynamicContent'];


For the block context, it would be nice to name it in a way that created a connection with the pattern, e.g., pattern/dynamicContent.

gziolo · 2023-11-03T13:17:26Z

packages/block-library/src/block/index.php


 	$seen_refs[ $attributes['ref'] ] = true;

+	$filter_block_context = static function( $context ) use ( $attributes ) {


The filtering only makes sense if $attributes['dynamicContent'] is provided, so maybe it should be created conditionally.

Should the filter get applied only around: $content = do_blocks( $content );? It might help to reason where it takes an effect.

gziolo · 2023-11-03T13:20:16Z

packages/block-library/src/block/edit.js

+		const updates = {};
+		for ( const clientId of [].concat( clientIds ) ) {
+			const attrs = uniqueByBlock ? attributes[ clientId ] : attributes;
+			const parentPattern = select.getBlock( patternClientId );


Have you considered reading the clientId of the pattern by searching for the first parent of the core/block type? This way, it's going to be easier to move the logic outside of the subregistry. It can be done later if that is the best way in the current setup.

gziolo · 2023-11-03T13:22:54Z

packages/block-library/src/block/block.json

 	"keywords": [ "reusable" ],
 	"textdomain": "default",
 	"attributes": {
+		"dynamicContent": {


If we plan to keep it as an experiment, then it should get injected from outside, similar to uses_context for block types that have block bindings defined.

gziolo · 2023-11-03T13:31:50Z

packages/block-editor/src/hooks/custom-fields.js

+	);
+
+function shimAttributeSource( settings ) {
+	settings.edit = createEditFunctionWithPatternSource()( settings.edit );


What's the role of this HOC?

There is a sub-registry injected in the core/block edit implementation that should play a similar role. It essentially should allow redefining a function that fetches the attributes for the block.

Yeah, it was simply the minimum effort for me to make the POC work at the time. We should revisit the "reading" side of the story.

gziolo · 2023-11-03T13:32:33Z

packages/block-editor/src/hooks/custom-fields.js

 		// Currently, only these two blocks are supported.
-		if ( ! [ 'core/paragraph', 'core/image' ].includes( props.name ) ) {
+		if (
+			! [ 'core/paragraph', 'core/image', 'core/heading' ].includes(


We discussed enabling the Button block, too. It's fine to take care of it as a follow-up. I'm leaving it mostly as a note.

gziolo · 2023-11-03T13:35:42Z

lib/experimental/connection-sources/index.php

 		// if it doesn't, `get_post_meta()` will just return an empty string.
 		return get_post_meta( $block_instance->context['postId'], $meta_field, true );
 	},
+	'pattern_attributes' => function ( $block_instance, $meta_field ) {


It would be great to get confirmation from @michalczaplinski or @SantosGuillamot on how this array should be shaped. There is name key defined with the meta value, which implies, we should have another entry with the name pattern. I might be completely wrong here.

I think that nothing was ultimately decided here! Just for reference, this is a previous discussion with Riad: #53247 (comment)

We'll need a nested array here OR have a one file per source (like in Riad's original prototype) so meta.php, patterns.php, etc.

gziolo · 2023-11-03T13:42:11Z

lib/block-supports/pattern.php

+$gutenberg_experiments = get_option( 'gutenberg-experiments' );
+if ( $gutenberg_experiments && array_key_exists( 'gutenberg-connections', $gutenberg_experiments ) ) {
+	function gutenberg_register_pattern_support( $block_type ) {
+		$pattern_support = property_exists( $block_type, 'supports' ) ? _wp_array_get( $block_type->supports, array( '__experimentalConnections' ), false ) : false;


Noting, the injected context is only necessary when dealing with Partially Synced Patterns. The condition based on the UI elements seems to work fine here, but it isn't a direct relationship.

kevin940726 · 2023-11-20T08:14:34Z

For anyone following this thread, I created another draft PR (#56235) exploring another approach which I believe could be more backward-compatible.

talldan · 2023-12-11T03:20:58Z

Implemented by #56235

Try using the block connections api

5e02b61

talldan added [Feature] Synced Patterns Related to synced patterns (formerly reusable blocks) [Feature] Patterns A collection of blocks that can be synced (previously reusable blocks) or unsynced [Block] Pattern Affects the Patterns Block labels Nov 2, 2023

talldan assigned kevin940726 Nov 2, 2023

talldan changed the title ~~Try using the block connections api~~ POC: Implement partially synced patterns using the block bindings API Nov 2, 2023

talldan added [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible [Type] Experimental Experimental feature or API. labels Nov 2, 2023

gziolo self-requested a review November 2, 2023 13:47

gziolo mentioned this pull request Nov 2, 2023

Pattern Overrides epic (WordPress 6.5) #53705

Closed

49 tasks

gziolo requested review from SantosGuillamot, michalczaplinski and ockham November 2, 2023 14:37

gziolo reviewed Nov 3, 2023

View reviewed changes

glendaviesnz mentioned this pull request Nov 15, 2023

[PoC] Explore options for adding partial syncing of blocks with innerBlock content #56132

Closed

kevin940726 mentioned this pull request Nov 17, 2023

Implement partially synced patterns behind an experimental flag #56235

Merged

kevin940726 mentioned this pull request Nov 27, 2023

Automatically assign block ids to pattern blocks for use in partial synching of pattern instances #56495

Merged

talldan closed this Dec 11, 2023

talldan deleted the try/partial-syncing-block-connection branch December 11, 2023 03:21


		$seen_refs[ $attributes['ref'] ] = true;

		$filter_block_context = static function( $context ) use ( $attributes ) {

Conversation

talldan commented Nov 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Screenshots or screencast

Uh oh!

gziolo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kevin940726 commented Nov 20, 2023

Uh oh!

talldan commented Dec 11, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

talldan commented Nov 2, 2023 •

edited

Loading