public function AccountFormController::form

Overrides Drupal\Core\Entity\EntityFormController::form().

Overrides EntityFormController::form

File

drupal/core/modules/user/lib/Drupal/user/AccountFormController.php, line 21

Definition of Drupal\user\AccountFormController.

Class

AccountFormController

Form controller for the user account forms.

Namespace

Code

public function form(array $form, array &$form_state, EntityInterface $account) {
  global $user;
  $config = config('user.settings');
  $language_interface = language(LANGUAGE_TYPE_INTERFACE);
  $register = empty($account->uid);
  $admin = user_access('administer users');

  // Account information.
  $form['account'] = array(
    '#type' => 'container',
    '#weight' => -10,
  );

  // Only show name field on registration form or user can change own username.
  $form['account']['name'] = array(
    '#type' => 'textfield',
    '#title' => t('Username'),
    '#maxlength' => USERNAME_MAX_LENGTH,
    '#description' => t('Spaces are allowed; punctuation is not allowed except for periods, hyphens, apostrophes, and underscores.'),
    '#required' => TRUE,
    '#attributes' => array(
      'class' => array(
        'username',
      ),
      'autocomplete' => 'off',
    ),
    '#default_value' => !$register ? $account->name : '',
    '#access' => $register || $user->uid == $account->uid && user_access('change own username') || $admin,
    '#weight' => -10,
  );

  // The mail field is NOT required if account originally had no mail set
  // and the user performing the edit has 'administer users' permission.
  // This allows users without e-mail address to be edited and deleted.
  $form['account']['mail'] = array(
    '#type' => 'email',
    '#title' => t('E-mail address'),
    '#description' => t('A valid e-mail address. All e-mails from the system will be sent to this address. The e-mail address is not made public and will only be used if you wish to receive a new password or wish to receive certain news or notifications by e-mail.'),
    '#required' => !(empty($account->mail) && user_access('administer users')),
    '#default_value' => !$register ? $account->mail : '',
    '#attributes' => array(
      'autocomplete' => 'off',
    ),
  );

  // Display password field only for existing users or when user is allowed to
  // assign a password during registration.
  if (!$register) {
    $form['account']['pass'] = array(
      '#type' => 'password_confirm',
      '#size' => 25,
      '#description' => t('To change the current user password, enter the new password in both fields.'),
    );

    // To skip the current password field, the user must have logged in via a
    // one-time link and have the token in the URL.
    $pass_reset = isset($_SESSION['pass_reset_' . $account->uid]) && isset($_GET['pass-reset-token']) && $_GET['pass-reset-token'] == $_SESSION['pass_reset_' . $account->uid];
    $protected_values = array();
    $current_pass_description = '';

    // The user may only change their own password without their current
    // password if they logged in via a one-time login link.
    if (!$pass_reset) {
      $protected_values['mail'] = $form['account']['mail']['#title'];
      $protected_values['pass'] = t('Password');
      $request_new = l(t('Request new password'), 'user/password', array(
        'attributes' => array(
          'title' => t('Request new password via e-mail.'),
        ),
      ));
      $current_pass_description = t('Required if you want to change the %mail or %pass below. !request_new.', array(
        '%mail' => $protected_values['mail'],
        '%pass' => $protected_values['pass'],
        '!request_new' => $request_new,
      ));
    }

    // The user must enter their current password to change to a new one.
    if ($user->uid == $account->uid) {
      $form['account']['current_pass_required_values'] = array(
        '#type' => 'value',
        '#value' => $protected_values,
      );
      $form['account']['current_pass'] = array(
        '#type' => 'password',
        '#title' => t('Current password'),
        '#size' => 25,
        '#access' => !empty($protected_values),
        '#description' => $current_pass_description,
        '#weight' => -5,
        '#attributes' => array(
          'autocomplete' => 'off',
        ),
      );
      $form_state['user'] = $account;
      $form['#validate'][] = 'user_validate_current_pass';
    }
  }
  elseif (!$config
    ->get('verify_mail') || $admin) {
    $form['account']['pass'] = array(
      '#type' => 'password_confirm',
      '#size' => 25,
      '#description' => t('Provide a password for the new account in both fields.'),
      '#required' => TRUE,
    );
  }
  if ($admin) {
    $status = isset($account->status) ? $account->status : 1;
  }
  else {
    $status = $register ? $config
      ->get('register') == USER_REGISTER_VISITORS : $account->status;
  }
  $form['account']['status'] = array(
    '#type' => 'radios',
    '#title' => t('Status'),
    '#default_value' => $status,
    '#options' => array(
      t('Blocked'),
      t('Active'),
    ),
    '#access' => $admin,
  );
  $roles = array_map('check_plain', user_roles(TRUE));

  // The disabled checkbox subelement for the 'authenticated user' role
  // must be generated separately and added to the checkboxes element,
  // because of a limitation in Form API not supporting a single disabled
  // checkbox within a set of checkboxes.
  // @todo This should be solved more elegantly. See issue #119038.
  $checkbox_authenticated = array(
    '#type' => 'checkbox',
    '#title' => $roles[DRUPAL_AUTHENTICATED_RID],
    '#default_value' => TRUE,
    '#disabled' => TRUE,
  );
  unset($roles[DRUPAL_AUTHENTICATED_RID]);
  $form['account']['roles'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Roles'),
    '#default_value' => !$register && isset($account->roles) ? array_keys($account->roles) : array(),
    '#options' => $roles,
    '#access' => $roles && user_access('administer permissions'),
    DRUPAL_AUTHENTICATED_RID => $checkbox_authenticated,
  );
  $form['account']['notify'] = array(
    '#type' => 'checkbox',
    '#title' => t('Notify user of new account'),
    '#access' => $register && $admin,
  );

  // Signature.
  $form['signature_settings'] = array(
    '#type' => 'details',
    '#title' => t('Signature settings'),
    '#weight' => 1,
    '#access' => !$register && $config
      ->get('signatures'),
  );
  $form['signature_settings']['signature'] = array(
    '#type' => 'text_format',
    '#title' => t('Signature'),
    '#default_value' => isset($account->signature) ? $account->signature : '',
    '#description' => t('Your signature will be publicly displayed at the end of your comments.'),
    '#format' => isset($account->signature_format) ? $account->signature_format : NULL,
  );
  $user_preferred_langcode = $register ? $language_interface->langcode : user_preferred_langcode($account);
  $user_preferred_admin_langcode = $register ? $language_interface->langcode : user_preferred_langcode($account, 'admin');

  // Is default the interface language?
  include_once DRUPAL_ROOT . '/core/includes/language.inc';
  $interface_language_is_default = language_negotiation_method_get_first(LANGUAGE_TYPE_INTERFACE) != LANGUAGE_NEGOTIATION_SELECTED;
  $form['language'] = array(
    '#type' => language_multilingual() ? 'details' : 'container',
    '#title' => t('Language settings'),
    // Display language selector when either creating a user on the admin
    // interface or editing a user account.
    '#access' => !$register || user_access('administer users'),
  );
  $form['language']['preferred_langcode'] = array(
    '#type' => 'language_select',
    '#title' => t('Site language'),
    '#languages' => LANGUAGE_CONFIGURABLE,
    '#default_value' => $user_preferred_langcode,
    '#description' => $interface_language_is_default ? t("This account's preferred language for e-mails and site presentation.") : t("This account's preferred language for e-mails."),
  );
  $form['language']['preferred_admin_langcode'] = array(
    '#type' => 'language_select',
    '#title' => t('Administration pages language'),
    '#languages' => LANGUAGE_CONFIGURABLE,
    '#default_value' => $user_preferred_admin_langcode,
    '#access' => user_access('access administration pages', $account),
  );

  // User entities contain both a langcode property (for identifying the
  // language of the entity data) and a preferred_langcode property (see
  // above). Rather than provide a UI forcing the user to choose both
  // separately, assume that the user profile data is in the user's preferred
  // language. This element provides that synchronization. For use-cases where
  // this synchronization is not desired, a module can alter or remove this
  // element.
  $form['language']['langcode'] = array(
    '#type' => 'value',
    '#value_callback' => '_user_language_selector_langcode_value',
    // For the synchronization to work, this element must have a larger weight
    // than the preferred_langcode element. Set a large weight here in case
    // a module alters the weight of the other element.
    '#weight' => 100,
  );
  return parent::form($form, $form_state, $account);
}