WP_Upgrader::fs_connect( string[] $directories = array(), bool $allow_relaxed_file_ownership = false ): bool|WP_Error

Compatibility

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

Parameters

$directoriesstring[]optional

Array of directories. If any of these do not exist, a WP_Error object will be returned.
Default empty array.Default: array()

$allow_relaxed_file_ownershipbooloptional

Whether to allow relaxed file ownership.
Default false.Default: false

Return value

bool|WP_Error

True if able to connect, false or a WP_Error otherwise.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

15–73

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

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

• hookthird-party callbacksapply_filters()one call below WP_Upgrader::fs_connect()

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

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

Uses · 5

• WP_Filesystem()Initializes and connects the WordPress Filesystem Abstraction classes.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_theme_root()Retrieves path to themes directory.
• esc_html()Escaping for HTML blocks.
• WP_Error::__construct()Initializes the error.

Used by · 1

• WP_Upgrader::run()Runs an upgrade/installation.

Source code

View on Trac ↗View on GitHub ↗

236	public function fs_connect( $directories = array(), $allow_relaxed_file_ownership = false ) {237		global $wp_filesystem;238 239		$credentials = $this->skin->request_filesystem_credentials( false, $directories[0], $allow_relaxed_file_ownership );240		if ( false === $credentials ) {241			return false;242		}243 244		if ( ! WP_Filesystem( $credentials, $directories[0], $allow_relaxed_file_ownership ) ) {245			$error = true;246			if ( is_object( $wp_filesystem ) && $wp_filesystem->errors->has_errors() ) {247				$error = $wp_filesystem->errors;248			}249			// Failed to connect. Error and request again.250			$this->skin->request_filesystem_credentials( $error, $directories[0], $allow_relaxed_file_ownership );251			return false;252		}253 254		if ( ! is_object( $wp_filesystem ) ) {255			return new WP_Error( 'fs_unavailable', $this->strings['fs_unavailable'] );256		}257 258		if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {259			return new WP_Error( 'fs_error', $this->strings['fs_error'], $wp_filesystem->errors );260		}261 262		foreach ( (array) $directories as $dir ) {263			switch ( $dir ) {264				case ABSPATH:265					if ( ! $wp_filesystem->abspath() ) {266						return new WP_Error( 'fs_no_root_dir', $this->strings['fs_no_root_dir'] );267					}268					break;269				case WP_CONTENT_DIR:270					if ( ! $wp_filesystem->wp_content_dir() ) {271						return new WP_Error( 'fs_no_content_dir', $this->strings['fs_no_content_dir'] );272					}273					break;274				case WP_PLUGIN_DIR:275					if ( ! $wp_filesystem->wp_plugins_dir() ) {276						return new WP_Error( 'fs_no_plugins_dir', $this->strings['fs_no_plugins_dir'] );277					}278					break;279				case get_theme_root():280					if ( ! $wp_filesystem->wp_themes_dir() ) {281						return new WP_Error( 'fs_no_themes_dir', $this->strings['fs_no_themes_dir'] );282					}283					break;284				default:285					if ( ! $wp_filesystem->find_folder( $dir ) ) {286						return new WP_Error( 'fs_no_folder', sprintf( $this->strings['fs_no_folder'], esc_html( basename( $dir ) ) ) );287					}288					break;289			}290		}291		return true;292	}

Changelog

Introduced in 2.8.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 7.1.0 tag, from src/wp-admin/includes/class-wp-upgrader.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.