Changeset 58354

Timestamp:

06/06/2024 08:00:08 AM (6 months ago)

Author:

oandregal

Message:

Editor: code quality improvements for theme.json migrate API

Backports ​https://github.com/WordPress/gutenberg/pull/62305

Follow-up to [58328], #61282.

Props ajlende, oandregal, ramonopoly, mukesh27.
Fixes #61282.

Location:

trunk/src/wp-includes

Files:

• class-wp-theme-json-resolver.php (modified) (2 diffs)
• class-wp-theme-json-schema.php (modified) (4 diffs)
• class-wp-theme-json.php (modified) (3 diffs)
• kses.php (modified) (1 diff)

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

@@ -526 +526 @@
                 $decoded_data['isGlobalStylesUserThemeJSON']
             ) {
+                unset( $decoded_data['isGlobalStylesUserThemeJSON'] );
                 $config = $decoded_data;
             }
@@ -531 +532 @@
 
         /** 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' ) );
-        $config     = $theme_json->get_data();
-
-        // Needs to be set for schema migrations of user data.
-        $config['isGlobalStylesUserThemeJSON'] = true;
-
-        static::$user = new WP_Theme_JSON( $config, 'custom' );
+        $theme_json   = apply_filters( 'wp_theme_json_data_user', new WP_Theme_JSON_Data( $config, 'custom' ) );
+        static::$user = $theme_json->get_theme_json();
 
         return static::$user;

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

@@ -36 +36 @@
      *
      * @since 5.9.0
-     * @since 6.6.0 Migrate up to v3.
+     * @since 6.6.0 Migrate up to v3 and add $origin parameter.
      *
      * @param array $theme_json The structure to migrate.
-     *
+     * @param string $origin    Optional. What source of data this object represents.
+     *                          One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
      * @return array The structure in the last version.
      */
-    public static function migrate( $theme_json ) {
+    public static function migrate( $theme_json, $origin = 'theme' ) {
         if ( ! isset( $theme_json['version'] ) ) {
             $theme_json = array(
@@ -55 +56 @@
                 // Deliberate fall through. Once migrated to v2, also migrate to v3.
             case 2:
-                $theme_json = self::migrate_v2_to_v3( $theme_json );
+                $theme_json = self::migrate_v2_to_v3( $theme_json, $origin );
         }
 
@@ -101 +102 @@
      * @since 6.6.0
      *
-     * @param array $old Data to migrate.
-     *
+     * @param array $old     Data to migrate.
+     * @param string $origin What source of data this object represents.
+     *                       One of 'blocks', 'default', 'theme', or 'custom'.
      * @return array Data with defaultFontSizes set to false.
      */
-    private static function migrate_v2_to_v3( $old ) {
+    private static function migrate_v2_to_v3( $old, $origin ) {
         // Copy everything.
         $new = $old;
@@ -116 +118 @@
          * as they should take on the value of the theme origin.
          */
-        if (
-            isset( $new['isGlobalStylesUserThemeJSON'] ) &&
-            true === $new['isGlobalStylesUserThemeJSON']
-        ) {
+        if ( 'custom' === $origin ) {
             return $new;
         }

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

@@ -748 +748 @@
      * @param array  $theme_json A structure that follows the theme.json schema.
      * @param string $origin     Optional. What source of data this object represents.
-     *                           One of 'default', 'theme', or 'custom'. Default 'theme'.
+     *                           One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
      */
     public function __construct( $theme_json = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA ), $origin = 'theme' ) {
@@ -755 +755 @@
         }
 
-        $this->theme_json    = WP_Theme_JSON_Schema::migrate( $theme_json );
+        $this->theme_json    = WP_Theme_JSON_Schema::migrate( $theme_json, $origin );
         $valid_block_names   = array_keys( static::get_blocks_metadata() );
         $valid_element_names = array_keys( static::ELEMENTS );
@@ -3243 +3243 @@
      * @since 5.9.0
      * @since 6.3.2 Preserves global styles block variations when securing styles.
-     * @since 6.6.0 Updated to allow variation element styles.
+     * @since 6.6.0 Updated to allow variation element styles and $origin parameter.
      *
      * @param array $theme_json Structure to sanitize.
+     * @param string $origin    Optional. What source of data this object represents.
+     *                          One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.
      * @return array Sanitized structure.
      */
-    public static function remove_insecure_properties( $theme_json ) {
+    public static function remove_insecure_properties( $theme_json, $origin = 'theme' ) {
+        if ( ! in_array( $origin, static::VALID_ORIGINS, true ) ) {
+            $origin = 'theme';
+        }
+
         $sanitized = array();
 
-        $theme_json = WP_Theme_JSON_Schema::migrate( $theme_json );
+        $theme_json = WP_Theme_JSON_Schema::migrate( $theme_json, $origin );
 
         $valid_block_names   = array_keys( static::get_blocks_metadata() );

trunk/src/wp-includes/kses.php

@@ -2147 +2147 @@
         unset( $decoded_data['isGlobalStylesUserThemeJSON'] );
 
-        $data_to_encode = WP_Theme_JSON::remove_insecure_properties( $decoded_data );
+        $data_to_encode = WP_Theme_JSON::remove_insecure_properties( $decoded_data, 'custom' );
 
         $data_to_encode['isGlobalStylesUserThemeJSON'] = true;