Changeset 52746 for branches/5.9/src/wp-includes/class-wp-theme-json-resolver.php

Timestamp:

02/17/2022 11:13:09 AM (3 years ago)

Author:

audrasjb

Message:

Themes: Allow extending WP_Theme_JSON and WP_Theme_JSON_Resolver classes.

This change updates methods visibility from private to protected and adds late static binding.

Original PRs from Gutenberg repository:

• ​https://github.com/WordPress/gutenberg/pull/38625
• ​https://github.com/WordPress/gutenberg/pull/38671

Props oandregal, Mamaduka, kapilpaul.
Merges [52744] to the 5.9 branch.
Fixes #55178.
See #55179.

Location:

branches/5.9

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-theme-json-resolver.php (modified) (19 diffs)

branches/5.9/src/wp-includes/class-wp-theme-json-resolver.php

@@ -26 +26 @@
      * @var WP_Theme_JSON
      */
-    private static $core = null;
+    protected static $core = null;
 
     /**
@@ -34 +34 @@
      * @var WP_Theme_JSON
      */
-    private static $theme = null;
+    protected static $theme = null;
 
     /**
@@ -42 +42 @@
      * @var bool
      */
-    private static $theme_has_support = null;
+    protected static $theme_has_support = null;
 
     /**
@@ -50 +50 @@
      * @var WP_Theme_JSON
      */
-    private static $user = null;
+    protected static $user = null;
 
     /**
@@ -59 +59 @@
      * @var int
      */
-    private static $user_custom_post_type_id = null;
+    protected static $user_custom_post_type_id = null;
 
     /**
@@ -68 +68 @@
      * @var array
      */
-    private static $i18n_schema = null;
+    protected static $i18n_schema = null;
 
     /**
@@ -79 +79 @@
      * @return array Contents that adhere to the theme.json schema.
      */
