FieldConfigBase::$description

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::description
  2. 8.9.x core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::description
  3. 11.x core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::description

The field description.

A human-readable description for the field when used with this bundle. For example, the description will be the help text of Form API elements for this field in entity edit forms.

Type: string

File

core/lib/Drupal/Core/Field/FieldConfigBase.php, line 86

Class

FieldConfigBase
Base class for configurable field definitions.

Namespace

Drupal\Core\Field

Code

protected $description = '';

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