WP_Debug_Data::get_wp_filesystem(): array<string,

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<string,

string|array> The debug data and other information for the Info screen.

Performance profile

How much work a call to WP_Debug_Data::get_wp_filesystem() 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 or writes the filesystem via file_exists().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

139–180

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• filesystemfilesystem accessfile_exists()called directly
• hookthird-party callbacksapply_filters()one call below WP_Debug_Data::get_wp_filesystem()
• optionoption read or writeget_option()one call below WP_Debug_Data::get_wp_filesystem()

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

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Uses · 6

• wp_upload_dir()Returns an array containing the current upload directory's path and URL.
• wp_get_font_dir()Retrieves font uploads directory information.
• wp_is_writable()Determines if a directory is writable.
• get_theme_root()Retrieves path to themes directory.
• get_template()Retrieves name of the active theme.
• __()Retrieves the translation of $text.

Used by · 1

• WP_Debug_Data::debug_data()Static function for generating site debug data when required.

Source code

View on Trac ↗View on GitHub ↗

1752	private static function get_wp_filesystem(): array {1753		$upload_dir                     = wp_upload_dir();1754		$fonts_dir_exists               = file_exists( wp_get_font_dir()['basedir'] );1755		$is_writable_abspath            = wp_is_writable( ABSPATH );1756		$is_writable_wp_content_dir     = wp_is_writable( WP_CONTENT_DIR );1757		$is_writable_upload_dir         = wp_is_writable( $upload_dir['basedir'] );1758		$is_writable_wp_plugin_dir      = wp_is_writable( WP_PLUGIN_DIR );1759		$is_writable_template_directory = wp_is_writable( get_theme_root( get_template() ) );1760		$is_writable_fonts_dir          = $fonts_dir_exists ? wp_is_writable( wp_get_font_dir()['basedir'] ) : false;1761 1762		$fields = array(1763			'wordpress'  => array(1764				'label' => __( 'The main WordPress directory' ),1765				'value' => ( $is_writable_abspath ? __( 'Writable' ) : __( 'Not writable' ) ),1766				'debug' => ( $is_writable_abspath ? 'writable' : 'not writable' ),1767			),1768			'wp-content' => array(1769				'label' => __( 'The wp-content directory' ),1770				'value' => ( $is_writable_wp_content_dir ? __( 'Writable' ) : __( 'Not writable' ) ),1771				'debug' => ( $is_writable_wp_content_dir ? 'writable' : 'not writable' ),1772			),1773			'uploads'    => array(1774				'label' => __( 'The uploads directory' ),1775				'value' => ( $is_writable_upload_dir ? __( 'Writable' ) : __( 'Not writable' ) ),1776				'debug' => ( $is_writable_upload_dir ? 'writable' : 'not writable' ),1777			),1778			'plugins'    => array(1779				'label' => __( 'The plugins directory' ),1780				'value' => ( $is_writable_wp_plugin_dir ? __( 'Writable' ) : __( 'Not writable' ) ),1781				'debug' => ( $is_writable_wp_plugin_dir ? 'writable' : 'not writable' ),1782			),1783			'themes'     => array(1784				'label' => __( 'The themes directory' ),1785				'value' => ( $is_writable_template_directory ? __( 'Writable' ) : __( 'Not writable' ) ),1786				'debug' => ( $is_writable_template_directory ? 'writable' : 'not writable' ),1787			),1788			'fonts'      => array(1789				'label' => __( 'The fonts directory' ),1790				'value' => $fonts_dir_exists1791					? ( $is_writable_fonts_dir ? __( 'Writable' ) : __( 'Not writable' ) )1792					: __( 'Does not exist' ),1793				'debug' => $fonts_dir_exists1794					? ( $is_writable_fonts_dir ? 'writable' : 'not writable' )1795					: 'does not exist',1796			),1797		);1798 1799		// Add more filesystem checks.1800		if ( defined( 'WPMU_PLUGIN_DIR' ) && is_dir( WPMU_PLUGIN_DIR ) ) {1801			$is_writable_wpmu_plugin_dir = wp_is_writable( WPMU_PLUGIN_DIR );1802 1803			$fields['mu-plugins'] = array(1804				'label' => __( 'The must use plugins directory' ),1805				'value' => ( $is_writable_wpmu_plugin_dir ? __( 'Writable' ) : __( 'Not writable' ) ),1806				'debug' => ( $is_writable_wpmu_plugin_dir ? 'writable' : 'not writable' ),1807			);1808		}1809 1810		return array(1811			'label'       => __( 'Filesystem Permissions' ),1812			'description' => __( 'Shows whether WordPress is able to write to the directories it needs access to.' ),1813			'fields'      => $fields,1814		);1815	}

Changelog

Introduced in 6.7.0. One change between 6.7.7 and 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 7.1.0 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.