class Password

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Render/Element/Password.php \Drupal\Core\Render\Element\Password
  2. 10 core/lib/Drupal/Core/Render/Element/Password.php \Drupal\Core\Render\Element\Password
  3. 8.9.x core/lib/Drupal/Core/Render/Element/Password.php \Drupal\Core\Render\Element\Password

Provides a form element for entering a password, with hidden text.

Properties:

  • #size: The size of the input element in characters.
  • #pattern: A string for the native HTML5 pattern attribute.

Usage example:

$form['pass'] = array(
  '#type' => 'password',
  '#title' => $this->t('Password'),
  '#size' => 25,
  '#pattern' => '[01]+',
);

Plugin annotation

@FormElement("password");

Hierarchy

Expanded class hierarchy of Password

See also

\Drupal\Core\Render\Element\PasswordConfirm

\Drupal\Core\Render\Element\Textfield

1 file declares its use of Password
PasswordTest.php in core/tests/Drupal/Tests/Core/Render/Element/PasswordTest.php
29 string references to 'Password'
AccountForm::form in core/modules/user/src/AccountForm.php
claro_preprocess_input in core/themes/claro/claro.theme
Implements template_preprocess_HOOK() for input.
ContentTranslationHandler::addTranslatabilityClue in core/modules/content_translation/src/ContentTranslationHandler.php
Adds a clue about the form element translatability.
ElementTest::testPlaceHolderText in core/modules/system/tests/src/Functional/Form/ElementTest.php
Tests placeholder text for elements that support placeholders.
EntityUser::create in core/modules/user/src/Plugin/migrate/destination/EntityUser.php

... See full list

9 #type uses of Password
AccountForm::form in core/modules/user/src/AccountForm.php
FileTransfer::getSettingsForm in core/lib/Drupal/Core/FileTransfer/FileTransfer.php
Returns a form to collect connection settings credentials.
FormElementsRenderTest::testDrupalRenderFormElements in core/modules/system/tests/src/Kernel/Common/FormElementsRenderTest.php
Tests rendering form elements without using doBuildForm().
FormTest::testRequiredFields in core/modules/system/tests/src/Functional/Form/FormTest.php
Check several empty values for required forms elements.
FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php

... See full list

File

core/lib/Drupal/Core/Render/Element/Password.php, line 30

Namespace

Drupal\Core\Render\Element
View on git.drupalcode.org
View source 
class Password extends FormElement {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => 128,
      '#process' => [
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderPassword',
        ],
      ],
      '#theme' => 'input__password',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }
  
  /**
   * Prepares a #type 'password' render element for input.html.twig.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for input.html.twig.
   */
  public static function preRenderPassword($element) {
    $element['#attributes']['type'] = 'password';
    Element::setAttributes($element, [
      'id',
      'name',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-text',
    ]);
    return $element;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input !== FALSE && $input !== NULL) {
      // This should be a string, but allow other scalars since they might be
      // valid input in programmatic form submissions.
      return is_scalar($input) ? (string) $input : '';
    }
    return NULL;
  }

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.