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

Determines whether the upgrader needs FTP/SSH details in order to connect to the filesystem.


Description

Top ↑

See also


Top ↑

Parameters

$error bool|WP_Error Optional
Whether the current request has failed to connect, or an error object.

Default: false

$context string Optional
Full path to the directory that is tested for being writable.

Default: ''

$allow_relaxed_file_ownership bool Optional
Whether to allow Group/World writable.

Default: false


Top ↑

Return

bool True on success, false on failure.


Top ↑

Source

File: wp-admin/includes/class-automatic-upgrader-skin.php. View all references

public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {
	if ( $context ) {
		$this->options['context'] = $context;
	}
	/*
	 * TODO: Fix up request_filesystem_credentials(), or split it, to allow us to request a no-output version.
	 * This will output a credentials form in event of failure. We don't want that, so just hide with a buffer.
	 */
	ob_start();
	$result = parent::request_filesystem_credentials( $error, $context, $allow_relaxed_file_ownership );
	ob_end_clean();
	return $result;
}


Top ↑

Changelog

Changelog
Version Description
4.6.0 The $context parameter default changed from false to an empty string.
3.7.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.