public function FieldConfigBase::getDescription

public FieldConfigBase::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/Field/FieldConfigBase.php, line 304

Class

FieldConfigBase
Base class for configurable field definitions.

Namespace

Drupal\Core\Field

Code

public function getDescription() {
  return $this->description;
}

© 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!Field!FieldConfigBase.php/function/FieldConfigBase::getDescription/8.1.x