Template activation: allow empty array to be set #72011
Merged
Conversation
This file contains hidden or 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
|
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. |
ellatrix
commented
Oct 1, 2025
| // To do: figure out why the REST API deletes the option when | ||
| // it's set to an empty object. That would trigger the migration | ||
| // function, which will make all templates in the database active. | ||
| activeTemplates.__preventCollapse = 0; |
Member
Author
There was a problem hiding this comment.
This no longer seems needed either. We'll see if the tests pass.
|
Size Change: +127 B (+0.01%) Total Size: 1.96 MB
ℹ️ View Unchanged
|
ellatrix
force-pushed
the
fix/template-activation-initial
branch
3 times, most recently
from
a2678c9 to
67679c1
Compare
ellatrix
force-pushed
the
fix/template-activation-initial
branch
from
67679c1 to
dbfe960
Compare
ellatrix
commented
Oct 7, 2025
| ); | ||
|
|
||
| if ( registeredTemplateWithSlug ) { | ||
| return registeredTemplateWithSlug.id; |
Member
Author
There was a problem hiding this comment.
I'm reverting what I did in https://github.com/WordPress/gutenberg/pull/72049/files#diff-166c46de8d08a1bf4740eae54f4a8fa2296684af9f318ec0baa31f248a9c44be, which was wrong. We shouldn't try to resolve a template for this slug. We should check the list of templates we have, and due to the changes we need to check both registered and user templates. In the long term we should really add a way to query the endpoint by slug.
This reverts commit dbfe960.
|
Flaky tests detected in 8cff955. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/18312666400
|
ellatrix
added
the
Backport to Gutenberg RC
youknowriad
approved these changes
Oct 7, 2025
youknowriad
reviewed
Oct 7, 2025
| array( | ||
| 'type' => 'object', | ||
| // Do not set the default value to an empty array! For some reason | ||
| // that will prevent the option from being set to an empty array. |
Contributor
There was a problem hiding this comment.
I'm guessing it's like the "block defaults", when the value you want to set equals the default value it's not persisted at all.
Member
Author
There was a problem hiding this comment.
Right, I thought it would only affect the return value in case the option didn't exist.
Member
Author
|
Thanks Riad |
mcsf
reviewed
Oct 7, 2025
Contributor
mcsf
left a comment
mcsf
left a comment
There was a problem hiding this comment.
I feel out my depth on some of the details, like the auto-drafting, etc. But LGTM on the main thing.
| add_action( 'init', 'gutenberg_migrate_existing_templates' ); | ||
| function gutenberg_migrate_existing_templates() { | ||
| $active_templates = get_option( 'active_templates' ); | ||
| $active_templates = get_option( 'active_templates', false ); |
Contributor
There was a problem hiding this comment.
FYI, false is already the default value for that argument.
Member
Author
There was a problem hiding this comment.
Yeah, I saw, but I wanted to be explicit so it's clearly relating to the condition below
cbravobernal
pushed a commit
that referenced
this pull request
Oct 8, 2025
Contributor
|
I just cherry-picked this PR to the release/21.8 branch to get it included in the next release: c0131bc |
cbravobernal
removed
the
Backport to Gutenberg RC
sidharthpandita1
pushed a commit
to sidharthpandita1/gutenberg
that referenced
this pull request
Oct 10, 2025
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?
I ran into this issue while demoing the features to @bph and @justintadlock. I had wiped the template option + trashed all my templates. This allows the migration to kick in, but since I had no templates to migrate, it tried to set the
active_templatesoption to an empty array. This failed, it seems because the default value of the option is an empty array, and this kept the migration function running until I created my first template, which it then activated. Any following templates that I created would not get activated because filling the option would stop the migration function.Why?
See above.
How?
We need
update_optionto work with an empty array. Debugging reveals thatregister_settingwas preventing that, in particular thedefault, probably because it thought the option is already an empty array.Additionally, some e2e tests started breaking because the first template created was automatically activating these tests, creating false positives.
Testing Instructions
Go through the steps above: delete all templates and the
active_templatesoption in the database. Now duplicate one of the theme templates. Check the front-end to make sure that the template was not immediately activated by itself.Testing Instructions for Keyboard
Screenshots or screencast