Add filter to allow extending the list of post content blocks #60068
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fabiankaegy
added
[Type] Enhancement
fabiankaegy
requested review from
ajitbohra,
ryanwelcher,
juanmaguitar and
ndiego
as code owners
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: +21 B (0%) Total Size: 1.72 MB
ℹ️ View Unchanged
|
noisysocks
reviewed
Mar 26, 2024
|
@noisysocks the post editor of posts and for that manner all custom post types that use the block editor also supports the template preview :) I'm very open to alternative naming. But I think pages is incorrect. |
fabiankaegy
force-pushed
the
feature/allow-filtering-list-of-post-content-block-types
branch
from
2ae518c to
e19f1bb
Compare
fabiankaegy
deleted the
feature/allow-filtering-list-of-post-content-block-types
branch
fabiankaegy
added
the
Needs Dev Note
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Mar 27, 2024
…ess#60068) Co-authored-by: fabiankaegy <[email protected]> Co-authored-by: noisysocks <[email protected]> Co-authored-by: Mamaduka <[email protected]>
youknowriad
reviewed
Apr 1, 2024
| const CONTENT_ONLY_BLOCKS = [ | ||
| 'core/post-content', | ||
| 'core/post-featured-image', | ||
| const CONTENT_ONLY_BLOCKS = applyFilters( 'editor.postContentBlockTypes', [ |
There was a problem hiding this comment.
To be honest, I'm not a big fan of this filter. I think ultimately, this is probably better as a property of the block. That said, it's hard to make it a property of the block because it doesn't really make sense in a generic block editor context. It's a WP specific property.
There was a problem hiding this comment.
Im more than happy to experiment more with other approaches before this gets merged to core.
I took this route because @noisysocks recommended we go with this approach over having another block support.
I'm not at all set on approach here :)
There was a problem hiding this comment.
Yeah I'm hesitant to have this feature escape @wordpress/editor. It's very WP Admin specific.
cbravobernal
pushed a commit
to garridinsi/gutenberg
that referenced
this pull request
Apr 9, 2024
…ess#60068) Co-authored-by: fabiankaegy <[email protected]> Co-authored-by: noisysocks <[email protected]> Co-authored-by: Mamaduka <[email protected]>
49 tasks
Dev Note Draft:Add filter to modify the list of post content block typesWhen WordPress renders a post/page's template at the same time as the content, most template blocks are disabled/locked. However, some blocks, like the Post Title, Post Content, and Post Featured Image, still allow users to edit the content within them. They get rendered in the WordPress 6.6 now adds a filter to modify this list of blocks that should get the import { addFilter } from '@wordpress/hooks';
function addCustomPostContentBlockTypes( blockTypes ) {
return [ ...blockTypes, 'namespace/hello-world' ];
}
addFilter(
'editor.postContentBlockTypes',
'namespace/add-custom-post-content-block-types',
addCustomPostContentBlockTypes
);Note: It is important that only settings that store their data in custom ways are exposed when rendered in this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Add a filter to allow extending the hardcoded list of post content blocks.
Closing: #59290
Why?
This list is used to determine which blocks should allow editing their content even when displayed in a locked template. an example of this is the post featured image block. When building custom blocks that save to a custom meta field for example is is crucial to also allow this kind of experience where the field can be edited even when the block is used outside of the post content in the template.
How?
By adding a filter that allows you to change the list of block names that should be enabled.