function EntityBase::label

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/EntityBase.php \Drupal\Core\Entity\EntityBase::label()
  2. 10 core/lib/Drupal/Core/Entity/EntityBase.php \Drupal\Core\Entity\EntityBase::label()
  3. 11.x core/lib/Drupal/Core/Entity/EntityBase.php \Drupal\Core\Entity\EntityBase::label()

Gets the label of the entity.

Return value

string|\Drupal\Core\StringTranslation\TranslatableMarkup|null The label of the entity, or NULL if there is no label defined.

Overrides EntityInterface::label

2 calls to EntityBase::label()
EntityBase::toLink in core/lib/Drupal/Core/Entity/EntityBase.php
Generates the HTML for a link to this entity.
FieldConfigBase::getLabel in core/lib/Drupal/Core/Field/FieldConfigBase.php
Returns a human readable label.
1 method overrides EntityBase::label()
ContentEntityBase::label in core/lib/Drupal/Core/Entity/ContentEntityBase.php
Gets the label of the entity.

File

core/lib/Drupal/Core/Entity/EntityBase.php, line 150

Class

EntityBase
Defines a base entity class.

Namespace

Drupal\Core\Entity

Code

public function label() {
  if (($label_key = $this->getEntityType()
    ->getKey('label')) && isset($this->{$label_key})) {
    return $this->{$label_key};
  }
}

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