public function DataDefinition::getDescription in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/TypedData/DataDefinition.php \Drupal\Core\TypedData\DataDefinition::getDescription()
2. 10 core/lib/Drupal/Core/TypedData/DataDefinition.php \Drupal\Core\TypedData\DataDefinition::getDescription()

Returns a human readable description.

Descriptions are usually used on user interfaces where the data is edited or displayed.

Return value

string|null The description, or 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

Drupal\Core\TypedData

Code

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