Login Register

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

Links:

https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21TypedData%21DataDefinition.php/function/DataDefinition%3A%3AgetDescription/8.2.x

doc_Drupal

2025-01-10 15:47:30

Comments

Leave a Comment

Please login to continue.

Popular Articles

DataDefinition A typed data definition class for defining data based on defined data types. Hierarchy class \Drupal\Core\TypedData\DataDefinition implements \ArrayA

DataDefinition::getClass public DataDefinition::getClass() Returns the class used for creating the typed data object. If not specified, the default class of the data type wil

DataDefinition::getLabel public DataDefinition::getLabel() Returns a human readable label. Return value string|\Drupal\Core\StringTranslation\TranslatableMarkup The label. A

DataDefinition::isList public DataDefinition::isList() Returns whether the data is multi-valued, i.e. a list of data items. This is equivalent to checking whether the data

DataDefinition::setRequired public DataDefinition::setRequired($required) Sets whether the data is required. Parameters bool $required: Whether the data is required. Return val