1 filetransfer.inc public FileTransfer::getSettingsForm()

Returns a form to collect connection settings credentials.

Implementing classes can either extend this form with fields collecting the specific information they need, or override it entirely.

Return value

array: An array that contains a Form API definition.


core/includes/filetransfer/filetransfer.inc, line 462
Base FileTransfer class.


@file Base FileTransfer class.


public function getSettingsForm() {
  $form['username'] = array(
    '#type' => 'textfield',
    '#title' => t('Username'),
  $form['password'] = array(
    '#type' => 'password',
    '#title' => t('Password'),
    '#description' => t('Your password is not saved in the database and is only used to establish a connection.'),
    '#password_toggle' => TRUE,
  $form['advanced'] = array(
    '#type' => 'fieldset',
    '#title' => t('Advanced settings'),
    '#collapsible' => TRUE,
    '#collapsed' => TRUE,
  $form['advanced']['hostname'] = array(
    '#type' => 'textfield',
    '#title' => t('Host'),
    '#default_value' => 'localhost',
    '#description' => t('The connection will be created between your web server and the machine hosting the web server files. In the vast majority of cases, this will be the same machine, and "localhost" is correct.'),
  $form['advanced']['port'] = array(
    '#type' => 'textfield',
    '#title' => t('Port'),
    '#default_value' => NULL,
  return $form;