Changeset 54251

Timestamp:

09/20/2022 01:10:28 PM (2 years ago)

Author:

audrasjb

Message:

Editor: Backport hooks to filter theme.json data from Gutenberg to 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:

• ​gutenberg#44015: Make global styles data filterable
• ​gutenberg#44109: Prepare WP_Theme_JSON_Data class for backporting
• ​gutenberg#44159: Update hook's names from global_styles_* to theme_json_*

Props oandregal, czapla, gziolo, bernhard-reiter.
See #56467.

Location:

trunk/src

Files:

• wp-includes/class-wp-theme-json-data.php (added)
• wp-includes/class-wp-theme-json-resolver.php (modified) (5 diffs)
• wp-settings.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-theme-json-resolver.php

@@ -138 +138 @@
         $config       = static::read_json_file( __DIR__ . '/theme.json' );
         $config       = static::translate( $config );
+        /**
+         * Filters the default data provided by WordPress for global styles & settings.
+         *
+         * @since 6.1.0
+         *
+         * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+         */
+        $theme_json   = apply_filters( 'theme_json_default', new WP_Theme_JSON_Data( $config, 'default' ) );
+        $config       = $theme_json->get_data();
         static::$core = new WP_Theme_JSON( $config, 'default' );
 
@@ -173 +182 @@
             $theme_json_data = static::read_json_file( static::get_file_path_from_theme( 'theme.json' ) );
             $theme_json_data = static::translate( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
+            /**
+             * Filters the data provided by the theme for global styles & settings.
+             *
+             * @since 6.1.0
+             *
+             * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+             */
+            $theme_json      = apply_filters( 'theme_json_theme', new WP_Theme_JSON_Data( $theme_json_data, 'theme' ) );
+            $theme_json_data = $theme_json->get_data();
             static::$theme   = new WP_Theme_JSON( $theme_json_data );
 
@@ -258 +276 @@
             }
         }
+
+        /**
+         * Filters the data provided by the blocks for global styles & settings.
+         *
+         * @since 6.1.0
+         *
+         * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+         */
+        $theme_json = apply_filters( 'theme_json_blocks', new WP_Theme_JSON_Data( $config, 'core' ) );
+        $config     = $theme_json->get_data();
 
         // Core here means it's the lower level part of the styles chain.
@@ -383 +411 @@
             if ( JSON_ERROR_NONE !== $json_decoding_error ) {
                 trigger_error( 'Error when decoding a theme.json schema for user data. ' . json_last_error_msg() );
+                /**
+                 * Filters the data provided by the user for global styles & settings.
+                 *
+                 * @since 6.1.0
+                 *
+                 * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+                 */
+                $theme_json = apply_filters( 'theme_json_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+                $config     = $theme_json->get_data();
                 return new WP_Theme_JSON( $config, 'custom' );
             }
@@ -397 +434 @@
             }
         }
+
+        /**
+         * Filters the data provided by the user for global styles & settings.
+         *
+         * @since 6.1.0
+         *
+         * @param WP_Theme_JSON_Data Class to access and update the underlying data.
+         */
+        $theme_json   = apply_filters( 'theme_json_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+        $config       = $theme_json->get_data();
         static::$user = new WP_Theme_JSON( $config, 'custom' );
 

trunk/src/wp-settings.php

@@ -173 +173 @@
 require ABSPATH . WPINC . '/class-wp-theme.php';
 require ABSPATH . WPINC . '/class-wp-theme-json-schema.php';
+require ABSPATH . WPINC . '/class-wp-theme-json-data.php';
 require ABSPATH . WPINC . '/class-wp-theme-json.php';
 require ABSPATH . WPINC . '/class-wp-theme-json-resolver.php';