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

Overrides DataDefinitionInterface::getDescription

File

core/lib/Drupal/Core/TypedData/DataDefinition.php, line 95

Class

DataDefinition

A typed data definition class for defining data based on defined data types.

Namespace

Code

public function getDescription() {
  return $this->definition['description'] ?? NULL;
}