request_filesystem_credentials – Hook

apply_filters( ‘request_filesystem_credentials’, mixed $credentials, string $form_post, string $type, bool|WP_Error $error, string $context, array $extra_fields, bool $allow_relaxed_file_ownership )

Filters the filesystem credentials.

Description

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.

Parameters

$credentialsmixed: Credentials to return instead. Default empty string.
$form_poststring: The URL to post the form to.
$typestring: Chosen type of filesystem.
$errorbool|WP_Error: Whether the current request has failed to connect, or an error object.
$contextstring: Full path to the directory that is tested for being writable.
$extra_fieldsarray: Extra POST fields.
$allow_relaxed_file_ownershipbool: Whether to allow Group/World writable.

Source

* output of the filesystem credentials form, returning that value instead.

View all references View on Trac View on GitHub

Changelog

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

User Contributed Notes

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