class Textarea
Same name in this branch
- main core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
Same name and namespace in other branches
- 11.x core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
- 11.x core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea
- 10 core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
- 10 core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea
- 9 core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
- 9 core/lib/Drupal/Core/Render/Element/Textarea.php \Drupal\Core\Render\Element\Textarea
- 8.9.x core/modules/config_translation/src/FormElement/Textarea.php \Drupal\config_translation\FormElement\Textarea
- 8.9.x 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'),
];Attributes
#[FormElement('textarea')]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Render\Element\FormElementBase implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\Textarea extends \Drupal\Core\Render\Element\FormElementBase
- class \Drupal\Core\Render\Element\FormElementBase implements \Drupal\Core\Render\Element\FormElementInterface extends \Drupal\Core\Render\Element\RenderElementBase
- class \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\ElementInterface extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\DependencyInjection\AutowiredInstanceTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
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'
- Ckeditor5Hooks::formFilterFormatFormAlter in core/
modules/ ckeditor5/ src/ Hook/ Ckeditor5Hooks.php - 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.
38 #type uses of Textarea
- AccountSettingsForm::buildForm in core/
modules/ user/ src/ AccountSettingsForm.php - BlockContentTypeForm::form in core/
modules/ block_content/ src/ BlockContentTypeForm.php - CKEditor5::buildConfigurationForm in core/
modules/ ckeditor5/ src/ Plugin/ Editor/ CKEditor5.php - Form constructor.
- CodeBlock::buildConfigurationForm in core/
modules/ ckeditor5/ src/ Plugin/ CKEditor5Plugin/ CodeBlock.php - Form constructor.
- CommentTypeForm::form in core/
modules/ comment/ src/ CommentTypeForm.php
File
-
core/
lib/ Drupal/ Core/ Render/ Element/ Textarea.php, line 29
Namespace
Drupal\Core\Render\ElementView source
class Textarea extends FormElementBase {
/**
* {@inheritdoc}
*/
public function getInfo() {
return [
'#input' => TRUE,
'#cols' => 60,
'#rows' => 5,
'#resizable' => 'vertical',
'#process' => [
[
static::class,
'processAjaxForm',
],
[
static::class,
'processGroup',
],
],
'#pre_render' => [
[
static::class,
'preRenderGroup',
],
[
static::class,
'preRenderAttachments',
],
],
'#theme' => 'textarea',
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* Adds the textarea resize library.
*/
public static function preRenderAttachments($element) : array {
$element['#attached']['library'][] = 'core/drupal.textarea-resize';
return $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;
}
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.