Retrieves the URL of a file in the theme.
Description
Searches in the stylesheet directory before the template directory so themes which inherit from a parent theme can just override one file.
Parameters
$file
stringoptional- File to search for in the stylesheet directory.
Default:
''
Source
function get_theme_file_uri( $file = '' ) {
$file = ltrim( $file, '/' );
$stylesheet_directory = get_stylesheet_directory();
if ( empty( $file ) ) {
$url = get_stylesheet_directory_uri();
} elseif ( get_template_directory() !== $stylesheet_directory && file_exists( $stylesheet_directory . '/' . $file ) ) {
$url = get_stylesheet_directory_uri() . '/' . $file;
} else {
$url = get_template_directory_uri() . '/' . $file;
}
/**
* Filters the URL to a file in the theme.
*
* @since 4.7.0
*
* @param string $url The file URL.
* @param string $file The requested file to search for.
*/
return apply_filters( 'theme_file_uri', $url, $file );
}
Hooks
- apply_filters( ‘theme_file_uri’,
string $url ,string $file ) Filters the URL to a file in the theme.
Changelog
Version | Description |
---|---|
4.7.0 | Introduced. |
You can use this function to include local theme assets (like images) in your block patterns:
a simple example