wppaste
WordPress

WP_Theme_JSON_Resolver::get_file_path_from_theme( string $file_name, bool $template = false ): string

Since
5.8.0, 5.9.0
Source
wp-includes/class-wp-theme-json-resolver.php:727
Builds the path to the given file and checks that it is readable.

Description

If it isn't, returns an empty string, otherwise returns the whole file path.

Compatibility

WordPress
since 5.9.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$file_namestring
Name of the file.
$templatebooloptional
Use template theme directory. Default false.Default: false

Return value

string
The whole file path or empty if the file doesn't exist.

Performance profile

How much work a call to WP_Theme_JSON_Resolver::get_file_path_from_theme() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Trivial

Touches nothing outside its own arguments.

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
14–15

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 19.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksapply_filters()one call below WP_Theme_JSON_Resolver::get_file_path_from_theme()

Further down the call graph this can also reach option, cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme_JSON_Resolver::get_file_path_from_theme() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always14get_stylesheet_directory(), is_readable()
always15get_template_directory(), is_readable()

Across PHP versions

PHPCompiledExecutedBranchesNotes
8.6-dev1713–1422 fewer instructions than PHP 8.5
8.51914–152
8.41914–152
8.31914–152
8.21914–152
8.11914–152
7.41914–152

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 2

Source code

View on Trac View on GitHub 

	protected static function get_file_path_from_theme( $file_name, $template = false ) {		$path      = $template ? get_template_directory() : get_stylesheet_directory();		$candidate = $path . '/' . $file_name; 		return is_readable( $candidate ) ? $candidate : '';	}

Changelog

Introduced in 5.8.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

5.9.0
Adapted to work with child themes, added the $template argument.from the docblock
5.8.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/class-wp-theme-json-resolver.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.