W3cubDocs

/WordPress

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

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

Description

See also

Parameters

$error

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

Default value: false

$context

(string) (Optional) Full path to the directory that is tested for being writable.

Default value: ''

$allow_relaxed_file_ownership

(bool) (Optional) Whether to allow Group/World writable.

Default value: false

Return

(bool) True on success, false on failure.

Source

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

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;
	}

Changelog

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

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/automatic_upgrader_skin/request_filesystem_credentials