class Textarea

Same name in this branch
  1. 11.x core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
Same name and namespace in other branches
  1. 9 core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
  2. 9 core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea
  3. 8.9.x core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
  4. 8.9.x core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea
  5. 10 core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
  6. 10 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'] = [
    '#type' => 'textarea',
    '#title' => $this->t('Text'),
];

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
16 string references to 'Textarea'
ckeditor5_form_filter_format_form_alter in core/modules/ckeditor5/ckeditor5.module
Implements hook_form_FORM_ID_alter().
ClaroPreRender::textFormat in core/themes/claro/src/ClaroPreRender.php
Prerender callback for text_format elements.
ConfigTranslationUiTestBase::assertDisabledTextarea in core/modules/config_translation/tests/src/Functional/ConfigTranslationUiTestBase.php
Asserts that a textarea with a given ID has been disabled from editing.
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.

... See full list

File

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

Namespace

Drupal\Core\Render\Element
View source 
class Textarea extends FormElementBase {
    
    /**
     * {@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

Title Modifiers Object type Summary Overriden Title Overrides
FormElementBase::processAutocomplete public static function Adds autocomplete functionality to elements. 1
FormElementBase::processPattern public static function #process callback for #pattern form element property. 1
FormElementBase::validatePattern public static function #element_validate callback for #pattern form element property. 1
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
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::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes 2
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 FormElementBase::valueCallback

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