Automattic / VIP-Coding-Standards

PHP_CodeSniffer ruleset to enforce WordPress VIP coding standards.

Home Page:https://wpvip.com/documentation/how-to-install-php-code-sniffer-for-wordpress-com-vip/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Exclude get_theme_file_path from WordPressVIPMinimum.Files.IncludingFile.UsingCustomFunction warning

kshaner opened this issue · comments

What problem would the enhancement address for VIP?

The function get_theme_file_path should not trigger as a warning when including files. get_theme_file_path uses get_stylesheet_directory and get_template_directory in the function which are both already allowed.

Describe the solution you'd like

Add get_theme_file_path to the $getPathFunctions property of the WordPressVIPMinimum\Sniffs\Files\IncludingFileSniff sniff.

What code should be reported as a violation?

N/A

What code should not be reported as a violation?

require_once get_theme_file_path( 'includes/custom-theme-file.php' );

List of recognised functions for defining a path:

public $getPathFunctions = [
'plugin_dir_path',
'dirname',
'get_stylesheet_directory',
'get_template_directory',
'locate_template',
'get_parent_theme_file_path',
];

Developer docs for the suggested get_theme_file_path function: https://developer.wordpress.org/reference/functions/get_theme_file_path/

I have to agree - I see no reason not to include 'get_theme_file_path' in the list of $getPathFunctions.