You are here

public function FieldStorageConfig::getDescription in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/field/src/Entity/FieldStorageConfig.php \Drupal\field\Entity\FieldStorageConfig::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.

Overrides FieldStorageDefinitionInterface::getDescription

File

core/modules/field/src/Entity/FieldStorageConfig.php, line 624

Class

FieldStorageConfig
Defines the Field storage configuration entity.

Namespace

Drupal\field\Entity

Code

public function getDescription() {
  return NULL;
}