class Textfield
Provides a one-line text field form element.
Properties:
- #maxlength: Maximum number of characters of input allowed.
 - #size: The size of the input element in characters.
 - #autocomplete_route_name: A route to be used as callback URL by the autocomplete JavaScript library.
 - #autocomplete_route_parameters: An array of parameters to be used in conjunction with the route name.
 - #pattern: A string for the native HTML5 pattern attribute.
 
Usage example:
$form['title'] = array(
  '#type' => 'textfield',
  '#title' => $this->t('Subject'),
  '#default_value' => $node->title,
  '#size' => 60,
  '#maxlength' => 128,
  '#pattern' => 'some-prefix-[a-z]+',
  '#required' => TRUE,
);Plugin annotation
@FormElement("textfield");
  
  Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \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 extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElement implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElement
- class \Drupal\Core\Render\Element\Textfield extends \Drupal\Core\Render\Element\FormElement
 
 
 - class \Drupal\Core\Render\Element\FormElement implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElement
 
 - class \Drupal\Core\Render\Element\RenderElement implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
 
 - class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
 
Expanded class hierarchy of Textfield
See also
\Drupal\Core\Render\Element\Color
\Drupal\Core\Render\Element\Email
\Drupal\Core\Render\Element\MachineName
\Drupal\Core\Render\Element\Number
\Drupal\Core\Render\Element\Password
\Drupal\Core\Render\Element\PasswordConfirm
\Drupal\Core\Render\Element\Range
\Drupal\Core\Render\Element\Tel
\Drupal\Core\Render\Element\Url
3 files declare their use of Textfield
- color.module in core/
modules/ color/ color.module  - Allows users to change the color scheme of themes.
 - EntityAutocomplete.php in core/
lib/ Drupal/ Core/ Entity/ Element/ EntityAutocomplete.php  - TextfieldTest.php in core/
tests/ Drupal/ Tests/ Core/ Render/ Element/ TextfieldTest.php  
27 string references to 'Textfield'
- 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.
 - EntityDisplayFormBaseTest::testCopyFormValuesToEntity in core/
tests/ Drupal/ KernelTests/ Core/ Entity/ EntityDisplayFormBaseTest.php  - @covers ::copyFormValuesToEntity[[api-linebreak]]
 - EntityField::multiple_options_form in core/
modules/ views/ src/ Plugin/ views/ field/ EntityField.php  - Provide options for multiple value fields.
 - FieldAttachOtherTest::testEntityFormDisplayBuildForm in core/
modules/ field/ tests/ src/ Kernel/ FieldAttachOtherTest.php  - Tests \Drupal\Core\Entity\Display\EntityFormDisplayInterface::buildForm().
 
264 #type uses of Textfield
- 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.
 - ActionAjaxTest::buildConfigurationForm in core/
modules/ action/ tests/ action_form_ajax_test/ src/ Plugin/ Action/ ActionAjaxTest.php  - Form constructor.
 - ActionFormBase::form in core/
modules/ action/ src/ Form/ ActionFormBase.php  - Gets the actual form array to be built.
 - AddHandler::buildForm in core/
modules/ views_ui/ src/ Form/ Ajax/ AddHandler.php  - Form constructor.
 
File
- 
              core/
lib/ Drupal/ Core/ Render/ Element/ Textfield.php, line 45  
Namespace
Drupal\Core\Render\ElementView source
class Textfield extends FormElement {
  
  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#size' => 60,
      '#maxlength' => 128,
      '#autocomplete_route_name' => FALSE,
      '#process' => [
        [
          $class,
          'processAutocomplete',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processPattern',
        ],
        [
          $class,
          'processGroup',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderTextfield',
        ],
        [
          $class,
          'preRenderGroup',
        ],
      ],
      '#theme' => 'input__textfield',
      '#theme_wrappers' => [
        'form_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.
      if (!is_scalar($input)) {
        $input = '';
      }
      return str_replace([
        "\r",
        "\n",
      ], '', $input);
    }
    return NULL;
  }
  
  /**
   * Prepares a #type 'textfield' 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 preRenderTextfield($element) {
    $element['#attributes']['type'] = 'text';
    Element::setAttributes($element, [
      'id',
      'name',
      'value',
      'size',
      'maxlength',
      'placeholder',
    ]);
    static::setAttributes($element, [
      'form-text',
    ]);
    return $element;
  }
}
Members
| Title Sort descending | 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. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| 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. | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
| 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 | public | function | Determines if the plugin is configurable. | ||
| PluginBase::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 85 | |
| 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 | |
| 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. | ||
| Textfield::getInfo | public | function | Returns the element properties for this element. | Overrides ElementInterface::getInfo | 3 | 
| Textfield::preRenderTextfield | public static | function | Prepares a #type 'textfield' render element for input.html.twig. | ||
| Textfield::valueCallback | public static | function | Determines how user input is mapped to an element's #value property. | Overrides FormElement::valueCallback | 3 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.