Changeset 52372

Timestamp:

12/14/2021 04:12:57 PM (3 years ago)

Author:

hellofromTonya

Message:

Themes: Rename public static functions in WP_Theme_JSON_Resolver to remove custom_post_type references.

WordPress Core is not really custom and does not reference "custom post type" in its function naming. This commit renames 2 public static methods:

• WP_Theme_JSON_Resolver::get_user_custom_post_type_id() renamed to WP_Theme_JSON_Resolver::get_user_global_styles_post_id().
• WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type() renamed to WP_Theme_JSON_Resolver:: get_user_data_from_wp_global_styles().

Follow-up to [52049], [52051], [52069], [52232], [52275], [52364].

Props antonvlasenko, bernhard-reiter, costdev, desrosj, hellofromTonya, noisysocks, oandregal, SergeyBiryukov.
Fixes #54517.

Location:

trunk

Files:

• src/wp-admin/site-editor.php (modified) (1 diff)
• src/wp-includes/class-wp-theme-json-resolver.php (modified) (7 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpThemeJsonResolver.php (modified) (1 diff)

trunk/src/wp-admin/site-editor.php

@@ -65 +65 @@
 }
 
-$active_global_styles_id = WP_Theme_JSON_Resolver::get_user_custom_post_type_id();
+$active_global_styles_id = WP_Theme_JSON_Resolver::get_user_global_styles_post_id();
 $active_theme            = wp_get_theme()->get_stylesheet();
 $preload_paths           = array(

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

@@ -226 +226 @@
      * @param WP_Theme $theme              The theme object. If empty, it
      *                                     defaults to the current theme.
-     * @param bool     $should_create_cpt  Optional. Whether a new custom post
+     * @param bool     $create_post        Optional. Whether a new custom post
      *                                     type should be created if none are
      *                                     found. Default false.
@@ -234 +234 @@
      * @return array Custom Post Type for the user's origin config.
      */
-    public static function get_user_data_from_custom_post_type( $theme, $should_create_cpt = false, $post_status_filter = array( 'publish' ) ) {
+    public static function get_user_data_from_wp_global_styles( $theme, $create_post = false, $post_status_filter = array( 'publish' ) ) {
         if ( ! $theme instanceof WP_Theme ) {
             $theme = wp_get_theme();
@@ -263 +263 @@
 
         // Special case: '-1' is a results not found.
-        if ( -1 === $post_id && ! $should_create_cpt ) {
+        if ( -1 === $post_id && ! $create_post ) {
             return $user_cpt;
         }
@@ -270 +270 @@
         if ( is_array( $recent_posts ) && ( count( $recent_posts ) === 1 ) ) {
             $user_cpt = $recent_posts[0];
-        } elseif ( $should_create_cpt ) {
+        } elseif ( $create_post ) {
             $cpt_post_id = wp_insert_post(
                 array(
@@ -297 +297 @@
      * @since 5.9.0
      *
-     * @return WP_Theme_JSON Entity that holds user data.
+     * @return WP_Theme_JSON Entity that holds styles for user data.
      */
     public static function get_user_data() {
@@ -305 +305 @@
 
         $config   = array();
-        $user_cpt = self::get_user_data_from_custom_post_type( wp_get_theme() );
+        $user_cpt = self::get_user_data_from_wp_global_styles( wp_get_theme() );
 
         if ( array_key_exists( 'post_content', $user_cpt ) ) {
@@ -382 +382 @@
      * @return integer|null
      */
-    public static function get_user_custom_post_type_id() {
+    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_custom_post_type( wp_get_theme(), true );
+        $user_cpt = self::get_user_data_from_wp_global_styles( wp_get_theme(), true );
 
         if ( array_key_exists( 'ID', $user_cpt ) ) {

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php

@@ -319 +319 @@
         if ( $theme->get_stylesheet() === wp_get_theme()->get_stylesheet() ) {
             // This creates a record for the current theme if not existent.
-            $id = WP_Theme_JSON_Resolver::get_user_custom_post_type_id();
+            $id = WP_Theme_JSON_Resolver::get_user_global_styles_post_id();
         } else {
-            $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( $theme );
+            $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
             $id       = isset( $user_cpt['ID'] ) ? $user_cpt['ID'] : null;
         }

trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php

@@ -322 +322 @@
     }
 
-    function test_get_user_data_from_custom_post_type_does_not_use_uncached_queries() {
+    function test_get_user_data_from_wp_global_styles_does_not_use_uncached_queries() {
         add_filter( 'query', array( $this, 'filter_db_query' ) );
         $query_count = count( $this->queries );
         for ( $i = 0; $i < 3; $i++ ) {
-            WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme() );
+            WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
             WP_Theme_JSON_Resolver::clean_cached_data();
         }
         $query_count = count( $this->queries ) - $query_count;
-        $this->assertEquals( 1, $query_count, 'Only one SQL query should be peformed for multiple invocations of WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type()' );
-
-        $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme() );
+        $this->assertEquals( 1, $query_count, 'Only one SQL query should be peformed for multiple invocations of WP_Theme_JSON_Resolver::get_global_styles_from_post()' );
+
+        $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
         $this->assertEmpty( $user_cpt );
 
-        $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme(), true );
+        $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme(), true );
         $this->assertNotEmpty( $user_cpt );
 
         $query_count = count( $this->queries );
         for ( $i = 0; $i < 3; $i++ ) {
-            WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme() );
+            WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
             WP_Theme_JSON_Resolver::clean_cached_data();
         }