-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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.
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
Add an is_dir check to prevent a notice from a missing directory with RecursiveDirectoryIterator #6355
Conversation
… RecursiveDirectoryIterator
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN:
To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @srtfisher!
In https://core.trac.wordpress.org/changeset/57215, the main performance benefit was memoizing the template path list. Introducing the try/catch block was a micro-optimization to avoid the need for a file_exists
check. It's odd that New Relic seems to be reporting these caught exceptions anyway. I suspect that this is a NR bug, but I can see how it would be disruptive.
I think we could just remove the try/catch block altogether and do something like this:
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 ( is_dir( $base_directory ) ) {
$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;
}
}
$template_path_list[ $base_directory ] = $path_list;
return $path_list;
}
@joemcgill thank you! I applied your feedback. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @srtfisher. I'm going to do a bit of testing, but I think this looks good.
@@ -229,14 +229,12 @@ function _get_block_templates_paths( $base_directory ) { | |||
return $template_path_list[ $base_directory ]; | |||
} | |||
$path_list = array(); | |||
try { | |||
if ( is_dir( $base_directory ) ) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of checking here could we add condition at top?
if ( ! is_dir( $base_directory ) ) {
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we still want to memoize the path list even when there is no directory, otherwise the is_dir()
check would get repeated unnecessarily, so keeping it as is should be fine.
Though https://core.trac.wordpress.org/ticket/58196 improved the performance of
_get_block_templates_paths()
in 77dcb17, this does throw a notice:Trac ticket: https://core.trac.wordpress.org/ticket/60915
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.