Theme.json: Remove custom prefixes from properties that did not land in 5.8 #34485
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
aaronrobertshaw
added
[Type] Bug
aaronrobertshaw
requested review from
chrisvanpatten,
ellatrix,
spacedmonkey and
TimothyBJacobs
as code owners
7 tasks
|
Size Change: +232 B (0%) Total Size: 1.07 MB
ℹ️ View Unchanged
|
|
I'm thinking about what @mtias mentioned here. Perhaps we can build two back-compatibility bridges to cover most of the cases and give people time to adapt? I'm thinking of:
These bridges can be in place for a few Gutenberg versions or until we land this in WordPress 5.9. We should give a heads up in the Gutenberg release post or adding deprecations, etc. I reckon there're still ways in which this change forces 3rd parties to adapt: for example, if they're working directly with the cc @jorgefilipecosta for thoughts. |
This was referenced Sep 2, 2021
I missed that comment, thanks.
Your suggestions work for me. I'm happy to put this PR on ice and close it after splitting out the minor bug fixes. |
|
Closing this PR as the minor bug fixes are in their own PRs now. |
|
Nice work on splitting the PR to land faster the bugfixes 👏 My comment wasn't meant to close this but to add those two things! My stance would be that those are enough given the experimental nature of the existing properties. It's also best to do it as far as possible from the integration cycle (we want to give people plenty of time to adapt instead of having to change things at the last minute). |
|
Ok, thanks, I jumped the gun closing this one then. I'll add the requested updates to useSetting along with a new theme.json schema class to map the custom prefixed properties over to their newer versions for v1. |
aaronrobertshaw
force-pushed
the
remove/theme-json-custom-prefixes
branch
from
c0753f5 to
ad0bec5
Compare
|
I've rebased this PR to bring it up-to-date. The A new v1 schema class was added as an interim measure to migrate the prefixed flags to their nonprefixed version within the It's entirely possible I've missed something here so I'll give this further testing tomorrow. In the meantime, @oandregal can you confirm we still want these changes to land for 5.9 and the updates to |
oandregal
reviewed
Oct 26, 2021
oandregal
reviewed
Oct 26, 2021
oandregal
reviewed
Oct 26, 2021
oandregal
reviewed
Oct 26, 2021
The `customTextDecorations` and `customTextTransforms` properties needed to be mapped to the singular versions `textDecoration` and `textTransform` respectively in order to avoid conflicts with i18n of presets for them.
The customRadius flag did actually land in 5.8 and must be maintained until we switch to a full v2 of the theme.json schema.
aaronrobertshaw
force-pushed
the
remove/theme-json-custom-prefixes
branch
from
ad0bec5 to
7efa5d6
Compare
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.
Related: #31366 (comment), #31366 (comment)
Description
This PR removes the
customprefix from properties within theme.json that do not require it. Those that remain have already landed in WP 5.8 and will be addressed in the future by adding a migration fromv1to the futurev2theme.json schema.How has this been tested?
Testing instructions
false.Example gist here
{ "settings": { "border": { "color": false, "customRadius": false, "style": false, "width": false }, "typography": { "fontStyle": false, "fontWeight": false, "textDecoration": false, "textTransform": false, "letterSpacing": false, }, } }fontStylefontWeighttextDecorationstextTransformsletterSpacingcustomprefixed form e.g.customFontStyleorcustomColor. Then confirm the relevant controls still display correctly in both editors.useSettingwill return the correct value when using the deprecatedcustomprefixed flag.Example patch to test `useSetting` with deprecated flags
Types of changes
Enhancement.
Breaking change ( 3rd parties working directly with theme.json or store shape will need updating )
Checklist:
*.native.jsfiles for terms that need renaming or removal).