WP_Upgrader_Skin::request_filesystem_credentials( bool|WP_Error $error = false, string $context = '', bool $allow_relaxed_file_ownership = false ): bool

Compatibility

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

Parameters

$errorbool|WP_Erroroptional

Whether the current request has failed to connect, or an error object. Default false.Default: false

$contextstringoptional

Full path to the directory that is tested for being writable. Default empty.Default: ''

$allow_relaxed_file_ownershipbooloptional

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

Return value

bool

True on success, false on failure.

Performance profile

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

Moderate

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

Scaling

Constant

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

Instructions

19–30

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

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_Skin::request_filesystem_credentials()
• optionoption read or writeget_option()one call below WP_Upgrader_Skin::request_filesystem_credentials()

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 · 2 distinct outcomes

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

Uses · 2

• wp_nonce_url()Retrieves URL with nonce added to URL query.
• request_filesystem_credentials()Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.

Used by · 1

• Automatic_Upgrader_Skin::request_filesystem_credentials()Determines whether the upgrader needs FTP/SSH details in order to connect to the filesystem.

Source code

View on Trac ↗View on GitHub ↗

128	public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {129		$url = $this->options['url'];130		if ( ! $context ) {131			$context = $this->options['context'];132		}133		if ( ! empty( $this->options['nonce'] ) ) {134			$url = wp_nonce_url( $url, $this->options['nonce'] );135		}136 137		$extra_fields = array();138 139		return request_filesystem_credentials( $url, '', $error, $context, $extra_fields, $allow_relaxed_file_ownership );140	}

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.0.4 tag, from src/wp-admin/includes/class-wp-upgrader-skin.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.