get_dirsize( string $directory, int $max_execution_time = null ): int|false|null
Gets the size of a directory.
Description
A helper function that is used primarily to check whether a blog has exceeded its allowed upload space.
Parameters
-
$directory
string Required -
Full path of a directory.
-
$max_execution_time
int Optional -
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
int|false|null Size in bytes if a valid directory. False if not. Null if timeout.
Source
File: wp-includes/functions.php
.
View all references
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
Version | Description |
---|---|
MU (3.0.0) | MU (3.0.0) |
5.2.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
To echo the WordPress directory size.