-    private static function read_json_file( $file_path ) {
+    protected static function read_json_file( $file_path ) {
         $config = array();
         if ( $file_path ) {
@@ -114 +114 @@
      * @return array Returns the modified $theme_json_structure.
      */
-    private static function translate( $theme_json, $domain = 'default' ) {
-        if ( null === self::$i18n_schema ) {
-            $i18n_schema       = wp_json_file_decode( __DIR__ . '/theme-i18n.json' );
-            self::$i18n_schema = null === $i18n_schema ? array() : $i18n_schema;
-        }
-
-        return translate_settings_using_i18n_schema( self::$i18n_schema, $theme_json, $domain );
+    protected static function translate( $theme_json, $domain = 'default' ) {
+        if ( null === static::$i18n_schema ) {
+            $i18n_schema         = wp_json_file_decode( __DIR__ . '/theme-i18n.json' );
+            static::$i18n_schema = null === $i18n_schema ? array() : $i18n_schema;
+        }
+
+        return translate_settings_using_i18n_schema( static::$i18n_schema, $theme_json, $domain );
     }
 
@@ -131 +131 @@
      */
     public static function get_core_data() {
-        if ( null !== self::$core ) {
-            return self::$core;
-        }
-
-        $config     = self::read_json_file( __DIR__ . '/theme.json' );
-        $config     = self::translate( $config );
-        self::$core = new WP_Theme_JSON( $config, 'default' );
-
-        return self::$core;
+        if ( null !== static::$core ) {
+            return static::$core;
+        }
+
+        $config       = static::read_json_file( __DIR__ . '/theme.json' );
+        $config       = static::translate( $config );
+        static::$core = new WP_Theme_JSON( $config, 'default' );
+
+        return static::$core;
     }
 
@@ -160 +160 @@
             _deprecated_argument( __METHOD__, '5.9.0' );
         }
-        if ( null === self::$theme ) {
-            $theme_json_data = self::read_json_file( self::get_file_path_from_theme( 'theme.json' ) );
-            $theme_json_data = self::translate( $theme_json_data, wp_get_theme()->get( 'TextDomain' ) );
-            self::$theme     = new WP_Theme_JSON( $theme_json_data );
+        if ( null === static::$theme ) {
+            $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' ) );
+            static::$theme   = new WP_Theme_JSON( $theme_json_data );
 
             if ( wp_get_theme()->parent() ) {
                 // Get parent theme.json.
-                $parent_theme_json_data = self::read_json_file( self::get_file_path_from_theme( 'theme.json', true ) );
-                $parent_theme_json_data = self::translate( $parent_theme_json_data, wp_get_theme()->parent()->get( 'TextDomain' ) );
+                $parent_theme_json_data = static::read_json_file( static::get_file_path_from_theme( 'theme.json', true ) );
+                $parent_theme_json_data = static::translate( $parent_theme_json_data, wp_get_theme()->parent()->get( 'TextDomain' ) );
                 $parent_theme           = new WP_Theme_JSON( $parent_theme_json_data );
 
                 // Merge the child theme.json into the parent theme.json.
                 // The child theme takes precedence over the parent.
-                $parent_theme->merge( self::$theme );
-                self::$theme = $parent_theme;
+                $parent_theme->merge( static::$theme );
+                static::$theme = $parent_theme;
             }
         }
@@ -182 +182 @@
          * to override the ones declared via theme supports.
          * So we take theme supports, transform it to theme.json shape
-         * and merge the self::$theme upon that.
+         * and merge the static::$theme upon that.
          */
         $theme_support_data = WP_Theme_JSON::get_from_editor_settings( get_default_block_editor_settings() );
-        if ( ! self::theme_has_support() ) {
+        if ( ! static::theme_has_support() ) {
             if ( ! isset( $theme_support_data['settings']['color'] ) ) {
                 $theme_support_data['settings']['color'] = array();
@@ -211 +211 @@
         }
         $with_theme_supports = new WP_Theme_JSON( $theme_support_data );
-        $with_theme_supports->merge( self::$theme );
+        $with_theme_supports->merge( static::$theme );
 
         return $with_theme_supports;
@@ -300 +300 @@
      */
     public static function get_user_data() {
-        if ( null !== self::$user ) {
-            return self::$user;
+        if ( null !== static::$user ) {
+            return static::$user;
         }
 
         $config   = array();
-        $user_cpt = self::get_user_data_from_wp_global_styles( wp_get_theme() );
+        $user_cpt = static::get_user_data_from_wp_global_styles( wp_get_theme() );
 
         if ( array_key_exists( 'post_content', $user_cpt ) ) {
@@ -327 +327 @@
             }
         }
-        self::$user = new WP_Theme_JSON( $config, 'custom' );
-
-        return self::$user;
+        static::$user = new WP_Theme_JSON( $config, 'custom' );
+
+        return static::$user;
     }
 
@@ -364 +364 @@
 
         $result = new WP_Theme_JSON();
-        $result->merge( self::get_core_data() );
-        $result->merge( self::get_theme_data() );
+        $result->merge( static::get_core_data() );
+        $result->merge( static::get_theme_data() );
 
         if ( 'custom' === $origin ) {
-            $result->merge( self::get_user_data() );
+            $result->merge( static::get_user_data() );
         }
 
@@ -383 +383 @@
      */
     public static function get_user_global_styles_post_id() {
-        if ( null !== self::$user_custom_post_type_id ) {
-            return self::$user_custom_post_type_id;
-        }
-
-        $user_cpt = self::get_user_data_from_wp_global_styles( wp_get_theme(), true );
+        if ( null !== static::$user_custom_post_type_id ) {
+            return static::$user_custom_post_type_id;
+        }
+
+        $user_cpt = static::get_user_data_from_wp_global_styles( wp_get_theme(), true );
 
         if ( array_key_exists( 'ID', $user_cpt ) ) {
-            self::$user_custom_post_type_id = $user_cpt['ID'];
-        }
-
-        return self::$user_custom_post_type_id;
+            static::$user_custom_post_type_id = $user_cpt['ID'];
+        }
+
+        return static::$user_custom_post_type_id;
     }
 
@@ -405 +405 @@
      */
     public static function theme_has_support() {
-        if ( ! isset( self::$theme_has_support ) ) {
-            self::$theme_has_support = (
-                is_readable( self::get_file_path_from_theme( 'theme.json' ) ) ||
-                is_readable( self::get_file_path_from_theme( 'theme.json', true ) )
+        if ( ! isset( static::$theme_has_support ) ) {
+            static::$theme_has_support = (
+                is_readable( static::get_file_path_from_theme( 'theme.json' ) ) ||
+                is_readable( static::get_file_path_from_theme( 'theme.json', true ) )
             );
         }
 
-        return self::$theme_has_support;
+        return static::$theme_has_support;
     }
 
@@ -427 +427 @@
      * @return string The whole file path or empty if the file doesn't exist.
      */
-    private static function get_file_path_from_theme( $file_name, $template = false ) {
+    protected static function get_file_path_from_theme( $file_name, $template = false ) {
         $path      = $template ? get_template_directory() : get_stylesheet_directory();
         $candidate = $path . '/' . $file_name;
@@ -442 +442 @@
      */
     public static function clean_cached_data() {
-        self::$core                     = null;
-        self::$theme                    = null;
-        self::$user                     = null;
-        self::$user_custom_post_type_id = null;
-        self::$theme_has_support        = null;
-        self::$i18n_schema              = null;
+        static::$core                     = null;
+        static::$theme                    = null;
+        static::$user                     = null;
+        static::$user_custom_post_type_id = null;
+        static::$theme_has_support        = null;
+        static::$i18n_schema              = null;
     }