Skip to content
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.

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

Document new global styles filters #44111

Merged
merged 3 commits into from
Sep 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/how-to-guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Porting PHP meta boxes to blocks or sidebar plugins is highly encouraged, learn

By default, blocks provide their styles to enable basic support for blocks in themes without any change. Themes can add/override these styles, or rely on defaults.

There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/how-to-guides/themes/theme-support.md).
There are some advanced block features which require opt-in support in the theme. See [theme support](/docs/how-to-guides/themes/theme-support.md) and [how to filter global styles](/docs/reference-guides/filters/global-styles-filters.md).

## Autocomplete

Expand Down
6 changes: 6 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,12 @@
"markdown_source": "../docs/reference-guides/filters/autocomplete-filters.md",
"parent": "filters"
},
{
"title": "Global Styles Filters",
"slug": "global-styles-filters",
"markdown_source": "../docs/reference-guides/filters/global-styles-filters.md",
"parent": "filters"
},
{
"title": "SlotFills Reference",
"slug": "slotfills",
Expand Down
1 change: 1 addition & 0 deletions docs/reference-guides/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
- [i18n Hooks](/docs/reference-guides/filters/i18n-filters.md)
- [Parser Hooks](/docs/reference-guides/filters/parser-filters.md)
- [Autocomplete](/docs/reference-guides/filters/autocomplete-filters.md)
- [Global Styles Hooks](/docs/reference-guides/filters/global-styles-filters.md)

## [SlotFills Reference](/docs/reference-guides/slotfills/README.md)

Expand Down
42 changes: 42 additions & 0 deletions docs/reference-guides/filters/global-styles-filters.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Global Styles Filters

WordPress 6.1 has introduced some server-side filters to hook into the data provided to Global Styles & Settings:

- `global_styles_default`: hooks into the default data provided by WordPress
- `global_styles_blocks`: hooks into the data provided by the blocks
- `global_styles_theme`: hooks into the data provided by the theme
- `global_styles_user`: hooks into the data provided by the user

Each filter receives an instance of the `WP_Theme_JSON_Data` class with the data for the respective layer. To provide new data, the filter callback needs to use the `update_with( $new_data )` method, where `$new_data` is a valid `theme.json`-like structure. As with any `theme.json`, the new data needs to declare which `version` of the `theme.json` is using, so it can correctly be migrated to the runtime one, should it be different.

_Example:_

This is how to pass a new color palette for the theme and disable the text color UI:

```php
function filter_global_styles_theme( $theme_json ){
$new_data = array(
'version' => 2,
'settings' => array(
'color' => array(
'text' => false,
'palette' => array( /* New palette */
array(
'slug' => 'foreground',
'color' => 'black',
'name' => __( 'Foreground', 'theme-domain' ),
),
array(
'slug' => 'background',
'color' => 'white',
'name' => __( 'Background', 'theme-domain' ),
),
),
),
),
);

return $theme_json->update_with( $new_data );
}
add_filter( 'global_styles_theme', 'filter_global_styles_theme' );
```
3 changes: 3 additions & 0 deletions docs/toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,9 @@
{ "docs/reference-guides/filters/parser-filters.md": [] },
{
"docs/reference-guides/filters/autocomplete-filters.md": []
},
{
"docs/reference-guides/filters/global-styles-filters.md": []
}
]
},
Expand Down