You are here

public function FieldConfigBase::setDescription in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::setDescription()
  2. 9 core/lib/Drupal/Core/Field/FieldConfigBase.php \Drupal\Core\Field\FieldConfigBase::setDescription()

Sets a human readable description.

Descriptions are usually used on user interfaces where the data is edited or displayed.

Parameters

string $description: The description for this field.

Return value

$this

Overrides FieldConfigInterface::setDescription

File

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

Class

FieldConfigBase
Base class for configurable field definitions.

Namespace

Drupal\Core\Field

Code

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