Skip to content

theme.json docs: add examples and highlight backward compatibility #33421

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 14, 2021
Merged

theme.json docs: add examples and highlight backward compatibility #33421

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
23e578c
Make backward compatibility more prominent
oandregal Jul 14, 2021
7763c3a
Move sentence outside incorrect section
oandregal Jul 14, 2021
9fa3529
Put examples together
oandregal Jul 14, 2021
bbe8ded
Add examples in the TOC
oandregal Jul 14, 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
Prev Previous commit
Next Next commit
Move sentence outside incorrect section
  • Loading branch information
@oandregal
oandregal committed Jul 14, 2021
commit 7763c3a76b97a1e4c9c5df99a4a7fa57293456c8
4 changes: 2 additions & 2 deletions docs/how-to-guides/themes/theme-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,10 +268,10 @@ The settings section has the following structure:

{% end %}

#### Backward compatibility with add_theme_support

Each block can configure any of these settings separately, providing a more fine-grained control over what exists via `add_theme_support`. The settings declared at the top-level affect to all blocks, unless a particular block overwrites it. It's a way to provide inheritance and configure all blocks at once.

#### Backward compatibility with add_theme_support

To retain backward compatibility, the existing `add_theme_support` declarations that configure the block editor are retrofit in the proper categories for the top-level section. For example, if a theme uses `add_theme_support('disable-custom-colors')`, it'll be the same as setting `settings.color.custom` to `false`. If the `theme.json` contains any settings, these will take precedence over the values declared via `add_theme_support`. This is the complete list of equivalences:

| add_theme_support | theme.json setting |
Expand Down