Update hook's names from `global_styles_*` to `theme_json_*` by oandregal · Pull Request #44159 · WordPress/gutenberg

oandregal · 2022-09-14T15:11:55Z

What?

In #44015 we've added a few hooks to filter the theme.json data at the different layer levels. This PR proposes that we rename them:

global_styles_default => theme_json_default
global_styles_blocks => theme_json_blocks
global_styles_theme => theme_json_theme
global_styles_user => theme_json_user

Why?

Because we're not filtering "global styles" but a specific part of it: the theme.json data it takes as input. The new names make this clearer. We also leave the global_styles_ prefix free for the future, in case we want to offer other kind of filters.

How?

Renames the filters.
Updates the docs.

Testing Instructions

Use the filters to modify some of the data. For example, this is how the theme data can be modified:

<?php

function filter_theme_json_theme( $theme_json ){
        $new_data = array(
                'version'  => 2,
                'settings' => array(
                        'color' => array(
                                'text'  => false, /* disable text color UI */
                                'palette'    => array( /* New palette */
                                        array(
                                                'slug'  => 'foreground',
                                                'color' => 'red',
                                                'name'  => 'Foreground',
                                        ),
                                ),
                        ),
                ),
        );
        return $theme_json->update_with( $new_data );
}
add_filter( 'theme_json_theme', 'filter_theme_json_theme' );

jorgefilipecosta

LGTM 👍

oandregal · 2022-09-14T15:26:22Z

docs/reference-guides/filters/global-styles-filters.md

@@ -1,11 +1,11 @@
 # Global Styles Filters

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


This only updates the names of the filters. I'm undecided as to whether we should rename the "Global Styles Filters" page to "Theme.json Filters". Because it's published to the block editor handbook already, renaming it requires asking someone from the meta team to remove the old one. As it is also works fine if we want to add new filters later, so I lean towards maintaining what we have.

oandregal · 2022-09-14T15:42:18Z

These changes are being backported as part of WordPress/wordpress-develop#3247

bph · 2022-09-14T20:54:53Z

@c4rl0sbr4v0 Shall this be moved to milestone 14.1, so you can cherry-pick for the 14.1 release tomorrow?

cbravobernal · 2022-09-15T06:43:31Z

Cherrypicked for 14.1

ockham · 2022-09-19T17:33:09Z

I just cherry-picked this PR to the wp/6.1 branch to get it included in the next release: 6d76c1b

