WPDev.one
Core Function
View Source on Trac ↗

request_filesystem_credentials()

request_filesystem_credentials( mixed $form_post, mixed $type = '', mixed $error = false, mixed $context = '', mixed $extra_fields = null, mixed $allow_relaxed_file_ownership = false )

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

Parameters 5 required

Name / Type Description
$form_post
string

The URL to post the form to.

Required
$type
string

Optional. Chosen type of filesystem. Default empty.

mixed

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

Required
string

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

Required
array

$extra_fields Optional. Extra `POST` fields to be checked for inclusion in the post. Default null.

Required
bool

$allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.

Required

Return Value

((bool)
(bool | array) True if no filesystem credentials are required, false if they are required but have not been provided, array of credentials if they are required and have been provided.

Function Information

Since Version
2.5.0
Source File
wp-admin/includes/file.php
Advertisement