Changeset 56621 for trunk/tests/phpunit/tests/block-template.php

Timestamp:

09/19/2023 04:15:52 PM (12 months ago)

Author:

spacedmonkey

Message:

Themes: Improve performance of get_block_theme_folders function

This commit enhances the performance of the get_block_theme_folders function by introducing a new method called get_block_template_folders within the WP_Theme class. Previously, this function suffered from poor performance due to repeated file lookups using file_exists. The new method implements basic caching, storing the result in the theme's cache, similar to how block themes are cached in the block_theme property (see [55236]).

Additionally, this change improves error handling by checking if a theme exists before attempting to look up the file. It also enhances test coverage.

Props spacedmonkey, thekt12, swissspidy, flixos90, costdev, mukesh27.
Fixes #58319.

File:

• trunk/tests/phpunit/tests/block-template.php (modified) (1 diff)

trunk/tests/phpunit/tests/block-template.php

@@ -277 +277 @@
 
     /**
+     * @ticket 58319
+     *
+     * @covers ::get_block_theme_folders
+     *
+     * @dataProvider data_get_block_theme_folders
+     *
+     * @param string   $theme    The theme's stylesheet.
+     * @param string[] $expected The expected associative array of block theme folders.
+     */
+    public function test_get_block_theme_folders( $theme, $expected ) {
+        $wp_theme = wp_get_theme( $theme );
+        $wp_theme->cache_delete(); // Clear cache.
+
+        $this->assertSame( $expected, get_block_theme_folders( $theme ), 'Incorrect block theme folders were retrieved.' );
+        $reflection = new ReflectionMethod( $wp_theme, 'cache_get' );
+        $reflection->setAccessible( true );
+        $theme_cache  = $reflection->invoke( $wp_theme, 'theme' );
+        $cached_value = $theme_cache['block_template_folders'];
+        $reflection->setAccessible( false );
+
+        $this->assertSame( $expected, $cached_value, 'The cached value is incorrect.' );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array[]
+     */
+    public function data_get_block_theme_folders() {
+        return array(
+            'block-theme'                       => array(
+                'block-theme',
+                array(
+                    'wp_template'      => 'templates',
+                    'wp_template_part' => 'parts',
+                ),
+            ),
+            'block-theme-deprecated-path'       => array(
+                'block-theme-deprecated-path',
+                array(
+                    'wp_template'      => 'block-templates',
+                    'wp_template_part' => 'block-template-parts',
+                ),
+            ),
+            'block-theme-child'                 => array(
+                'block-theme-child',
+                array(
+                    'wp_template'      => 'templates',
+                    'wp_template_part' => 'parts',
+                ),
+            ),
+            'block-theme-child-deprecated-path' => array(
+                'block-theme-child-deprecated-path',
+                array(
+                    'wp_template'      => 'block-templates',
+                    'wp_template_part' => 'block-template-parts',
+                ),
+            ),
+            'this-is-an-invalid-theme'          => array(
+                'this-is-an-invalid-theme',
+                array(
+                    'wp_template'      => 'templates',
+                    'wp_template_part' => 'parts',
+                ),
+            ),
+            'null'                              => array(
+                null,
+                array(
+                    'wp_template'      => 'templates',
+                    'wp_template_part' => 'parts',
+                ),
+            ),
+        );
+    }
+
+    /**
      * Registers a test block to log `in_the_loop()` results.
      *