function FieldTypeCategory::getDescription

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Field/FieldTypeCategory.php \Drupal\Core\Field\FieldTypeCategory::getDescription()
  2. main core/lib/Drupal/Core/Field/FieldTypeCategory.php \Drupal\Core\Field\FieldTypeCategory::getDescription()

Returns the field group description.

Return value

string|\Stringable The category description.

Overrides FieldTypeCategoryInterface::getDescription

File

core/lib/Drupal/Core/Field/FieldTypeCategory.php, line 24

Class

FieldTypeCategory
Default object used for field_type_categories plugins.

Namespace

Drupal\Core\Field

Code

public function getDescription() : string|\Stringable {
  return $this->pluginDefinition['description'];
}

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