Add anchor support for dynamic blocks #44771

Soean · 2022-10-07T08:54:27Z

What?

Adds anchor support to dynamic rendered blocks.
Enables support for core blocks

Testing Instructions

You need to add 'id' to $attributes_to_merge in get_block_wrapper_attributes() from the WP_Block_Supports class, see https://github.com/WordPress/wordpress-develop/blob/6.0.2/src/wp-includes/class-wp-block-supports.php#L178

$attributes_to_merge = array( 'style', 'class' );

Change to:

$attributes_to_merge = array( 'style', 'class', 'id' );

cr0ybot · 2022-10-07T21:57:07Z

Yes! I have been waiting for this for so long!

michalczaplinski · 2022-10-18T17:49:33Z

I'm very eager to get this merged! Nice work @Soean! 👏

You need to add 'id' to $attributes_to_merge in get_block_wrapper_attributes() from the WP_Block_Supports class, see https://github.com/WordPress/wordpress-develop/blob/6.0.2/src/wp-includes/class-wp-block-supports.php#L178

Could you create a ticket for this in WordPress Core Trac so that a relevant change can be made there?

There's also a small merge conflict in the docs I see 🙂

Soean · 2022-10-19T13:24:19Z

@michalczaplinski I created a trac ticket and PR:

I also solved the merge conflict.

ndiego · 2023-01-30T22:49:04Z

Just tested this PR using a Social Link block, and it works great. For others testing, note that you need to manually apply the patch in WordPress/wordpress-develop#3497.

Editor:

Front end:

carolinan · 2023-01-31T06:03:00Z

Would it be possible to make the anchor block support enabled by default for all blocks?

github-actions · 2023-01-31T06:48:39Z

Flaky tests detected in 291cced.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4053938383
📝 Reported issues:

[Flaky Test] shouldn't conflict with server-side autosave #35176 in specs/editor/various/autosave.test.js

Mamaduka · 2023-01-31T11:58:27Z

@ndiego, do you see any errors in the DevTools console when testing this branch, with or without the core patch?

I think failing E2E tests are related to the changes in this PR.

ndiego · 2023-01-31T13:00:51Z

@carolinan I am getting fatal errors now with the recent updates. Per @Mamaduka it looks like this PR needs to be updated due to #47195.

carolinan · 2023-01-31T13:12:25Z

After updating to wp_should_skip_block_supports_serialization
I am still seeing this console warning in the editor:
traverse.js:26 Error while traversing the CSS: Error: undefined:1:10: missing '{'

Update: Ignore that ^, it was theme related.

ndiego · 2023-01-31T13:55:05Z

I just retested and everything is looking good on my end.

Soean · 2023-01-31T16:29:08Z

Thanks for testing, what do we need to get it merged?

Mamaduka

The changes here look good to me. Thank you, @Soean!

While there are many file updates, only the anchor.php contains significant changes.

@Soean, can you update WordPress/wordpress-develop#3497 and sync changes for the anchor.php after the merge?

Here's the tracking issue for PHP backports: #47187.

Soean · 2023-02-03T10:51:00Z

Thanks @Mamaduka. I synced the changes to the PR WordPress/wordpress-develop#3497, updated the trac ticket and added it to the tracking issue.

Mamaduka · 2023-02-03T11:51:59Z

Thank you, @Soean!

fabiankaegy · 2023-02-06T09:44:57Z

@Soean I added the Needs Dev Note label to this PR. Do you have time to write something up for it in the next few weeks (Deadline is March 3rd :) )

If not I can help with writing something up. :)

t-hamano · 2023-02-19T08:47:50Z

I fear that this change may affect the backward compatibility of some blocks with the anchor. Please see #48232.

t-hamano · 2023-02-19T12:26:01Z

lib/block-supports/anchor.php

+function gutenberg_register_anchor_support( $block_type ) {
+	$has_anchor_support = _wp_array_get( $block_type->supports, array( 'anchor' ), true );
+	if ( ! $has_anchor_support ) {
+		return;
+	}
+
+	if ( ! $block_type->attributes ) {
+		$block_type->attributes = array();
+	}
+
+	if ( ! array_key_exists( 'anchor', $block_type->attributes ) ) {
+		$block_type->attributes['anchor'] = array(
+			'type' => 'string',
+		);
+	}
+}


This process would also apply to static blocks, which would add an extra comment as attributes.

adamwoodnz · 2023-02-22T00:49:04Z

I fear that this change may affect the backward compatibility of some blocks with the anchor. Please see #48232.

We've been building pages for wordpress.org and seeing blocks with existing anchors becoming unrecoverable. Typically Group blocks.

bph · 2023-02-28T09:39:59Z

@fabiankaegy and @Soean Are either of you working the dev note for this PR?

Does it warrant a stand-alone post? If yes, please post a draft to the Make Core Blog.
If you only would write a paragraph or two, comment on this PR, and I'll add it to the Misc Editor Note.

If you could do write this by Thursday (March 2 EOB), that would be helpful. The release squad for 6.2 documentation, will start working on the Field guide for 6.2 on Friday.

t-hamano · 2023-02-28T10:21:31Z

@bph
In this PR, we found a backward compatibility issue where blocks with anchors were broken, as reported in #47771. We are still discussing #48438 to fix this issue and how it should be addressed.

t-hamano · 2023-03-01T01:25:54Z

@bph
This change will be reverted in #48592 due to backward compatibility issues as reported in #48232. Here is the discussion on Slack. Therefore, I think Dev Note isn't necessary.

This reverts commit 3bb63e4.

Add anchor support

8bcd8df

Soean requested review from spacedmonkey, ajitbohra, ryanwelcher, juanmaguitar and fabiankaegy as code owners October 7, 2022 08:54

