get_dirsize( string $directory, int $max_execution_time = null ): int|false|null
- Since
- MU (3.0.0), 5.2.0
- Source
wp-includes/functions.php:8674
Description
A helper function that is used primarily to check whether a blog has exceeded its allowed upload space.
Compatibility
- WordPress
- since 5.2.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
$directorystring- Full path of a directory.
$max_execution_timeintoptional- Maximum time to run before giving up. In seconds.
The timeout is global and is measured from the moment WordPress started to load.Default:null
Return value
int|false|null- Size in bytes if a valid directory. False if not. Null if timeout.
Performance profile
How much work a call to get_dirsize() 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
- Moderate
- Scaling
- Constant
- Instructions
- 12–16
- Plugin surface
- None
- Called by
- 1
Reads stored settings via get_transient(), cached per request but not free on a cold cache.
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 23.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- transienttransient
get_transient()one call below get_dirsize() - hookthird-party callbacks
apply_filters()one call below get_dirsize()
Further down the call graph this can also reach cache, option, serialize 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 get_dirsize() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_multisite() | 12 | is_multisite(), recurse_dirsize() |
is_multisite() | 15–16 | is_multisite(), is_main_site(), recurse_dirsize() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 23 instructions, 12–16 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 · 3
- is_multisite()Determines whether Multisite is enabled.
- is_main_site()Determines whether a site is the main site of the current network.
- recurse_dirsize()Gets the size of a directory recursively.
Used by · 1
- get_space_used()Returns the space used by the current site.
Source code
function get_dirsize( $directory, $max_execution_time = null ) { /* * Exclude individual site directories from the total when checking the main site of a network, * as they are subdirectories and should not be counted. */ if ( is_multisite() && is_main_site() ) { $size = recurse_dirsize( $directory, $directory . '/sites', $max_execution_time ); } else { $size = recurse_dirsize( $directory, null, $max_execution_time ); } return $size;}Changelog
Introduced in 5.2.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.8.8 tag, from
src/wp-includes/functions.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.