W3cubDocs

/WordPress

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

$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

(bool|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

(bool) Whether to allow Group/World writable.

Source

File: wp-admin/includes/file.php

View on Trac

Used By

Used By Description
wp-admin/includes/file.php: request_filesystem_credentials()

Displays a form to the user to request for their FTP/SSH details in order to connect to the filesystem.

Changelog

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

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