Fix: Post_type template is not used when creating a page in site editor. #62488
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
[Type] Bug
|
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. |
|
This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress. If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged. If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack. Thank you! ❤️ View changed files❔ lib/rest-api.php |
|
Size Change: +57 B (0%) Total Size: 1.76 MB
ℹ️ View Unchanged
|
oandregal
reviewed
Jun 19, 2024
oandregal
reviewed
Jun 19, 2024
lib/rest-api.php
Outdated
| if ( ! empty( $post_type ) && ! empty( $post_type->template_lock ) ) { | ||
| return $post_type->template_lock; | ||
| } | ||
| return null; |
There was a problem hiding this comment.
According to this other logic, it should return false.
There was a problem hiding this comment.
Hi @oandregal, setting a value of false is the same as not having template_lock, I guess we can ignore the false values, and return null/not return when locking is not set either because there is no locking referred at all or because it is false. I don't see any downside to that and this would allow us to use an enum as a type with only array( 'all', 'insert', 'contentOnly' ). We can not really have a type that is enum or boolean. What do you think?
There was a problem hiding this comment.
What about nested content? Is there a difference between false or null in that scenario? I'm thinking about the locking lookup: if I remember this correctly, if a block (wp_navigation or wp_block types, for example) doesn't have a lock, we look it up above in the parents. I don't remember the details of "does not have a lock": was that checking for false or for null/non existence (or both)?
Other than double checking that scenario, the current approach makes sense to me.
There was a problem hiding this comment.
The nested locking is something at the block level, this template lock is only used now on edit-post, and the template locks of CPTs can not be nested. The locking of templates on CPTs is always top level there is never a need to overite with false as may happen on the block level. So I think we are safe not returning the false value at all.
There was a problem hiding this comment.
Ah, that sounds good. Thanks for the braindump.
oandregal
approved these changes
Jun 19, 2024
oandregal
added
the
Backport to WP Beta/RC
Co-authored-by: André <583546+oandregal@users.noreply.github.com>
jorgefilipecosta
force-pushed
the
fix/Post_Type-template-is-not-used-when-creating-a-page-in-site-editor
branch
2 times, most recently
from
22a9f0a
to
f51bceb
Compare
ellatrix
reviewed
Jun 20, 2024
| ); | ||
| } | ||
| } | ||
| add_action( 'rest_api_init', 'gutenberg_register_wp_rest_post_types_controller_fields' ); |
There was a problem hiding this comment.
Should we be worried about changes to the REST API this late in the release cycle? This PR will need a backport PR asap.
There was a problem hiding this comment.
We are only adding two fields that will for sure be required, so I don't think we have back-compatibility problems or unexpected issues. I'm preparing a backport PR, but I don't have a strong option. we can opt for not include this fix in WP 6.6 if you think it is safer.
jorgefilipecosta
deleted the
fix/Post_Type-template-is-not-used-when-creating-a-page-in-site-editor
branch
mcsf
reviewed
Jun 20, 2024
| }, | ||
| 'schema' => array( | ||
| 'type' => 'array', | ||
| 'description' => __( 'The template associated with the post type.', 'gutenberg' ), |
There was a problem hiding this comment.
Should the phrasing reflect that the template is optional and refers to block templates as opposed to a wp_template? For example:
-The template associated with the post type.
+The block template associated with the post type, if it exists.
This was referenced Jun 20, 2024
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.
Fixes: #60710
The site editor now allows to create a new page but if the page post type has a template assigned to it the template is ignored.
This PR fixes the issue.
To fix the issue, the Rest API has been extended for the types endpoint. Two new fields were added template and template_lock.
Testing Instructions
I added the following test code to scrip-loader.php.
I created a new page on the site editor and verified the template was used as expected.