Add: Post type restriction API for patterns. #41842
Merged
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
jorgefilipecosta
added
the
[Feature] Patterns
|
Size Change: +58 B (0%) Total Size: 1.25 MB
ℹ️ View Unchanged
|
ntsekouras
reviewed
Jun 22, 2022
| () => unionBy( settingsBlockPatterns, restBlockPatterns, 'name' ), | ||
| [ settingsBlockPatterns, restBlockPatterns ] | ||
| ); | ||
| const blockPatterns = useMemo( () => { |
There was a problem hiding this comment.
I'm not sure this is the right place to do this(editor settings). I haven't tested this but an example could be in a page insert a Query Loop that shows let's say book post type. Shouldn't we show the related patterns there?
There was a problem hiding this comment.
Hi @ntsekouras,
The idea of the postType property in a pattern is to restrict that pattern to be used only in a given post type, and excluded from all the other post types.
So, for example, a pattern that is an arrangement of how a single book can be rendered e.g: with image at the site, description, etc could be restricted to the book post type. This way the pattern will only be available in books.
A pattern that is a query of books and that the plan is to make available to insert on pages or templates etc should not use post-type books as that pattern is not restricted to book post types.
bph
added
the
Needs Dev Note
|
@jorgefilipecosta and @ntsekouras any update on this PR? I do not believe the documentation on |
|
Hi @ndiego, This PR seems ready and just needs approval. |
jorgefilipecosta
force-pushed
the
add/post-type-restrictions-on-patterns
branch
from
42f9062 to
b191543
Compare
jorgefilipecosta
force-pushed
the
add/post-type-restrictions-on-patterns
branch
from
b191543 to
f00b084
Compare
|
Could be tested with the following sample code: |
|
@jorgefilipecosta I just tested this, and it works great, but it does make the patterns unavailable in the Site Editor. I'm assuming that is the intended result, but perhaps something we add to the documentation of this property? |
In thinking more about this, I think they should be available in the Site Editor. Perhaps we add another property to enable/disable patterns in the Site Editor 🤔 |
Hi @ndiego, I think yes we should document, but it is expected they are not part of the site editor. The patterns using this are supposed to be used as content of specific post types. The site editor is editing templates and not the content.. |
Yeah, that makes sense. All looks good to me then. LGTM! |
|
Sorry for repeating my question, but why not make this restriction via REST API by introducing the |
Hi @Mamaduka, here when getting patterns for a post, we also want patterns that don't specify any post type, not just patterns with post type. Normally in rest API filter parameters, if we specify a parameter, we return objects matching it e.g: post type post would return only patterns with postType post and not the patterns that don't contain post type. So this rest API endpoint parameter would work a little bit differently. Also, this feature is something we are experimenting with so I would prefer to avoid that change to the REST API and see where the feature goes and in the future, we can move the filtering to the rest API and do the optimization. |
|
Thanks for the clarification, @jorgefilipecosta. 🙇 |
|
Regarding the site editor & the patterns not being available there if they have a postType declared. Note that a pattern can declare that it should also be listed for For example, this pattern will only be listed in the site editor: // Only listed at the site editor
register_block_pattern( 'custom-template-pattern', array(
'title' => _x( 'A template pattern', 'Template pattern ', 'gutenberg' ),
'postTypes' => array( 'wp_template' ),
'content' => '<p>Custom Template Pattern</p>'
) ); |
|
Nice to see this merged! Should it be tagged for 6.1 porting? |
@mcsf Yeah, Matias just covered this in the 6.1 walkthrough, so it would be ported in. |
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.
This PR implements the postTypes restriction for patterns. If a pattern specifies some postTypes the pattern will only be show if one of the post types is being edited.
API
Depends on #41791 which changes the rest endpoint to include the post-type property.