…6.1. This changeset ports the work done in Gutenberg (released in 14.1) to add hooks to filter the `theme.json` data. Specifically, it adds the following filters: `theme_json_default`, `theme_json_blocks`, `theme_json_theme`, and `theme_json_user`. For more details, see the following Gutenberg pull requests: - [WordPress/gutenberg#44015 gutenberg#44015]: Make global styles data filterable - [WordPress/gutenberg#44109 gutenberg#44109]: Prepare `WP_Theme_JSON_Data` class for backporting - [WordPress/gutenberg#44159 gutenberg#44159]: Update hook's names from `global_styles_*` to `theme_json_*` Props oandregal, czapla, gziolo, bernhard-reiter. See #56467. git-svn-id: https://develop.svn.wordpress.org/trunk@54251 602fd350-edb4-49c9-b593-d223f7449a82

…6.1. This changeset ports the work done in Gutenberg (released in 14.1) to add hooks to filter the `theme.json` data. Specifically, it adds the following filters: `theme_json_default`, `theme_json_blocks`, `theme_json_theme`, and `theme_json_user`. For more details, see the following Gutenberg pull requests: - [WordPress/gutenberg#44015 gutenberg#44015]: Make global styles data filterable - [WordPress/gutenberg#44109 gutenberg#44109]: Prepare `WP_Theme_JSON_Data` class for backporting - [WordPress/gutenberg#44159 gutenberg#44159]: Update hook's names from `global_styles_*` to `theme_json_*` Props oandregal, czapla, gziolo, bernhard-reiter. See #56467. Built from https://develop.svn.wordpress.org/trunk@54251 git-svn-id: http://core.svn.wordpress.org/trunk@53810 1a063a9b-81f0-0310-95a4-ce76da25c4cd

…6.1. This changeset ports the work done in Gutenberg (released in 14.1) to add hooks to filter the `theme.json` data. Specifically, it adds the following filters: `theme_json_default`, `theme_json_blocks`, `theme_json_theme`, and `theme_json_user`. For more details, see the following Gutenberg pull requests: - [WordPress/gutenberg#44015 gutenberg#44015]: Make global styles data filterable - [WordPress/gutenberg#44109 gutenberg#44109]: Prepare `WP_Theme_JSON_Data` class for backporting - [WordPress/gutenberg#44159 gutenberg#44159]: Update hook's names from `global_styles_*` to `theme_json_*` Props oandregal, czapla, gziolo, bernhard-reiter. See #56467. Built from https://develop.svn.wordpress.org/trunk@54251 git-svn-id: https://core.svn.wordpress.org/trunk@53810 1a063a9b-81f0-0310-95a4-ce76da25c4cd

…6.1. This changeset ports the work done in Gutenberg (released in 14.1) to add hooks to filter the `theme.json` data. Specifically, it adds the following filters: `theme_json_default`, `theme_json_blocks`, `theme_json_theme`, and `theme_json_user`. For more details, see the following Gutenberg pull requests: - [WordPress/gutenberg#44015 gutenberg#44015]: Make global styles data filterable - [WordPress/gutenberg#44109 gutenberg#44109]: Prepare `WP_Theme_JSON_Data` class for backporting - [WordPress/gutenberg#44159 gutenberg#44159]: Update hook's names from `global_styles_*` to `theme_json_*` Props oandregal, czapla, gziolo, bernhard-reiter. See #56467. git-svn-id: https://develop.svn.wordpress.org/trunk@54251 602fd350-edb4-49c9-b593-d223f7449a82

oandregal requested review from ajitbohra, fabiankaegy, juanmaguitar, ryanwelcher and spacedmonkey as code owners September 14, 2022 15:11

oandregal requested review from aristath, gziolo, jorgefilipecosta and nerrad and removed request for ajitbohra, fabiankaegy, juanmaguitar, ryanwelcher and spacedmonkey September 14, 2022 15:12

oandregal self-assigned this Sep 14, 2022

oandregal requested a review from andrewserong September 14, 2022 15:12

oandregal added [Type] Code Quality Issues or PRs that relate to code quality Global Styles Anything related to the broader Global Styles efforts, including Styles Engine and theme.json labels Sep 14, 2022

oandregal changed the title ~~Update/hook name from global styles to theme json~~ Update hook's name from global_styles_* to theme_json_* Sep 14, 2022

oandregal changed the title ~~Update hook's name from global_styles_* to theme_json_*~~ Update hook's names from global_styles_* to theme_json_* Sep 14, 2022

oandregal mentioned this pull request Sep 14, 2022

Make global styles data filterable #44015

Merged

Rename all global_styles_* filters to theme_json_*

1ab90c0

oandregal force-pushed the update/hook-name-from-global-styles-to-theme-json branch from d1c5066 to 1ab90c0 Compare September 14, 2022 15:24

jorgefilipecosta approved these changes Sep 14, 2022

View reviewed changes

oandregal commented Sep 14, 2022

View reviewed changes

oandregal mentioned this pull request Sep 14, 2022

Add hooks to filter theme.json data WordPress/wordpress-develop#3247

Closed

oandregal mentioned this pull request Sep 14, 2022

Plugin: Backport PHP changes for WordPress 6.1 release #43440

Closed

37 tasks

oandregal merged commit 12bda86 into trunk Sep 14, 2022

oandregal deleted the update/hook-name-from-global-styles-to-theme-json branch September 14, 2022 19:27

github-actions bot added this to the Gutenberg 14.2 milestone Sep 14, 2022

bph added the Needs Dev Note Requires a developer note for a major WordPress release cycle label Sep 14, 2022

bph added the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Sep 14, 2022

oandregal modified the milestones: Gutenberg 14.2, Gutenberg 14.1 Sep 14, 2022

cbravobernal pushed a commit that referenced this pull request Sep 15, 2022

Update hook's names from global_styles_* to theme_json_* (#44159)

3e9484b

oandregal mentioned this pull request Sep 15, 2022

Use prefix theme_json_ in hooks related to theme.json #44189

Merged

ockham added the Backport to WP Beta/RC label Sep 19, 2022

ockham pushed a commit that referenced this pull request Sep 19, 2022

Update hook's names from global_styles_* to theme_json_* (#44159)

6d76c1b

ockham removed the Backport to WP Beta/RC label Sep 19, 2022

bph mentioned this pull request Oct 3, 2022

6.1 Dev Notes Tracking #42961

Closed

89 tasks

aaronrobertshaw removed the Backport to Gutenberg RC Pull request that needs to be backported to a Gutenberg release candidate (RC) label Oct 12, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update hook's names from `global_styles_` to `theme_json_`#44159

Update hook's names from `global_styles_` to `theme_json_`#44159
oandregal merged 1 commit intotrunkfrom
update/hook-name-from-global-styles-to-theme-json

oandregal commented Sep 14, 2022 •

edited

Loading

Uh oh!

jorgefilipecosta left a comment

Uh oh!

oandregal Sep 14, 2022

Uh oh!

oandregal commented Sep 14, 2022 •

edited

Loading

Uh oh!

bph commented Sep 14, 2022

Uh oh!

cbravobernal commented Sep 15, 2022

Uh oh!

ockham commented Sep 19, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

		@@ -1,11 +1,11 @@
		# Global Styles Filters

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

Conversation

oandregal commented Sep 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What?

Why?

How?

Testing Instructions

Uh oh!

jorgefilipecosta left a comment

Choose a reason for hiding this comment

Uh oh!

oandregal Sep 14, 2022

Choose a reason for hiding this comment

Uh oh!

oandregal commented Sep 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bph commented Sep 14, 2022

Uh oh!

cbravobernal commented Sep 15, 2022

Uh oh!

ockham commented Sep 19, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

oandregal commented Sep 14, 2022 •

edited

Loading

oandregal commented Sep 14, 2022 •

edited

Loading