request_filesystem_credentials │ filter-hook │ WP 2.5.0

Filters the filesystem credentials.

Returning anything other than an empty string will effectively short-circuit output of the filesystem credentials form, returning that value instead.

A filter should return true if no filesystem credentials are required, false if they are required but have not been provided, or an array of credentials if they are required and have been provided.

Usage

add_filter( 'request_filesystem_credentials', 'wp_kama_request_filesystem_credentials_filter', 10, 7 );

/**
 * Function for `request_filesystem_credentials` filter-hook.
 * 
 * @param mixed         $credentials                  Credentials to return instead.
 * @param string        $form_post                    The URL to post the form to.
 * @param string        $type                         Chosen type of filesystem.
 * @param bool|WP_Error $error                        Whether the current request has failed to connect, or an error object.
 * @param string        $context                      Full path to the directory that is tested for being writable.
 * @param array         $extra_fields                 Extra POST fields.
 * @param bool          $allow_relaxed_file_ownership Whether to allow Group/World writable.
 *
 * @return mixed
 */
function wp_kama_request_filesystem_credentials_filter( $credentials, $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership ){

	// filter...
	return $credentials;
}

$credentials(mixed)

Credentials to return instead.
Default: empty string

$form_post(string)

The URL to post the form to.

$type(string)

Chosen type of filesystem.

$error(true|false|WP_Error)

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

$context(string)

Full path to the directory that is tested for being writable.

$extra_fields(array)

Extra POST fields.

$allow_relaxed_file_ownership(true|false)

Whether to allow Group/World writable.

Changelog

Where the hook is called

$req_cred = apply_filters( 'request_filesystem_credentials', '', $form_post, $type, $error, $context, $extra_fields, $allow_relaxed_file_ownership );

Where the hook is used in WordPress