WP_Theme::get_files( string[]|string $type = null, int $depth = 0, bool $search_parent = false ): string[]
- Since
- 3.4.0
- Source
wp-includes/class-wp-theme.php:1300
Compatibility
- WordPress
- since 3.4.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
$typestring[]|stringoptional- Array of extensions to find, string of a single extension, or null for all extensions. Default null.Default:
null $depthintoptional- How deep to search for files. Defaults to a flat scan (0 depth).
-1 depth is infinite.Default:0 $search_parentbooloptional- Whether to return parent files. Default false.Default:
false
Return value
string[]- Array of files, keyed by the path to the file relative to the theme's directory, with the values being absolute paths.
Performance profile
How much work a call to WP_Theme::get_files() 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
- Scaling
- Constant
- Instructions
- 16–28
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 28.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme::get_files() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 16 | ->get_stylesheet_directory(), ::scandir(), array_filter() |
!->parent() | 19 | ->get_stylesheet_directory(), ::scandir(), ->parent(), array_filter() |
->parent() | 28 | ->get_stylesheet_directory(), ::scandir(), ->parent(), ->get_template_directory(), ::scandir(), array_filter() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 28 instructions, 16–28 executed per call, 2 branches. The work does not change between versions.
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 · 4
- WP_Theme::scandir()Scans a directory for files of a certain extension.
- WP_Theme::get_stylesheet_directory()Returns the absolute path to the directory of a theme's "stylesheet" files.
- WP_Theme::parent()Returns reference to the parent theme.
- WP_Theme::get_template_directory()Returns the absolute path to the directory of a theme's "template" files.
Used by · 2
- WP_Theme::get_post_templates()Returns the theme's post templates.
- WP_Theme::offsetGet()Method to implement ArrayAccess for keys formerly returned by get_themes().
Source code
public function get_files( $type = null, $depth = 0, $search_parent = false ) { $files = (array) self::scandir( $this->get_stylesheet_directory(), $type, $depth ); if ( $search_parent && $this->parent() ) { $files += (array) self::scandir( $this->get_template_directory(), $type, $depth ); } return array_filter( $files ); }Changelog
Introduced in 3.4.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 tag, from
src/wp-includes/class-wp-theme.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.