WP_Filesystem( array|false $args = false, string|false $context = false, bool $allow_relaxed_file_ownership = false ): bool|null

Description

Compatibility

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

Parameters

$argsarray|falseoptional

Connection args, These are passed directly to the WP_Filesystem_*() classes.
Default false.Default: false

$contextstring|falseoptional

Context for get_filesystem_method().
Default false.Default: false

$allow_relaxed_file_ownershipbooloptional

Whether to allow Group/World writable.
Default false.Default: false

Return value

bool|null

True on success, false on failure, null if the filesystem method class file does not exist.

Performance profile

How much work a call to 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

15–84

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

Plugin surface

1 hook

Third-party callbacks on 'filesystem_method_file' run inside this call, and their cost is not bounded by anything here.

Called by

10

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

What it touches

• hookthird-party callbacksapply_filters()called directly
• filesystemfilesystem accessfile_exists()called directly

What one call costs · 16 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while WP_Filesystem() runs, in this order:

1. 1
   apply_filters( filesystem_method_file )filterline 2198 (+23 into the body)

   Filters the path for a specific filesystem method class file.

Uses · 3

• get_filesystem_method()Determines which method to use for reading, writing, modifying, or deleting files on the filesystem.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• is_wp_error()Checks whether the given variable is a WordPress Error.

Used by · 10

• WP_Site_Health::get_test_update_temp_backup_writable()Tests if plugin and theme temporary backup directories are writable or can be created.
• WP_Site_Health_Auto_Updates::test_all_files_writable()Checks if core files are writable by the web user/group.
• WP_Upgrader::fs_connect()Connects to the filesystem.
• WP_Upgrader::maintenance_mode()Toggles maintenance mode for the site.
• _wp_delete_all_temp_backups()Deletes all contents in the temporary backup directory.
• delete_plugins()Removes directory and files of a plugin for a list of plugins.
• delete_theme()Removes a theme.
• do_core_upgrade()Upgrades WordPress core display.
• wp_ajax_delete_plugin()Handles deleting a plugin via AJAX.
• wp_ajax_delete_theme()Handles deleting a theme via AJAX.

Source code

View on Trac ↗View on GitHub ↗

2175function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid2176	global $wp_filesystem;2177 2178	require_once ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php';2179 2180	$method = get_filesystem_method( $args, $context, $allow_relaxed_file_ownership );2181 2182	if ( ! $method ) {2183		return false;2184	}2185 2186	if ( ! class_exists( "WP_Filesystem_$method" ) ) {2187 2188		/**2189		 * Filters the path for a specific filesystem method class file.2190		 *2191		 * @since 2.6.02192		 *2193		 * @see get_filesystem_method()2194		 *2195		 * @param string $path   Path to the specific filesystem method class file.2196		 * @param string $method The filesystem method to use.2197		 */2198		$abstraction_file = apply_filters( 'filesystem_method_file', ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php', $method );2199 2200		if ( ! file_exists( $abstraction_file ) ) {2201			return;2202		}2203 2204		require_once $abstraction_file;2205	}2206	$method = "WP_Filesystem_$method";2207 2208	$wp_filesystem = new $method( $args );2209 2210	/*2211	 * Define the timeouts for the connections. Only available after the constructor is called2212	 * to allow for per-transport overriding of the default.2213	 */2214	if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {2215		define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds.2216	}2217	if ( ! defined( 'FS_TIMEOUT' ) ) {2218		define( 'FS_TIMEOUT', 30 ); // 30 seconds.2219	}2220 2221	if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {2222		return false;2223	}2224 2225	if ( ! $wp_filesystem->connect() ) {2226		return false; // There was an error connecting to the server.2227	}2228 2229	// Set the permission constants if not already set.2230	if ( ! defined( 'FS_CHMOD_DIR' ) ) {2231		define( 'FS_CHMOD_DIR', ( fileperms( ABSPATH ) & 0777 | 0755 ) );2232	}2233	if ( ! defined( 'FS_CHMOD_FILE' ) ) {2234		define( 'FS_CHMOD_FILE', ( fileperms( ABSPATH . 'index.php' ) & 0777 | 0644 ) );2235	}2236 2237	return true;2238}

Changelog

Introduced in 2.5.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.8.8 tag, from src/wp-admin/includes/file.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.