W3cubDocs

/Drupal 8

public function DataDefinition::getDescription

public 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 93

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;
}

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!TypedData!DataDefinition.php/function/DataDefinition::getDescription/8.1.x