Deprecate `WP_Theme_JSON_Resolver:theme_has_support()` #45380

oandregal · 2022-10-28T12:51:30Z

What?

This PR deprecates the WP_Theme_JSON_Resolver:theme_has_support() method.

Why?

#45168 introduced a new public API for querying whether the theme has a theme.json: wp_them_has_theme_json(). This deprecates the private one.

How?

Uses the _deprecate_method function and provides wp_theme_has_theme_json as an alternative.

Testing Instructions

Verify that everything works as expected with this PR.

Load the front and check global styles.
Load the editor and check presets, etc.

Verify that using the deprecated method triggers a notice in debug mode:

Substitute wp_theme_has_theme_json() by WP_Theme_JSON_Resolver_Gutenberg::theme_has_support() in lib/client-assets.php.
Make sure debug mode is enabled in your environment: define( 'WP_DEBUG', true );
Load the front-end and verify that there is a message

Verify that using the deprecated method does not trigger a notice when debug mode is disabled:

Substitute wp_theme_has_theme_json() by WP_Theme_JSON_Resolver_Gutenberg::theme_has_support() in lib/client-assets.php.
Make sure debug mode is disabled in your environment: define( 'WP_DEBUG', false );
Load the front-end and verify that there is no message .

codesandbox · 2022-10-28T12:51:32Z

Open in CodeSandbox Web Editor | VS Code | VS Code Insiders

oandregal · 2022-10-28T12:55:03Z

lib/compat/wordpress-6.2/class-wp-theme-json-resolver-6-2.php

