Description¶
- description¶
- Path
$GLOBALS['TCA'][$table]['columns'][$field]
- Required
false
- Type
string or LLL reference
- Scope
Display
The property can be used to display an additional help text between the field label and the user input when editing records. As an example, the Core uses the description property in the site configuration module when editing a site on some properties like
identifier
.The property is available on all common
TCA
types likeinput
andselect
and so on.
Example¶

The field can be used with a string that will be directly output or with a language reference:
EXT:styleguide/Configuration/TCA/tx_styleguide_elements_basic.php¶
[
'columns' => [
'input_1' => [
'l10n_mode' => 'prefixLangTitle',
'label' => 'input_1 description',
'description' => 'field description',
'config' => [
'type' => 'input',
'behaviour' => [
'allowLanguageSynchronization' => true,
],
],
],
],
]
You can find this example in the extension styleguide.