Editor: Persist user's 'Show Template' preference #69286
Merged
+148
−54
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
Mamaduka
added
[Type] Enhancement
This comment was marked as outdated.
This comment was marked as outdated.
|
Size Change: +243 B (+0.01%) Total Size: 1.84 MB
ℹ️ View Unchanged
|
Mamaduka
force-pushed
the
try/editor-persist-rendering-mode
branch
from
614e9d1 to
05813a9
Compare
|
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. |
|
I think this is ready for initial testing, but I'll need to follow up on CI failures. |
fabiankaegy
approved these changes
Feb 25, 2025
There was a problem hiding this comment.
This works exactly as advertised and is the missing link that really ties this whole "Show Template" feature together.
I also tested for any regressions of unwanted flashes of incorrect rendering mode in the rendering of the editor and it looks exactly as expected :)
Really cool to see this come together in this way :) 🚀
Mamaduka
commented
Feb 25, 2025
Comment on lines
+49
to
+51
| // There are two separate settings OPTIONS requests. We should fix | ||
| // so the one for canUser and getEntityRecord are reused. | ||
| '/wp/v2/settings', |
Mamaduka
commented
Feb 25, 2025
| @@ -38,7 +38,7 @@ export async function initializeEditor( props, { component } = {} ) { | |||
| resolutionSpy.mockImplementation( ( selectorName, args ) => { | |||
| // The mobile editor only supports the `post-only` rendering mode, so we | |||
| // presume a resolved `getPostType` selector to unblock editor rendering. | |||
| if ( 'getPostType' === selectorName ) { | |||
| if ( [ 'getPostType', 'getCurrentTheme' ].includes( selectorName ) ) { | |||
There was a problem hiding this comment.
This one was annoying to track down 😄
Mamaduka
commented
Feb 25, 2025
Comment on lines
+244
to
+250
| // Wait for the post type and theme resolution. | ||
| if ( | ||
| ! hasFinishedResolution( 'getPostType', [ postType ] ) || | ||
| ! hasFinishedResolution( 'getCurrentTheme' ) | ||
| ) { | ||
| return undefined; | ||
| } |
There was a problem hiding this comment.
Waiting for a resolution seems like a better approach. In rare cases when selectors resolve but return undefined, this allows using a post-only fallback.
joemcgill
approved these changes
Feb 25, 2025
Thanks for the reminder. I'll expand on this. Update: @joemcgill, I expanded a little bit on this in the "How" section. |
|
@t-hamano and @stokesman, since you both recently worked to improve or fix the What I have for now
Screeenshot
|
|
I haven't tested it thoroughly yet, but it might be because the metabox initialization relies solely on I've pushed 65714de. Locally, the metabox test passes. |
|
Thank you, @t-hamano! I think that was it. I totally forgot that the metaboxes are initialized outside the It got me thinking that maybe in the future, we should move it into a component that's called inside the |
t-hamano
approved these changes
Feb 26, 2025
There was a problem hiding this comment.
It seems to work fine to me.
I was concerned that the meta box would be reinitialized every time I toggled "Show template", but after __unstableIsEditorReady changes to true once, the meta box initialization should not be executed.
fabiankaegy
approved these changes
Feb 26, 2025
|
Thanks, everyone, for testing! |
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?
Closes #68250.
Alternative to #68257.
PR introduces user preference persistence for the new default rendering mode (Show Template), while keeping the editor's rendering mode state separate.
Why an alternative
I'm hesitant about handling user preferences logic inside the
getRenderingModeandsetRenderingMode. Why?useNavigateToEntityRecordfor example use cases.EditorProvidermakes it easier to control how fast the component can mark the editor as "ready". When user preference isn'ttemplate-lockedthe component doesn't have to wait for the template to be resolved.setBockEditingMode. While it's early to judge here, I can see some similarities. You can read more about the subject here - https://make.wordpress.org/core/2024/09/12/gutenberg-development-practices-and-common-pitfalls/#:~:text=Be%20declarative%20as%20much%20as%20possible.getDefaultRenderingModeselector helps derive the state. It was getting too complex to keep inside themapSelectcallback.How?
getDefaultRenderingModeselector andsetDefaultRenderingModeaction. They help keep logic simple inside the components.The user preferences are retained when switching themes. If the user selects
template-lockedmode for a post type in a block theme and switches to classic, the editor will try to render that post type withtemplate-lockedand fail. Block editor can only render block templates; it cannot render PHP.To prevent users from accidentally breaking editor rendering when switching between themes, rendering mode preferences are stored using the theme stylesheet as a top-level key.
{ "twentytwentyfive": { "post": "post-only", "page": "template-locked" } }Testing Instructions
template-lockedstate.post-onlyas the default rendering mode.post-only.Testing Instructions for Keyboard
Same.