You are here

Home » API reference » Drupal 10 » Textarea.php

class Textarea in Drupal 10

Same name in this branch
  1. 10 core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
  2. 10 core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea
Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea
  2. 9 core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea

Provides a form element for input of multiple-line text.

Properties:

  • #rows: Number of rows in the text box.
  • #cols: Number of columns in the text box.
  • #resizable: Controls whether the text area is resizable. Allowed values are "none", "vertical", "horizontal", or "both" (defaults to "vertical").
  • #maxlength: The maximum amount of characters to accept as input.

Usage example:

$form['text'] = array(
  '#type' => 'textarea',
  '#title' => $this
    ->t('Text'),
);

Plugin annotation

@FormElement("textarea");

Hierarchy

Expanded class hierarchy of Textarea

See also

\Drupal\Core\Render\Element\Textfield

\Drupal\filter\Element\TextFormat

1 file declares its use of Textarea
TextareaTest.php in core/tests/Drupal/Tests/Core/Render/Element/TextareaTest.php
36 #type uses of Textarea
AccountSettingsForm::buildForm in core/modules/user/src/AccountSettingsForm.php
Form constructor.
BlockContentTypeForm::form in core/modules/block_content/src/BlockContentTypeForm.php
CKEditor5::buildConfigurationForm in core/modules/ckeditor5/src/Plugin/Editor/CKEditor5.php
CKEditor::buildConfigurationForm in core/modules/ckeditor/src/Plugin/Editor/CKEditor.php
CommentTypeForm::form in core/modules/comment/src/CommentTypeForm.php
Gets the actual form array to be built.

... See full list

File

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

Namespace

Drupal\Core\Render\Element
View source 
class Textarea extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = static::class;
    return [
      '#input' => TRUE,
      '#cols' => 60,
      '#rows' => 5,
      '#resizable' => 'vertical',
      '#process' => [
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processGroup',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderGroup',
        ],
      ],
      '#theme' => 'textarea',
      '#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.
      return is_scalar($input) ? (string) $input : '';
    }
    return NULL;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 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. 18
MessengerTrait::messenger public function Gets the messenger. 18
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.
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
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 2
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 53
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. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
Textarea::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Textarea::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback