Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve _get_block_templates_paths performace #5281

Closed
wants to merge 10 commits into from
Closed

Improve _get_block_templates_paths performace #5281

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1d58362
temporary cache
kt-12 Sep 21, 2023
c09979d
Introducing static for caching and removing file check as
kt-12 Sep 22, 2023
b2d5271
Merge branch 'trunk' into enhancement/_get_block_templates_paths_58196
kt-12 Nov 27, 2023
360effb
try catch for fileexists
kt-12 Nov 28, 2023
3004135
Test cases
kt-12 Dec 11, 2023
918e20a
fix ordering issue
kt-12 Dec 11, 2023
f038955
update doc block
kt-12 Dec 11, 2023
400f0b1
change variable name
kt-12 Dec 19, 2023
71dc443
Address review comment and move function to proper file
kt-12 Dec 19, 2023
5622ba7
Update tests/phpunit/tests/block-template.php
kt-12 Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/wp-includes/block-template-utils.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,14 +224,21 @@ static function ( $item ) {
* @return string[] A list of paths to all template part files.
*/
function _get_block_templates_paths( $base_directory ) {
static $template_path_list = array();
if ( isset( $template_path_list[ $base_directory ] ) ) {
return $template_path_list[ $base_directory ];
}
$path_list = array();
if ( file_exists( $base_directory ) ) {
kt-12 marked this conversation as resolved.
Show resolved Hide resolved
try {
$nested_files = new RecursiveIteratorIterator( new RecursiveDirectoryIterator( $base_directory ) );
$nested_html_files = new RegexIterator( $nested_files, '/^.+\.html$/i', RecursiveRegexIterator::GET_MATCH );
foreach ( $nested_html_files as $path => $file ) {
$path_list[] = $path;
}
} catch ( Exception $e ) {
// Do nothing.
}
$template_path_list[ $base_directory ] = $path_list;
return $path_list;
}

Expand Down
44 changes: 44 additions & 0 deletions tests/phpunit/tests/block-template.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,50 @@ public function data_get_block_theme_folders() {
);
}


kt-12 marked this conversation as resolved.
Show resolved Hide resolved
/**
* Tests `_get_block_templates_paths()` for an invalid directory.
*
* @ticket 58196
*
* @covers ::_get_block_templates_paths
*/
public function test_get_block_templates_paths_dir_exists() {
$theme_dir = get_template_directory();
// Templates in the current theme.
$templates = array(
'parts/small-header.html',
'templates/custom-single-post-template.html',
'templates/index.html',
'templates/page-home.html',
'templates/page.html',
'templates/single.html',
);

$expected_template_paths = array_map(
static function ( $template ) use ( $theme_dir ) {
return $theme_dir . '/' . $template;
},
$templates
);

$template_paths = _get_block_templates_paths( $theme_dir );
$this->assertSameSets( $expected_template_paths, $template_paths );
}

/**
* Test _get_block_templates_paths() for a invalid dir.
*
* @ticket 58196
*
* @covers ::_get_block_templates_paths
*/
public function test_get_block_templates_paths_dir_doesnt_exists() {
// Should return empty array for invalid path.
$template_paths = _get_block_templates_paths( '/tmp/random-invalid-theme-path' );
$this->assertSame( array(), $template_paths );
}

/**
* Registers a test block to log `in_the_loop()` results.
*
Expand Down