WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_dirsize()

get_dirsize( string $directory, int $max_execution_time = null ): int|false|null

In this article

Back to top

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;
}

View all references View on Trac View on GitHub

UsesDescription
recurse_dirsize()wp-includes/functions.php

Gets the size of a directory recursively.

is_main_site()wp-includes/functions.php

Determines whether a site is the main site of the current network.

is_multisite()wp-includes/load.php

Determines whether Multisite is enabled.

Show 1 moreShow less
Used byDescription
get_space_used()wp-includes/ms-functions.php

Returns the space used by the current site.

Changelog

VersionDescription
MU (3.0.0)MU (3.0.0)
5.2.0Introduced.

User Contributed Notes

  1. Skip to note 2 content
    Naveen Kharwar
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    To echo the WordPress directory size.

    <?php
if ( ! function_exists( 'get_dirsize' ) ) {
	require_once ABSPATH . WPINC . '/ms-functions.php';
}

// Get the path of a directory.
$directory = get_home_path();

// Get the size of directory in bytes.
$result = get_dirsize( $directory );

echo number_format( $result / ( 1024 * 1024 ), 1 ) . ' MB'; // example output: 43.6 MB
?>

You must log in before being able to contribute a note or feedback.