Skip to content

Update theme.json docs for WordPress 5.8 #33131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oandregal merged 4 commits into from
Jul 2, 2021
Merged

Update theme.json docs for WordPress 5.8 #33131

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e3296c9
Intro and version
oandregal Jul 1, 2021
6ee3a24
Settings: WordPress vs Gutenberg
oandregal Jul 1, 2021
1c0c7a3
Styles: WordPress vs Gutenberg
oandregal Jul 1, 2021
2e4dcbc
Callouts for customTemplates and templateParts
oandregal Jul 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Intro and version
  • Loading branch information
@oandregal
oandregal committed Jul 1, 2021
commit e3296c97336f81ccc8ffb652e5807cef811243db
12 changes: 4 additions & 8 deletions docs/how-to-guides/themes/theme-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# Global Settings & Styles (theme.json)

<div class="callout callout-alert">
These features are still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.

Documentation has been shared early to surface what’s being worked on and invite feedback from those experimenting with the APIs. Please share your feedback in the weekly #core-editor or #fse-outreach-experiment channels in Slack, or async in GitHub issues.
</div>

This is documentation for the current direction and work in progress about how themes can hook into the various sub-systems that the Block Editor provides.
WordPress 5.8 comes with [a new mechanism](https://make.wordpress.org/core/2021/06/25/introducing-theme-json-in-wordpress-5-8/) to configure the editor that enables a finer-grained control and introduces the first step in managing styles for future WordPress releases: the `theme.json` file. This page documents its format.

- Rationale
- Settings for the block editor
Expand Down Expand Up @@ -152,7 +146,9 @@ This specification is the same for the three different origins that use this for

### Version

This field describes the format of the `theme.json` file and it's used to detect different versions and migrate them to the latest format.
This field describes the format of the `theme.json` file. The current and only version is 1.

WordPress 5.8 will ignore the contents of any `theme.json` whose version is not equals to the current. Should the Gutenberg plugin need it, it'll update the version and will add the corresponding migration mechanisms from older versions.

### Settings

Expand Down