+	public static function theme_has_support() {
+		_deprecated_function( __METHOD__, '6.2.0', 'wp_theme_has_theme_json()');
+
+		return wp_theme_has_theme_json();


This is still calling the public method, so existing consumers will still work. This is in case consumers outside of WordPress core were using this private method in a production environment. We don't want them to fail.

oandregal · 2022-10-28T12:55:28Z

lib/load.php

@@ -104,6 +102,9 @@ function gutenberg_is_experiment_enabled( $name ) {

 // WordPress 6.2 compat.
 require __DIR__ . '/compat/wordpress-6.2/script-loader.php';
+require __DIR__ . '/compat/wordpress-6.2/get-global-styles-and-settings.php';


In #45168 I missed the place where these imports should be located.

oandregal · 2022-10-28T12:58:18Z

This is not complete because we still need to update WordPress core to use wp_theme_has_theme_json instead. Though, having this notice in debug mode will serve as a strong reminder. When wordpress-develop is opened again for regular work, I can do that.

Mamaduka

Thanks for the quick follow-up, @oandregal!

oandregal · 2022-11-03T10:42:51Z

This is being backported at WordPress/wordpress-develop#3556

#45380

… inheriting per WordPress version (#46750) * Backport WP_Theme_JSON_Resolver from core as it is * Substitute WP_Theme_JSON by WP_Theme_JSON_Gutenberg * Substitute WP_Theme_JSON_Data by WP_Theme_JSON_Data_Gutenberg * Rename WP_Theme_JSON_Resolver to WP_Theme_JSON_Resolver_Base The goal is to use it as base to inherit from, until we are able to remove all the children. * Make WP_Theme_JSON_Resolver_6_1 inherit from WP_Theme_JSON_Resolver_Base * 6.1: remove field already defined in base class * 6.1: remove translate, it is equal to base method * 6.1: remove get_core_data, it does not have base changes * 6.1: remove get_user_data Missed core changes and does not do anything differently from core. * 6.1: remove get_user_data_from_wp_global_styles It misses core changes and does not do anything differently. * 6.2: inherit from WP_Theme_JSON_Resolver_Base instead of 6.1 This makes the WP_Theme_JSON_Resover_6_1 class unused. * 6.1: remove class no longer in use * 6.2: deprecate theme_has_support #45380 * 6.2: substitute WP_Theme_JSON_Resolver::theme_has_support by wp_theme_has_theme_json() #45168 * 6.2: port changes to get_user_data_from_wp_global_styles #46043 * 6.2: update get_merged_data #45969 * 6.2: remove get_user_data Same code as core. There's a check for detecting whether the class is an instance of WP_Theme_JSON_Gutenberg that was not ported. This check was introduced to make sure the cache of the core class didn't interfere with the cache of the Gutenberg class, so it's no longer necessary. See #42756 * experimental: make it inherit from WP_Theme_JSON_Resolver_Base * 6.2: remove class no longer in use * experimental: delete remove_json_comments It's already part of the base class. * experimental: remove get_block_data It's already part of the base class and it didn't have the changes from core. * experimental: appearanceTools Port changes to the base class that were meant to be part of 6.1. See #43337 * experimental: port webfonts (experimental API) see #37140 * experimental: use gutenberg_get_legacy_theme_supports_for_theme_json #46112 * experimental: get_theme_data, all code is in the base class * experimental: remove empty class * Rename WP_Theme_JSON_Resolver_Base to WP_Theme_JSON_Resolver_Gutenberg * Fix lint issue: rename class-wp-theme-json-resolver.php to class-wp-theme-json-resolver-gutenberg.php * Move theme.json to unversioned lib/ * Move theme-i18n.json to unversioned lib/

Adds `wp_theme_has_theme_json()` for public consumption, to replace the private internal Core-only `WP_Theme_JSON_Resolver::theme_has_support()` method. This new global function checks if a theme or its parent has a `theme.json` file. For performance, results are cached as an integer `1` or `0` in the `'theme_json'` group with `'wp_theme_has_theme_json'` key. This is a non-persistent cache. Why? To make the derived data from `theme.json` is always fresh from the potential modifications done via hooks that can use dynamic data (modify the stylesheet depending on some option, settings depending on user permissions, etc.). Also adds a new public function `wp_clean_theme_json_cache()` to clear the cache on `'switch_theme'` and `start_previewing_theme'`. References: * [WordPress/gutenberg#45168 Gutenberg PR 45168] Add `wp_theme_has_theme_json` as a public API to know whether a theme has a `theme.json`. * [WordPress/gutenberg#45380 Gutenberg PR 45380] Deprecate `WP_Theme_JSON_Resolver:theme_has_support()`. * [WordPress/gutenberg#46150 Gutenberg PR 46150] Make `theme.json` object caches non-persistent. * [WordPress/gutenberg#45979 Gutenberg PR 45979] Don't check if constants set by `wp_initial_constants()` are defined. * [WordPress/gutenberg#45950 Gutenberg PR 45950] Cleaner logic in `wp_theme_has_theme_json`. Follow-up to [54493], [53282], [52744], [52049], [50959]. Props oandregal, afragen, alexstine, aristath, azaozz, costdev, flixos90, hellofromTonya, mamaduka, mcsf, ocean90, spacedmonkey. Fixes #56975. git-svn-id: https://develop.svn.wordpress.org/trunk@55086 602fd350-edb4-49c9-b593-d223f7449a82

Adds `wp_theme_has_theme_json()` for public consumption, to replace the private internal Core-only `WP_Theme_JSON_Resolver::theme_has_support()` method. This new global function checks if a theme or its parent has a `theme.json` file. For performance, results are cached as an integer `1` or `0` in the `'theme_json'` group with `'wp_theme_has_theme_json'` key. This is a non-persistent cache. Why? To make the derived data from `theme.json` is always fresh from the potential modifications done via hooks that can use dynamic data (modify the stylesheet depending on some option, settings depending on user permissions, etc.). Also adds a new public function `wp_clean_theme_json_cache()` to clear the cache on `'switch_theme'` and `start_previewing_theme'`. References: * [WordPress/gutenberg#45168 Gutenberg PR 45168] Add `wp_theme_has_theme_json` as a public API to know whether a theme has a `theme.json`. * [WordPress/gutenberg#45380 Gutenberg PR 45380] Deprecate `WP_Theme_JSON_Resolver:theme_has_support()`. * [WordPress/gutenberg#46150 Gutenberg PR 46150] Make `theme.json` object caches non-persistent. * [WordPress/gutenberg#45979 Gutenberg PR 45979] Don't check if constants set by `wp_initial_constants()` are defined. * [WordPress/gutenberg#45950 Gutenberg PR 45950] Cleaner logic in `wp_theme_has_theme_json`. Follow-up to [54493], [53282], [52744], [52049], [50959]. Props oandregal, afragen, alexstine, aristath, azaozz, costdev, flixos90, hellofromTonya, mamaduka, mcsf, ocean90, spacedmonkey. Fixes #56975. Built from https://develop.svn.wordpress.org/trunk@55086 git-svn-id: http://core.svn.wordpress.org/trunk@54619 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Adds `wp_theme_has_theme_json()` for public consumption, to replace the private internal Core-only `WP_Theme_JSON_Resolver::theme_has_support()` method. This new global function checks if a theme or its parent has a `theme.json` file. For performance, results are cached as an integer `1` or `0` in the `'theme_json'` group with `'wp_theme_has_theme_json'` key. This is a non-persistent cache. Why? To make the derived data from `theme.json` is always fresh from the potential modifications done via hooks that can use dynamic data (modify the stylesheet depending on some option, settings depending on user permissions, etc.). Also adds a new public function `wp_clean_theme_json_cache()` to clear the cache on `'switch_theme'` and `start_previewing_theme'`. References: * [WordPress/gutenberg#45168 Gutenberg PR 45168] Add `wp_theme_has_theme_json` as a public API to know whether a theme has a `theme.json`. * [WordPress/gutenberg#45380 Gutenberg PR 45380] Deprecate `WP_Theme_JSON_Resolver:theme_has_support()`. * [WordPress/gutenberg#46150 Gutenberg PR 46150] Make `theme.json` object caches non-persistent. * [WordPress/gutenberg#45979 Gutenberg PR 45979] Don't check if constants set by `wp_initial_constants()` are defined. * [WordPress/gutenberg#45950 Gutenberg PR 45950] Cleaner logic in `wp_theme_has_theme_json`. Follow-up to [54493], [53282], [52744], [52049], [50959]. Props oandregal, afragen, alexstine, aristath, azaozz, costdev, flixos90, hellofromTonya, mamaduka, mcsf, ocean90, spacedmonkey. Fixes #56975. Built from https://develop.svn.wordpress.org/trunk@55086 git-svn-id: https://core.svn.wordpress.org/trunk@54619 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Adds `wp_theme_has_theme_json()` for public consumption, to replace the private internal Core-only `WP_Theme_JSON_Resolver::theme_has_support()` method. This new global function checks if a theme or its parent has a `theme.json` file. For performance, results are cached as an integer `1` or `0` in the `'theme_json'` group with `'wp_theme_has_theme_json'` key. This is a non-persistent cache. Why? To make the derived data from `theme.json` is always fresh from the potential modifications done via hooks that can use dynamic data (modify the stylesheet depending on some option, settings depending on user permissions, etc.). Also adds a new public function `wp_clean_theme_json_cache()` to clear the cache on `'switch_theme'` and `start_previewing_theme'`. References: * [WordPress/gutenberg#45168 Gutenberg PR 45168] Add `wp_theme_has_theme_json` as a public API to know whether a theme has a `theme.json`. * [WordPress/gutenberg#45380 Gutenberg PR 45380] Deprecate `WP_Theme_JSON_Resolver:theme_has_support()`. * [WordPress/gutenberg#46150 Gutenberg PR 46150] Make `theme.json` object caches non-persistent. * [WordPress/gutenberg#45979 Gutenberg PR 45979] Don't check if constants set by `wp_initial_constants()` are defined. * [WordPress/gutenberg#45950 Gutenberg PR 45950] Cleaner logic in `wp_theme_has_theme_json`. Follow-up to [54493], [53282], [52744], [52049], [50959]. Props oandregal, afragen, alexstine, aristath, azaozz, costdev, flixos90, hellofromTonya, mamaduka, mcsf, ocean90, spacedmonkey. Fixes #56975. Built from https://develop.svn.wordpress.org/trunk@55086 git-svn-id: http://core.svn.wordpress.org/trunk@54619 1a063a9b-81f0-0310-95a4-ce76da25c4cd

oandregal added 2 commits October 28, 2022 14:38

Deprecate WP_Theme_JSON_Resolver::theme_has_support

90b9776

Declare alternative

192caaf

oandregal requested a review from spacedmonkey as a code owner October 28, 2022 12:51

oandregal self-assigned this Oct 28, 2022

oandregal requested a review from Mamaduka October 28, 2022 12:51

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 Oct 28, 2022

oandregal mentioned this pull request Oct 28, 2022

Add wp_theme_has_theme_json as a public API to know whether a theme has a theme.json #45168

Merged

3 tasks

oandregal commented Oct 28, 2022

View reviewed changes

oandregal mentioned this pull request Oct 28, 2022

Code quality check for theme.json related APIs #45171

Open

oandregal requested a review from aristath October 28, 2022 12:59

Mamaduka approved these changes Oct 28, 2022

View reviewed changes

Make linter happy

412b351

oandregal merged commit 67fe26f into trunk Oct 28, 2022

oandregal deleted the deprecate/theme-has-support branch October 28, 2022 14:23

github-actions bot added this to the Gutenberg 14.5 milestone Oct 28, 2022

oandregal mentioned this pull request Nov 3, 2022

wp_theme_has_theme_json: add public method to know whether the theme supports theme.json WordPress/wordpress-develop#3556

Closed

oandregal added a commit that referenced this pull request Dec 22, 2022

6.2: deprecate theme_has_support

f4c6c01

#45380

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `WP_Theme_JSON_Resolver:theme_has_support()` #45380

Deprecate `WP_Theme_JSON_Resolver:theme_has_support()` #45380

oandregal commented Oct 28, 2022 •

edited

Loading

codesandbox bot commented Oct 28, 2022

oandregal Oct 28, 2022

oandregal Oct 28, 2022

oandregal commented Oct 28, 2022

Mamaduka left a comment

oandregal commented Nov 3, 2022

Deprecate WP_Theme_JSON_Resolver:theme_has_support() #45380

Deprecate WP_Theme_JSON_Resolver:theme_has_support() #45380

Conversation

oandregal commented Oct 28, 2022 • edited Loading

What?

Why?

How?

Testing Instructions

codesandbox bot commented Oct 28, 2022

oandregal Oct 28, 2022

Choose a reason for hiding this comment

oandregal Oct 28, 2022

Choose a reason for hiding this comment

oandregal commented Oct 28, 2022

Mamaduka left a comment

Choose a reason for hiding this comment

oandregal commented Nov 3, 2022

Deprecate `WP_Theme_JSON_Resolver:theme_has_support()` #45380

Deprecate `WP_Theme_JSON_Resolver:theme_has_support()` #45380

oandregal commented Oct 28, 2022 •

edited

Loading