class Email
Same name in this branch
- 9 core/modules/field/src/Plugin/migrate/field/Email.php \Drupal\field\Plugin\migrate\field\Email
- 9 core/lib/Drupal/Core/TypedData/Plugin/DataType/Email.php \Drupal\Core\TypedData\Plugin\DataType\Email
Same name in other branches
- 8.9.x core/modules/field/src/Plugin/migrate/field/Email.php \Drupal\field\Plugin\migrate\field\Email
- 8.9.x core/lib/Drupal/Core/TypedData/Plugin/DataType/Email.php \Drupal\Core\TypedData\Plugin\DataType\Email
- 8.9.x core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
- 8.9.x core/lib/Drupal/Core/Field/Plugin/migrate/field/Email.php \Drupal\Core\Field\Plugin\migrate\field\Email
- 10 core/modules/field/src/Plugin/migrate/field/Email.php \Drupal\field\Plugin\migrate\field\Email
- 10 core/lib/Drupal/Core/TypedData/Plugin/DataType/Email.php \Drupal\Core\TypedData\Plugin\DataType\Email
- 10 core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
- 11.x core/modules/field/src/Plugin/migrate/field/Email.php \Drupal\field\Plugin\migrate\field\Email
- 11.x core/lib/Drupal/Core/TypedData/Plugin/DataType/Email.php \Drupal\Core\TypedData\Plugin\DataType\Email
- 11.x core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
Provides a form input element for entering an email address.
Properties:
- #default_value: An RFC-compliant email address.
- #size: The size of the input element in characters.
- #pattern: A string for the native HTML5 pattern attribute.
Example usage:
$form['email'] = [
'#type' => 'email',
'#title' => $this->t('Email'),
'#pattern' => '*@example.com',
];
Plugin annotation
@FormElement("email");
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\Email 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 Email
See also
\Drupal\Core\Render\Element\Textfield
4 files declare their use of Email
- EmailDefaultWidget.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldWidget/ EmailDefaultWidget.php - EmailItem.php in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ EmailItem.php - UserPasswordForm.php in core/
modules/ user/ src/ Form/ UserPasswordForm.php - UserValidationTest.php in core/
modules/ user/ tests/ src/ Kernel/ UserValidationTest.php
51 string references to 'Email'
- AccountSettingsForm::buildForm in core/
modules/ user/ src/ AccountSettingsForm.php - Form constructor.
- claro_preprocess_input in core/
themes/ claro/ claro.theme - Implements template_preprocess_HOOK() for input.
- CommentForm::form in core/
modules/ comment/ src/ CommentForm.php - Gets the actual form array to be built.
- ConstraintManager::registerDefinitions in core/
lib/ Drupal/ Core/ Validation/ ConstraintManager.php - Callback for registering definitions for constraints shipped with Symfony.
- contact.schema.yml in core/
modules/ contact/ config/ schema/ contact.schema.yml - core/modules/contact/config/schema/contact.schema.yml
10 #type uses of Email
- AccountForm::form in core/
modules/ user/ src/ AccountForm.php - Gets the actual form array to be built.
- AccountSettingsForm::buildForm in core/
modules/ user/ src/ AccountSettingsForm.php - Form constructor.
- CommentForm::form in core/
modules/ comment/ src/ CommentForm.php - Gets the actual form array to be built.
- EmailDefaultWidget::formElement in core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldWidget/ EmailDefaultWidget.php - Returns the form for a single field widget.
- FormTestDisabledElementsForm::buildForm in core/
modules/ system/ tests/ modules/ form_test/ src/ Form/ FormTestDisabledElementsForm.php - Form constructor.
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Email.php, line 29
Namespace
Drupal\Core\Render\ElementView source
class Email extends FormElement {
/**
* Defines the max length for an email address.
*
* The maximum length of an email address is 254 characters. RFC 3696
* specifies a total length of 320 characters, but mentions that
* addresses longer than 256 characters are not normally useful. Erratum
* 1690 was then released which corrected this value to 254 characters.
* @see http://tools.ietf.org/html/rfc3696#section-3
* @see http://www.rfc-editor.org/errata_search.php?rfc=3696&eid=1690
*/
const EMAIL_MAX_LENGTH = 254;
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = static::class;
return [
'#input' => TRUE,
'#size' => 60,
'#maxlength' => self::EMAIL_MAX_LENGTH,
'#autocomplete_route_name' => FALSE,
'#process' => [
[
$class,
'processAutocomplete',
],
[
$class,
'processAjaxForm',
],
[
$class,
'processPattern',
],
],
'#element_validate' => [
[
$class,
'validateEmail',
],
],
'#pre_render' => [
[
$class,
'preRenderEmail',
],
],
'#theme' => 'input__email',
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* Form element validation handler for #type 'email'.
*
* Note that #maxlength and #required is validated by _form_validate() already.
*/
public static function validateEmail(&$element, FormStateInterface $form_state, &$complete_form) {
$value = trim($element['#value']);
$form_state->setValueForElement($element, $value);
if ($value !== '' && !\Drupal::service('email.validator')->isValid($value)) {
$form_state->setError($element, t('The email address %mail is not valid.', [
'%mail' => $value,
]));
}
}
/**
* Prepares a #type 'email' 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 preRenderEmail($element) {
$element['#attributes']['type'] = 'email';
Element::setAttributes($element, [
'id',
'name',
'value',
'size',
'maxlength',
'placeholder',
]);
static::setAttributes($element, [
'form-email',
]);
return $element;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
Email::EMAIL_MAX_LENGTH | constant | Defines the max length for an email address. | |||
Email::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | |
Email::preRenderEmail | public static | function | Prepares a #type 'email' render element for input.html.twig. | ||
Email::validateEmail | public static | function | Form element validation handler for #type 'email'. | ||
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. | ||
FormElement::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElementInterface::valueCallback | 16 |
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.