function FieldConfigInterface::setDescription

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/FieldConfigInterface.php \Drupal\Core\Field\FieldConfigInterface::setDescription()
  2. 10 core/lib/Drupal/Core/Field/FieldConfigInterface.php \Drupal\Core\Field\FieldConfigInterface::setDescription()
  3. 11.x core/lib/Drupal/Core/Field/FieldConfigInterface.php \Drupal\Core\Field\FieldConfigInterface::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

1 method overrides FieldConfigInterface::setDescription()
FieldConfigBase::setDescription in core/lib/Drupal/Core/Field/FieldConfigBase.php
Sets a human readable description.

File

core/lib/Drupal/Core/Field/FieldConfigInterface.php, line 40

Class

FieldConfigInterface
Defines an interface for configurable field definitions.

Namespace

Drupal\Core\Field

Code

public function setDescription($description);

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