get_plugin_files( string $plugin ): string[]
- Since
- 2.8.0
- Source
wp-admin/includes/plugin.php:232
Compatibility
- WordPress
- since 2.8.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
$pluginstring- Path to the plugin file relative to the plugins directory.
Return value
string[]- Array of file names relative to the plugin root.
Performance profile
How much work a call to get_plugin_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
- Heavy
- Scaling
- Constant
- Instructions
- 14–45
- Plugin surface
- 1 hook
- Called by
- 1
Reads or writes the filesystem via is_dir().
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 45.
Third-party callbacks on 'plugin_files_exclusions' run inside this call, and their cost is not bounded by anything here.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly - filesystemfilesystem access
is_dir()called directly
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 get_plugin_files() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 14–17 | plugin_basename(), is_dir() |
is_dir() && $dir !== false | 45 | plugin_basename(), is_dir(), apply_filters(), list_files(), array_map(), array_merge(), array_unique(), array_values() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 45 | 14–45 | 2 | |
| 8.5 | 45 | 14–45 | 2 | |
| 8.4 | 45 | 14–45 | 2 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 48 | 17–48 | 2 | |
| 8.2 | 48 | 17–48 | 2 | |
| 8.1 | 48 | 17–48 | 2 | |
| 7.4 | 48 | 17–48 | 2 |
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.
Hooks and filters fired · 1
One hook fires while get_plugin_files() runs, in this order:
- apply_filters( plugin_files_exclusions )filterline 247 (+15 into the body)
Filters the array of excluded directories and files while scanning the folder.
Uses · 3
- plugin_basename()Gets the basename of a plugin.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- list_files()Returns a listing of all files in the specified folder and all subdirectories up to 100 levels deep.
Used by · 1
- wp_edit_theme_plugin_file()Attempts to edit a file for a theme or plugin.
Source code
function get_plugin_files( $plugin ) { $plugin_file = WP_PLUGIN_DIR . '/' . $plugin; $dir = dirname( $plugin_file ); $plugin_files = array( plugin_basename( $plugin_file ) ); if ( is_dir( $dir ) && WP_PLUGIN_DIR !== $dir ) { /** * Filters the array of excluded directories and files while scanning the folder. * * @since 4.9.0 * * @param string[] $exclusions Array of excluded directories and files. */ $exclusions = (array) apply_filters( 'plugin_files_exclusions', array( 'CVS', 'node_modules', 'vendor', 'bower_components' ) ); $list_files = list_files( $dir, 100, $exclusions ); $list_files = array_map( 'plugin_basename', $list_files ); $plugin_files = array_merge( $plugin_files, $list_files ); $plugin_files = array_values( array_unique( $plugin_files ) ); } return $plugin_files;}Changelog
Introduced in 2.8.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.7.7 tag, from
src/wp-admin/includes/plugin.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.