class PasswordConfirm

Same name in other branches
  1. 9 core/lib/Drupal/Core/Render/Element/PasswordConfirm.php \Drupal\Core\Render\Element\PasswordConfirm
  2. 10 core/lib/Drupal/Core/Render/Element/PasswordConfirm.php \Drupal\Core\Render\Element\PasswordConfirm
  3. 11.x core/lib/Drupal/Core/Render/Element/PasswordConfirm.php \Drupal\Core\Render\Element\PasswordConfirm

Provides a form element for double-input of passwords.

Formats as a pair of password fields, which do not validate unless the two entered passwords match.

Properties:

  • #size: The size of the input element in characters.

Usage example:

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

Plugin annotation

@FormElement("password_confirm");

Hierarchy

Expanded class hierarchy of PasswordConfirm

See also

\Drupal\Core\Render\Element\Password

1 file declares its use of PasswordConfirm
PasswordConfirmTest.php in core/tests/Drupal/Tests/Core/Render/Element/PasswordConfirmTest.php
4 #type uses of PasswordConfirm
AccountForm::form in core/modules/user/src/AccountForm.php
Gets the actual form array to be built.
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
Form constructor.
SiteConfigureForm::buildForm in core/lib/Drupal/Core/Installer/Form/SiteConfigureForm.php
Form constructor.

File

core/lib/Drupal/Core/Render/Element/PasswordConfirm.php, line 29

Namespace

Drupal\Core\Render\Element
View source
class PasswordConfirm extends FormElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = get_class($this);
        return [
            '#input' => TRUE,
            '#markup' => '',
            '#process' => [
                [
                    $class,
                    'processPasswordConfirm',
                ],
            ],
            '#theme_wrappers' => [
                'form_element',
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
        if ($input === FALSE) {
            $element += [
                '#default_value' => [],
            ];
            return $element['#default_value'] + [
                'pass1' => '',
                'pass2' => '',
            ];
        }
        $value = [
            'pass1' => '',
            'pass2' => '',
        ];
        // Throw out all invalid array keys; we only allow pass1 and pass2.
        foreach ($value as $allowed_key => $default) {
            // These should be strings, but allow other scalars since they might be
            // valid input in programmatic form submissions. Any nested array values
            // are ignored.
            if (isset($input[$allowed_key]) && is_scalar($input[$allowed_key])) {
                $value[$allowed_key] = (string) $input[$allowed_key];
            }
        }
        return $value;
    }
    
    /**
     * Expand a password_confirm field into two text boxes.
     */
    public static function processPasswordConfirm(&$element, FormStateInterface $form_state, &$complete_form) {
        $element['pass1'] = [
            '#type' => 'password',
            '#title' => t('Password'),
            '#value' => empty($element['#value']) ? NULL : $element['#value']['pass1'],
            '#required' => $element['#required'],
            '#attributes' => [
                'class' => [
                    'password-field',
                    'js-password-field',
                ],
                'autocomplete' => [
                    'new-password',
                ],
            ],
            '#error_no_message' => TRUE,
        ];
        $element['pass2'] = [
            '#type' => 'password',
            '#title' => t('Confirm password'),
            '#value' => empty($element['#value']) ? NULL : $element['#value']['pass2'],
            '#required' => $element['#required'],
            '#attributes' => [
                'class' => [
                    'password-confirm',
                    'js-password-confirm',
                ],
                'autocomplete' => [
                    'new-password',
                ],
            ],
            '#error_no_message' => TRUE,
        ];
        $element['#element_validate'] = [
            [
                get_called_class(),
                'validatePasswordConfirm',
            ],
        ];
        $element['#tree'] = TRUE;
        if (isset($element['#size'])) {
            $element['pass1']['#size'] = $element['pass2']['#size'] = $element['#size'];
        }
        return $element;
    }
    
    /**
     * Validates a password_confirm element.
     */
    public static function validatePasswordConfirm(&$element, FormStateInterface $form_state, &$complete_form) {
        $pass1 = trim($element['pass1']['#value']);
        $pass2 = trim($element['pass2']['#value']);
        if (strlen($pass1) > 0 || strlen($pass2) > 0) {
            if (strcmp($pass1, $pass2)) {
                $form_state->setError($element, t('The specified passwords do not match.'));
            }
        }
        elseif ($element['#required'] && $form_state->getUserInput()) {
            $form_state->setError($element, t('Password field is required.'));
        }
        // Password field must be converted from a two-element array into a single
        // string regardless of validation results.
        $form_state->setValueForElement($element['pass1'], NULL);
        $form_state->setValueForElement($element['pass2'], NULL);
        $form_state->setValueForElement($element, $pass1);
        return $element;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
PasswordConfirm::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
PasswordConfirm::processPasswordConfirm public static function Expand a password_confirm field into two text boxes.
PasswordConfirm::validatePasswordConfirm public static function Validates a password_confirm element.
PasswordConfirm::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes

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