class Tel

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

Provides a form element for entering a telephone number.

Provides an HTML5 input element with type of "tel". It provides no special validation.

Properties:

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

Usage example:

$form['phone'] = array(
    '#type' => 'tel',
    '#title' => $this->t('Phone'),
    '#pattern' => '[^\\d]*',
);

Plugin annotation

@FormElement("tel");

Hierarchy

Expanded class hierarchy of Tel

See also

\Drupal\Core\Render\Element

12 string references to 'Tel'
claro_preprocess_input in core/themes/claro/claro.theme
Implements template_preprocess_HOOK() for input.
core.services.yml in core/core.services.yml
core/core.services.yml
default.services.yml in sites/default/default.services.yml
sites/default/default.services.yml
default.services.yml in core/assets/scaffold/files/default.services.yml
core/assets/scaffold/files/default.services.yml
ElementTest::testPlaceHolderText in core/modules/system/tests/src/Functional/Form/ElementTest.php
Tests placeholder text for elements that support placeholders.

... See full list

3 #type uses of Tel
FormTest::testRequiredFields in core/modules/system/tests/src/Functional/Form/FormTest.php
Check several empty values for required forms elements.
FormTestPatternForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestPatternForm.php
Form constructor.
TelephoneDefaultWidget::formElement in core/modules/telephone/src/Plugin/Field/FieldWidget/TelephoneDefaultWidget.php
Returns the form for a single field widget.

File

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

Namespace

Drupal\Core\Render\Element
View source
class Tel extends FormElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $class = get_class($this);
        return [
            '#input' => TRUE,
            '#size' => 30,
            '#maxlength' => 128,
            '#autocomplete_route_name' => FALSE,
            '#process' => [
                [
                    $class,
                    'processAutocomplete',
                ],
                [
                    $class,
                    'processAjaxForm',
                ],
                [
                    $class,
                    'processPattern',
                ],
            ],
            '#pre_render' => [
                [
                    $class,
                    'preRenderTel',
                ],
            ],
            '#theme' => 'input__tel',
            '#theme_wrappers' => [
                'form_element',
            ],
        ];
    }
    
    /**
     * Prepares a #type 'tel' 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 preRenderTel($element) {
        $element['#attributes']['type'] = 'tel';
        Element::setAttributes($element, [
            'id',
            'name',
            'value',
            'size',
            'maxlength',
            'placeholder',
        ]);
        static::setAttributes($element, [
            'form-tel',
        ]);
        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.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
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
Tel::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Tel::preRenderTel public static function Prepares a #type 'tel' render element for input.html.twig.

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