W3cubDocs

/WordPress

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

$directorystringrequired
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

int|false|null Size in bytes if a valid directory. False if not. Null if timeout.

Source

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.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_dirsize