Changeset 58443

Timestamp:

06/19/2024 04:39:07 PM (2 years ago)

Author:

joemcgill

Message:

Editor: Improve compatibility for WP_Theme_JSON_Data.

This checks that objects returned from any of the wp_theme_json_data_ filters are WP_Theme_JSON_Data objects in order to avoid incompatibilities. Otherwise, reprocess the theme.json data as new WP_Theme_JSON objects to ensure the data matches the expectations of code consuming that data.

Follow-up to [58185].

Props joemcgill, adamsilverstein, oandregal, ryelle, ocean90, pbearne.
See #61112.

File:

• trunk/src/wp-includes/class-wp-theme-json-resolver.php (modified) (5 diffs)

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

@@ -173 +173 @@
                  * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.
                  */
-                $theme_json   = apply_filters( 'wp_theme_json_data_default', new WP_Theme_JSON_Data( $config, 'default' ) );
-                static::$core = $theme_json->get_theme_json();
+                $theme_json = apply_filters( 'wp_theme_json_data_default', new WP_Theme_JSON_Data( $config, 'default' ) );
+
+                /*
+                 * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+                 * compatible class that is not a WP_Theme_JSON_Data object.
+                 */
+                if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+                        static::$core = $theme_json->get_theme_json();
+                } else {
+                        $config       = $theme_json->get_data();
+                        static::$core = new WP_Theme_JSON( $config, 'default' );
+                }
 
                 return static::$core;
@@ -264 +274 @@
                          * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.
                          */
-                        $theme_json    = apply_filters( 'wp_theme_json_data_theme', new WP_Theme_JSON_Data( $theme_json_data, 'theme' ) );
-                        static::$theme = $theme_json->get_theme_json();
+                        $theme_json = apply_filters( 'wp_theme_json_data_theme', new WP_Theme_JSON_Data( $theme_json_data, 'theme' ) );
+
+                        /*
+                         * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+                         * compatible class that is not a WP_Theme_JSON_Data object.
+                         */
+                        if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+                                static::$theme = $theme_json->get_theme_json();
+                        } else {
+                                $config        = $theme_json->get_data();
+                                static::$theme = new WP_Theme_JSON( $config );
+                        }
 
                         if ( $wp_theme->parent() ) {
@@ -387 +407 @@
                  * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.
                  */
-                $theme_json     = apply_filters( 'wp_theme_json_data_blocks', new WP_Theme_JSON_Data( $config, 'blocks' ) );
-                static::$blocks = $theme_json->get_theme_json();
+                $theme_json = apply_filters( 'wp_theme_json_data_blocks', new WP_Theme_JSON_Data( $config, 'blocks' ) );
+
+                /*
+                 * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+                 * compatible class that is not a WP_Theme_JSON_Data object.
+                 */
+                if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+                        static::$blocks = $theme_json->get_theme_json();
+                } else {
+                        $config         = $theme_json->get_data();
+                        static::$blocks = new WP_Theme_JSON( $config, 'blocks' );
+                }
+
                 return static::$blocks;
         }
@@ -524 +555 @@
                                  */
                                 $theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
-                                return $theme_json->get_theme_json();
+
+                                /*
+                                 * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+                                 * compatible class that is not a WP_Theme_JSON_Data object.
+                                 */
+                                if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+                                        return $theme_json->get_theme_json();
+                                } else {
+                                        $config = $theme_json->get_data();
+                                        return new WP_Theme_JSON( $config, 'custom' );
+                                }
                         }
 
@@ -546 +587 @@
 
                 /** This filter is documented in wp-includes/class-wp-theme-json-resolver.php */
-                $theme_json   = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
-                static::$user = $theme_json->get_theme_json();
+                $theme_json = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+
+                /*
+                 * Backward compatibility for extenders returning a WP_Theme_JSON_Data
+                 * compatible class that is not a WP_Theme_JSON_Data object.
+                 */
+                if ( $theme_json instanceof WP_Theme_JSON_Data ) {
+                        static::$user = $theme_json->get_theme_json();
+                } else {
+                        $config       = $theme_json->get_data();
+                        static::$user = new WP_Theme_JSON( $config, 'custom' );
+                }
 
                 return static::$user;