function DataDefinitionInterface::getDescription
Same name in other branches
- 9 core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php \Drupal\Core\TypedData\DataDefinitionInterface::getDescription()
- 8.9.x core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php \Drupal\Core\TypedData\DataDefinitionInterface::getDescription()
- 10 core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php \Drupal\Core\TypedData\DataDefinitionInterface::getDescription()
Returns a human readable description.
Descriptions are usually used on user interfaces where the data is edited or displayed.
Return value
string|\Drupal\Core\StringTranslation\TranslatableMarkup|null The description. A string or an instance of TranslatableMarkup will be returned based on the way the description translation is handled. NULL if no description is available.
2 methods override DataDefinitionInterface::getDescription()
- DataDefinition::getDescription in core/
lib/ Drupal/ Core/ TypedData/ DataDefinition.php - Returns a human readable description.
- FieldConfigBase::getDescription in core/
lib/ Drupal/ Core/ Field/ FieldConfigBase.php - Returns a human readable description.
File
-
core/
lib/ Drupal/ Core/ TypedData/ DataDefinitionInterface.php, line 78
Class
- DataDefinitionInterface
- Interface for data definitions.
Namespace
Drupal\Core\TypedDataCode
public function getDescription();
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.