WP_Debug_Data::get_sizes(): array

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

array

The sizes of the directories, also the database size and total installation size.

Performance profile

How much work a call to WP_Debug_Data::get_sizes() 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

Reads stored settings via get_transient(), cached per request but not free on a cold cache.

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

60–81

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 180.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()one call below WP_Debug_Data::get_sizes()
• transienttransientget_transient()one call below WP_Debug_Data::get_sizes()

Further down the call graph this can also reach option, cache, 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 · 4 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Debug_Data::get_sizes() can have, taken from its control-flow graph on PHP 8.5.

Uses · 8

• wp_get_upload_dir()Retrieves uploads directory information.
• untrailingslashit()Removes trailing forward slashes and backslashes if they exist.
• get_theme_root()Retrieves path to themes directory.
• wp_get_font_dir()Retrieves font uploads directory information.
• __()Retrieves the translation of $text.
• recurse_dirsize()Gets the size of a directory recursively.
• size_format()Converts a number of bytes to the largest unit the bytes will fit into.
• WP_Debug_Data::get_database_size()Fetches the total size of all the database tables for the active database user.

Used by · 2

• WP_REST_Site_Health_Controller::get_directory_sizes()Gets the current directory sizes for this install.
• wp_ajax_health_check_get_sizes()Handles site health check to get directories and database sizes via AJAX.

Source code

View on Trac ↗View on GitHub ↗

1832	public static function get_sizes() {1833		$size_db    = self::get_database_size();1834		$upload_dir = wp_get_upload_dir();1835 1836		/*1837		 * We will be using the PHP max execution time to prevent the size calculations1838		 * from causing a timeout. The default value is 30 seconds, and some1839		 * hosts do not allow you to read configuration values.1840		 */1841		if ( function_exists( 'ini_get' ) ) {1842			$max_execution_time = ini_get( 'max_execution_time' );1843		}1844 1845		/*1846		 * The max_execution_time defaults to 0 when PHP runs from cli.1847		 * We still want to limit it below.1848		 */1849		if ( empty( $max_execution_time ) ) {1850			$max_execution_time = 30; // 30 seconds.1851		}1852 1853		if ( $max_execution_time > 20 ) {1854			/*1855			 * If the max_execution_time is set to lower than 20 seconds, reduce it a bit to prevent1856			 * edge-case timeouts that may happen after the size loop has finished running.1857			 */1858			$max_execution_time -= 2;1859		}1860 1861		/*1862		 * Go through the various installation directories and calculate their sizes.1863		 * No trailing slashes.1864		 */1865		$paths = array(1866			'wordpress_size' => untrailingslashit( ABSPATH ),1867			'themes_size'    => get_theme_root(),1868			'plugins_size'   => WP_PLUGIN_DIR,1869			'uploads_size'   => $upload_dir['basedir'],1870			'fonts_size'     => wp_get_font_dir()['basedir'],1871		);1872 1873		$exclude = $paths;1874		unset( $exclude['wordpress_size'] );1875		$exclude = array_values( $exclude );1876 1877		$size_total = 0;1878		$all_sizes  = array();1879 1880		// Loop over all the directories we want to gather the sizes for.1881		foreach ( $paths as $name => $path ) {1882			$dir_size = null; // Default to timeout.1883			$results  = array(1884				'path' => $path,1885				'raw'  => 0,1886			);1887 1888			// If the directory does not exist, skip checking it, as it will skew the other results.1889			if ( ! is_dir( $path ) ) {1890				$all_sizes[ $name ] = array(1891					'path'  => $path,1892					'raw'   => 0,1893					'size'  => __( 'The directory does not exist.' ),1894					'debug' => 'directory not found',1895				);1896 1897				continue;1898			}1899 1900			if ( microtime( true ) - WP_START_TIMESTAMP < $max_execution_time ) {1901				if ( 'wordpress_size' === $name ) {1902					$dir_size = recurse_dirsize( $path, $exclude, $max_execution_time );1903				} else {1904					$dir_size = recurse_dirsize( $path, null, $max_execution_time );1905				}1906			}1907 1908			if ( false === $dir_size ) {1909				// Error reading.1910				$results['size']  = __( 'The size cannot be calculated. The directory is not accessible. Usually caused by invalid permissions.' );1911				$results['debug'] = 'not accessible';

Changelog

Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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/class-wp-debug-data.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.