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

5 calls to EntityBase::label()
ConfigurableLanguage::getName in core/modules/language/src/Entity/ConfigurableLanguage.php
Gets the name of the language.
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.
FieldStorageConfig::getLabel in core/modules/field/src/Entity/FieldStorageConfig.php
Returns the human-readable label for the field.
FilterFormat::preSave in core/modules/filter/src/Entity/FilterFormat.php
Acts on an entity before the presave hook is invoked.
6 methods override EntityBase::label()
Block::label in core/modules/block/src/Entity/Block.php
Gets the label of the entity.
ContentEntityBase::label in core/lib/Drupal/Core/Entity/ContentEntityBase.php
Gets the label of the entity.
Editor::label in core/modules/editor/src/Entity/Editor.php
Gets the label of the entity.
LayoutBuilderEntityViewDisplay::label in core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php
@todo Move this upstream in https://www.drupal.org/node/2939931.
TestSearchPage::label in core/modules/search/tests/src/Unit/SearchPageRepositoryTest.php
Gets the label of the entity.

... See full list

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.