class Email
Same name in this branch
- 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
Same name and namespace in other branches
- 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
- 9 core/lib/Drupal/Core/Render/Element/Email.php \Drupal\Core\Render\Element\Email
- 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
Provides a form input element for entering an email address.
Properties:
@property $default_value An RFC-compliant email address. @property $size The size of the input element in characters. @property $pattern A string for the native HTML5 pattern attribute.
Example usage:
$form['email'] = [
'#type' => 'email',
'#title' => $this->t('Email'),
'#pattern' => '*@example.com',
];
Attributes
#[FormElement('email')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\Email implements \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\FormElementInterface implements \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Render\Element\ElementInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
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 32
Namespace
Drupal\Core\Render\ElementView source
class Email extends FormElementBase {
/**
* 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() {
return [
'#input' => TRUE,
'#size' => 60,
'#maxlength' => self::EMAIL_MAX_LENGTH,
'#autocomplete_route_name' => FALSE,
'#process' => [
[
static::class,
'processAutocomplete',
],
[
static::class,
'processAjaxForm',
],
[
static::class,
'processPattern',
],
],
'#element_validate' => [
[
static::class,
'validateEmail',
],
],
'#pre_render' => [
[
static::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. Use the format user@example.com.', [
'%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 | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
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'. | |||
FormElementBase::processAutocomplete | public static | function | Adds autocomplete functionality to elements. | 1 | ||
FormElementBase::processPattern | public static | function | Render API callback: Handles the #pattern form element property. | 1 | ||
FormElementBase::validatePattern | public static | function | Render API callback: Handles the #pattern form element property.. | 1 | ||
FormElementBase::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElementInterface::valueCallback | 17 | |
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 2 | |
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
RenderElementBase::$renderParent | protected | property | The parent element. | |||
RenderElementBase::$renderParentName | protected | property | The parent key. | |||
RenderElementBase::$storage | protected | property | The storage. | |||
RenderElementBase::addChild | public | function | Adds a child render element. | Overrides ElementInterface::addChild | ||
RenderElementBase::changeType | public | function | Change the type of the element. | Overrides ElementInterface::changeType | ||
RenderElementBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 2 | |
RenderElementBase::createChild | public | function | Creates a render object and attaches it to the current render object. | Overrides ElementInterface::createChild | ||
RenderElementBase::elementInfoManager | protected | function | Returns the element info manager. | |||
RenderElementBase::getChild | public | function | Gets a child. | Overrides ElementInterface::getChild | ||
RenderElementBase::getChildren | public | function | Returns child elements. | Overrides ElementInterface::getChildren | ||
RenderElementBase::initializeInternalStorage | public | function | Initialize storage. | Overrides ElementInterface::initializeInternalStorage | ||
RenderElementBase::preRenderAjaxForm | public static | function | Adds Ajax information about an element to communicate with JavaScript. | 2 | ||
RenderElementBase::preRenderGroup | public static | function | Adds members of this group as actual elements for rendering. | 2 | ||
RenderElementBase::processAjaxForm | public static | function | Form element processing handler for the #ajax form property. | 3 | ||
RenderElementBase::processGroup | public static | function | Arranges elements into groups. | 2 | ||
RenderElementBase::removeChild | public | function | Removes a child. | Overrides ElementInterface::removeChild | ||
RenderElementBase::setAttributes | public static | function | Sets a form element's class attribute. | Overrides ElementInterface::setAttributes | 2 | |
RenderElementBase::setType | protected | function | Set type on initialize. | 1 | ||
RenderElementBase::toRenderable | public | function | Returns a render array. | Overrides ElementInterface::toRenderable | ||
RenderElementBase::__construct | public | function | Constructs a new render element object. | Overrides PluginBase::__construct | 6 | |
RenderElementBase::__get | public | function | Magic method: gets a property value. | |||
RenderElementBase::__isset | public | function | Magic method: checks if a property value is set. | |||
RenderElementBase::__set | public | function | Magic method: Sets a property value. | |||
RenderElementBase::__sleep | public | function | Overrides DependencySerializationTrait::__sleep | |||
RenderElementBase::__unset | public | function | Magic method: unsets a property value. | |||
RenderElementBase::__wakeup | public | function | Overrides DependencySerializationTrait::__wakeup | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | ||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.