function FieldStorageDefinitionInterface::getDescription

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php \Drupal\Core\Field\FieldStorageDefinitionInterface::getDescription()
  2. 8.9.x core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php \Drupal\Core\Field\FieldStorageDefinitionInterface::getDescription()
  3. 11.x core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php \Drupal\Core\Field\FieldStorageDefinitionInterface::getDescription()

Returns the human-readable description for the field.

This is displayed in addition to the label in places where additional descriptive information is helpful. For example, as help text below the form element in entity edit forms.

Return value

string|null The field description, or NULL if no description is available.

1 method overrides FieldStorageDefinitionInterface::getDescription()
FieldStorageConfig::getDescription in core/modules/field/src/Entity/FieldStorageConfig.php
Returns the human-readable description for the field.

File

core/lib/Drupal/Core/Field/FieldStorageDefinitionInterface.php, line 129

Class

FieldStorageDefinitionInterface
Defines an interface for entity field storage definitions.

Namespace

Drupal\Core\Field

Code

public function getDescription();

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.