Block Hooks: Fix truncation of post content #68926

ockham · 2025-01-28T14:11:16Z

What?

Fix #68605. To understand the underlying problem, see #68605 (comment).

How?

By introducing a new function, apply_block_hooks_to_content_from_post_object, to colocate the logic used to temporarily wrap content in a parent block (with ignoredHookedBlocks information fetched from post meta) alongside the call to apply_block_hooks_to_content.

This centralizes logic added to the Post Content (#67272), Synced Pattern (#68058), and Navigation (#57754) blocks.

See #62716.

Testing Instructions

First, verify that this PR indeed fixes #68605. To do so, add the following filter:

add_filter(
	'the_content',
	function() {
		return '123456789';
	},
	1
);

Then, verify that content on the frontend is indeed replaced by 123456789 (and not by just 456).

Additionally, it would be good to verify that this PR also fixes #68614.

Finally, testing needs to cover that insertion of hooked blocks into Post Content, Synced Pattern, and Navigation blocks still works as before -- with a special focus on insertion as first or last child of those blocks.

To that end, please refer to the testing instructions of #67272, #68058, and #57754, respectively.

…block_hooks_to_content

github-actions · 2025-01-29T15:04:31Z

Flaky tests detected in 8d1e654.
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/13033762960
📝 Reported issues:

[Flaky Test] Redirection after template creation #60678 in /test/e2e/specs/site-editor/site-editor-url-navigation.spec.js

ockham · 2025-01-29T15:48:23Z

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

-	$content = apply_block_hooks_to_content( $content, $reusable_block );
-	// Remove block wrapper.
-	$content = remove_serialized_parent_block( $content );
+	$content = apply_block_hooks_to_content_from_post_object( $content, $reusable_block );


Note that each block that fetches content from a post object in the DB does so in a different way. Specifically, the Synced Pattern block (core/block) does not invoke the the_content filter, so we need to run apply_block_hooks_to_content_from_post_object manually.

ockham · 2025-01-29T15:50:01Z

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

-	// but before `do_blocks` runs, as it would otherwise attempt to render the same block again --
-	// thus recursing infinitely.
-	add_filter( 'the_content', 'remove_serialized_parent_block', 8 );
-
 	/** This filter is documented in wp-includes/post-template.php */
 	$content = apply_filters( 'the_content', str_replace( ']]>', ']]&gt;', $content ) );


The Post Content block runs the the_content filter, to which we've hooked apply_block_hooks_to_content_from_post_object, which is why we don't have to run it manually here.

github-actions · 2025-01-29T15:56:40Z

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @theMasudRana, @jacobzymet.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Unlinked contributors: theMasudRana, jacobzymet.

Co-authored-by: ockham <[email protected]>
Co-authored-by: gziolo <[email protected]>
Co-authored-by: Mamaduka <[email protected]>
Co-authored-by: t-hamano <[email protected]>
Co-authored-by: richtabor <[email protected]>
Co-authored-by: rinkalpagdar <[email protected]>
Co-authored-by: PaulREnglish <[email protected]>
Co-authored-by: ryelle <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

ockham · 2025-01-29T15:58:40Z

This should be ready for review. Since it's a pretty nasty bug, it'd be great if we could get it merged and synced over to Core before WP 6.8 Beta 1 (next Tuesday). I'm not sure if another npm package release and sync is planned prior to that; otherwise, Beta 1 will have the bug, and the fix will only go into Beta 2. Anyway, pinging Release Tech Leads @joemcgill @desrosj @Mamaduka for advice.

Testing this PR is no small feat; not only do we need to test that it fixes the original issue, but also to make sure that hooked block insertion into the affected blocks (Post Content, Synced Pattern, Navigation) still works (especially first child/last child insertion). For the latter, we can peruse the testing instructions from the respective PRs that added Block Hooks to those blocks:

Block Hooks: Apply to Post Content (on frontend and in editor) #67272 for Post Content
Synced Patterns: Apply Block Hooks #68058 for Synced Patterns
Update Navigation block to render hooked inner blocks #57754 for Navigation

and

Filtered post content is truncated in post-content block #68605 for the original issue

It'd be great if we could divvy up testing to speed it up! (Ideally, we can land it on Thursday or Friday, so it can be part of another npm package release and sync prior to WP 6.8 Beta 1). If you'd like to help, edit this comment to add yourself to the above list, next to whichever block you're going to test, and leave a comment with your findings once you're done 😊

Tentatively pinging @ryelle @richtabor @gziolo @tjcafferkey to ask for help with testing, if you have a bit of time available 🙌

Finally, I've already started working on the Core port. I'll add some test coverage there and see to landing it before Beta 1.

Mamaduka · 2025-01-29T16:02:37Z

Thanks for working on this, @ockham!

Does core have PHPUnit test coverage for these methods? Can we add additional unit tests?

The release date of the WP 6.8 Beta 1 is March 4, 2025, so there will be at least one more Gutenberg release.

ockham · 2025-01-29T16:55:33Z

Thanks for working on this, @ockham!

Does core have PHPUnit test coverage for these methods?

Not yet. apply_block_hooks_to_content_from_post_object is used either as a filter (for the_content), or from within blocks code. Due to the nature of those callsites, I don't think any of the containing methods have unit test coverage themselves. (It'd be pretty complex to set up test fixtures for those; arguably, they'd be integration tests rather than unit tests.)

Can we add additional unit tests?

Yes! I'm planning to add unit test coverage for apply_block_hooks_to_content_from_post_object to the Core port tomorrow.

The release date of the WP 6.8 Beta 1 is March 4, 2025, so there will be at least one more Gutenberg release.

Oh, for what date is that GB release scheduled? (Also, we used to have a GB cut-off release some 2-3 weeks prior to WP Beta 1, after which any changes in GB had to be manually cherry-picked (to GB's wp/x.y branch) in order to have them synced over to Core. Did we change that policy?)

Mamaduka · 2025-01-29T17:13:03Z

Thanks again, @ockham!

Oh, for what date is that GB release scheduled? (Also, we used to have a GB cut-off release some 2-3 weeks prior to WP Beta 1, after which any changes in GB had to be manually cherry-picked (to GB's wp/x.y branch) in order to have them synced over to Core. Did we change that policy?)

The plugin cut-off happens a week before Beta 1 - https://make.wordpress.org/core/handbook/about/release-cycle/block-editor-release-process-for-major-releases/#scheduling-the-last-editor-release-and-communicating-deadlines.

ockham · 2025-01-29T17:42:07Z

The plugin cut-off happens a week before Beta 1 - https://make.wordpress.org/core/handbook/about/release-cycle/block-editor-release-process-for-major-releases/#scheduling-the-last-editor-release-and-communicating-deadlines.

🤦‍♂️ For whatever reason, I had February 4 as the date for Beta 1 in my mind -- i.e. in less than a week from now -- even though you wrote March. Apologies -- took me a moment to realize!

Anyway, that gives us plenty more time to work on this 😅

gziolo

Code changes look good. It's definitely much anticipated refactoring that helps to remove some code duplication. In my testing, everything works as expected for the edge cases covered that regressed. I also repeated the testing steps outline in #67272. It would be nice to add some e2e testing coverage as this started to be very complex process to find and repeat all these steps.

One thing that might need closer look is when using the Classic block in the post content. I couldn't make it work with inserting the hooked block as the last or first child in the core/post-content block.

Mamaduka · 2025-01-31T08:20:34Z

Thank you, @ockham and @gziolo!

Are there any other blockers, or can we merge this?

ockham · 2025-01-31T08:26:45Z

No blockers from my side!

I'll file issues for the e2e tests, and for the problem with the classic block that @gziolo found.

ockham · 2025-01-31T12:00:32Z

Thank you for merging this, @Mamaduka!

I've filed

ockham added 4 commits January 28, 2025 14:36

Block Hooks: Repurpose GB compat function

235e851

Block Hooks: Absorb temporary wrapper block functionality into apply_…

2c18d63

…block_hooks_to_content

Remove now-obsolete logic from Post Content block

ab04995

Remove now-obsolete logic from Synced Pattern block

508c116

ockham added [Type] Bug An existing feature does not function as intended [Feature] Block hooks labels Jan 28, 2025

ockham self-assigned this Jan 28, 2025

This was referenced Jan 28, 2025

Filtered post content is truncated in post-content block #68605

Closed

Synced Patterns: Apply Block Hooks #68058

Merged

Whitespace

555cb7e

ockham changed the title ~~Block Hooks: Absorb temporary parent wrapper block into gutenberg_apply_block_hooks_to_post_content~~ Block Hooks: Fix truncation of post content Jan 28, 2025

ockham added 4 commits January 28, 2025 15:29

Use in gutenberg_insert_hooked_blocks_into_rest_response

d0fe0eb

Remove now-obsolete variable

acb88e5

Use in Navigation block

87d8855

Navigation block: Remove now-obsolete Block Hooks helpers

59d9431

This was referenced Jan 28, 2025

Navigation Block: Deprecate obsolete Block Hooks helper functions WordPress/wordpress-develop#7849

Draft

Block Hooks: Apply to Post Content (on frontend and in editor) #67272

Merged

ockham added 5 commits January 29, 2025 11:08

Rename function

fb93422

Replace filters correctly

b4a070d

Rename context to post

1950380

Add type annotation

558cb74

Add PHPDoc

e0e001e

ockham mentioned this pull request Jan 29, 2025

Block Hooks: Add apply_block_hooks_to_content_from_post_object WordPress/wordpress-develop#8212

Draft

Add backport changelog

8d1e654

ockham commented Jan 29, 2025

View reviewed changes

ockham marked this pull request as ready for review January 29, 2025 15:56

ockham requested review from spacedmonkey and ajitbohra as code owners January 29, 2025 15:56

ockham requested a review from fabiankaegy as a code owner January 29, 2025 15:56

gziolo approved these changes Jan 30, 2025

View reviewed changes

Mamaduka merged commit abd963b into trunk Jan 31, 2025
72 checks passed

Mamaduka deleted the fix/remove-serialized-parent-block branch January 31, 2025 08:35

github-actions bot mentioned this pull request Jan 31, 2025

PHP backports for WP 6.8 #68712

Open

github-actions bot added this to the Gutenberg 20.3 milestone Jan 31, 2025

This was referenced Jan 31, 2025

Block Hooks: Add end-to-end (e2e) test coverage. #68986

Open

Block Hooks: Not properly working with Classic block in Post Content (first/last child insertion) #68988

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Block Hooks: Fix truncation of post content #68926

Block Hooks: Fix truncation of post content #68926

ockham commented Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 29, 2025

ockham Jan 29, 2025

ockham Jan 29, 2025

github-actions bot commented Jan 29, 2025 •

edited

Loading

ockham commented Jan 29, 2025

Mamaduka commented Jan 29, 2025 •

edited

Loading

ockham commented Jan 29, 2025

Mamaduka commented Jan 29, 2025

ockham commented Jan 29, 2025

gziolo left a comment •

edited

Loading

Mamaduka commented Jan 31, 2025

ockham commented Jan 31, 2025

ockham commented Jan 31, 2025

Block Hooks: Fix truncation of post content #68926

Block Hooks: Fix truncation of post content #68926

Conversation

ockham commented Jan 28, 2025 • edited Loading

What?

How?

Testing Instructions

github-actions bot commented Jan 29, 2025

ockham Jan 29, 2025

Choose a reason for hiding this comment

ockham Jan 29, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 29, 2025 • edited Loading

Unlinked Accounts

ockham commented Jan 29, 2025

Mamaduka commented Jan 29, 2025 • edited Loading

ockham commented Jan 29, 2025

Mamaduka commented Jan 29, 2025

ockham commented Jan 29, 2025

gziolo left a comment • edited Loading

Choose a reason for hiding this comment

Mamaduka commented Jan 31, 2025

ockham commented Jan 31, 2025

ockham commented Jan 31, 2025

ockham commented Jan 28, 2025 •

edited

Loading

github-actions bot commented Jan 29, 2025 •

edited

Loading

Mamaduka commented Jan 29, 2025 •

edited

Loading

gziolo left a comment •

edited

Loading