public function 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.

File

core/lib/Drupal/Core/TypedData/DataDefinitionInterface.php, line 78

Class

DataDefinitionInterface

Interface for data definitions.

Namespace

Code

public function getDescription();