Soean mentioned this pull request Oct 7, 2022

Add anchor support to dynamic blocks #24699

Closed

1 task

Add anchor support

85fffae

Soean requested review from michalczaplinski and tellthemachines as code owners October 7, 2022 10:44

Soean changed the title ~~WIP: Add anchor support for dynamic blocks~~ Add anchor support for dynamic blocks Oct 7, 2022

Soean added [Feature] Blocks Overall functionality of blocks [Type] Enhancement A suggestion for improvement. labels Oct 7, 2022

michalczaplinski added the [Type] WP Core Ticket Requires an upstream change from WordPress. Core Trac ticket should be linked. label Oct 18, 2022

Merge trunk

611ec89

Soean mentioned this pull request Oct 19, 2022

Add ID support to block wrapper attributes WordPress/wordpress-develop#3497

Closed

Merge trunk

6ff204c

Merge branch 'trunk' into add-anchor-support

94fa232

Remove duplicate block support after merge conflict

291cced

Use wp_should_skip_block_supports_serialization

27b1f79

Mamaduka approved these changes Jan 31, 2023

View reviewed changes

Soean merged commit 3bb63e4 into trunk Feb 1, 2023

Soean deleted the add-anchor-support branch February 1, 2023 07:51

github-actions bot added this to the Gutenberg 15.1 milestone Feb 1, 2023

Soean mentioned this pull request Feb 3, 2023

Plugin: Backport PHP changes for WordPress 6.2 release #47187

Closed

85 tasks

fabiankaegy added the Needs Dev Note Requires a developer note for a major WordPress release cycle label Feb 6, 2023

fabiankaegy mentioned this pull request Feb 6, 2023

6.2 Dev Note Tracking Issue #47771

Closed

47 tasks

femkreations added the Needs User Documentation Needs new user documentation label Feb 8, 2023

t-hamano mentioned this pull request Feb 19, 2023

Several blocks with the anchor are broken in the update #48232

Closed

t-hamano reviewed Feb 19, 2023

View reviewed changes

StevenDufresne mentioned this pull request Feb 22, 2023

Remove SOTW banner from homepage WordPress/wporg-main-2022#207

Merged

t-hamano mentioned this pull request Feb 25, 2023

Fix: duplicate markup on anchor attribute #48438

Closed

t-hamano mentioned this pull request Feb 28, 2023

[WP6.2] Revert dynamic block anchor support #48592

Merged

Mamaduka pushed a commit that referenced this pull request Mar 1, 2023

Revert "Add anchor support for dynamic blocks (#44771)"

53c8b59

This reverts commit 3bb63e4.

fabiankaegy mentioned this pull request Mar 2, 2023

Allow blocks to use the role attribute #47868

Closed

femkreations mentioned this pull request Mar 10, 2023

[HelpHub] Social Icons block WordPress/Documentation-Issue-Tracker#498

Closed

14 tasks

ramonjd mentioned this pull request Jun 5, 2023

Plugin: Synchronize PHP changes for WordPress 6.3 release #51077

Closed

ramonjd assigned Soean Jun 5, 2023

This was referenced Jun 7, 2023

Remove anchor support from dynamic blocks #51288

Merged

Explore how to re-add anchor support to dynamic blocks #51402

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add anchor support for dynamic blocks #44771

Add anchor support for dynamic blocks #44771

Soean commented Oct 7, 2022 •

edited

Loading

cr0ybot commented Oct 7, 2022

michalczaplinski commented Oct 18, 2022

Soean commented Oct 19, 2022

ndiego commented Jan 30, 2023

carolinan commented Jan 31, 2023 •

edited

Loading

github-actions bot commented Jan 31, 2023 •

edited

Loading

Mamaduka commented Jan 31, 2023

ndiego commented Jan 31, 2023

carolinan commented Jan 31, 2023 •

edited

Loading

ndiego commented Jan 31, 2023

Soean commented Jan 31, 2023

Mamaduka left a comment

Soean commented Feb 3, 2023

Mamaduka commented Feb 3, 2023

fabiankaegy commented Feb 6, 2023

t-hamano commented Feb 19, 2023

t-hamano Feb 19, 2023

adamwoodnz commented Feb 22, 2023

bph commented Feb 28, 2023

t-hamano commented Feb 28, 2023

t-hamano commented Mar 1, 2023

Add anchor support for dynamic blocks #44771

Add anchor support for dynamic blocks #44771

Conversation

Soean commented Oct 7, 2022 • edited Loading

What?

Testing Instructions

cr0ybot commented Oct 7, 2022

michalczaplinski commented Oct 18, 2022

Soean commented Oct 19, 2022

ndiego commented Jan 30, 2023

carolinan commented Jan 31, 2023 • edited Loading

github-actions bot commented Jan 31, 2023 • edited Loading

Mamaduka commented Jan 31, 2023

ndiego commented Jan 31, 2023

carolinan commented Jan 31, 2023 • edited Loading

ndiego commented Jan 31, 2023

Soean commented Jan 31, 2023

Mamaduka left a comment

Choose a reason for hiding this comment

Soean commented Feb 3, 2023

Mamaduka commented Feb 3, 2023

fabiankaegy commented Feb 6, 2023

t-hamano commented Feb 19, 2023

t-hamano Feb 19, 2023

Choose a reason for hiding this comment

adamwoodnz commented Feb 22, 2023

bph commented Feb 28, 2023

t-hamano commented Feb 28, 2023

t-hamano commented Mar 1, 2023

Soean commented Oct 7, 2022 •

edited

Loading

carolinan commented Jan 31, 2023 •

edited

Loading

github-actions bot commented Jan 31, 2023 •

edited

Loading

carolinan commented Jan 31, 2023 •

edited

Loading