class Password
Same name in other branches
- 8.9.x core/lib/Drupal/Core/Render/Element/Password.php \Drupal\Core\Render\Element\Password
- 10 core/lib/Drupal/Core/Render/Element/Password.php \Drupal\Core\Render\Element\Password
- 11.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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\Password extends \Drupal\Core\Render\Element\FormElement
- class \Drupal\Core\Render\Element\FormElement extends \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
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 - Gets the actual form array to be built.
- 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 - Creates an instance of the plugin.
9 #type uses of Password
- AccountForm::form in core/
modules/ user/ src/ AccountForm.php - Gets the actual form array to be built.
- 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 - Form constructor.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Password.php, line 30
Namespace
Drupal\Core\Render\ElementView 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;
}
}
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. | ||
Password::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | |
Password::preRenderPassword | public static | function | Prepares a #type 'password' render element for input.html.twig. | ||
Password::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.