You are here

Home » API reference » Entity API 7 » entity.inc » Entity

public function Entity::label in Entity API 7

Returns the label of the entity.

Modules may alter the label by specifying another 'label callback' using hook_entity_info_alter().

Overrides EntityInterface::label

See also

entity_label()

File

includes/entity.inc, line 276
Provides a base class for entities.

Class

Entity
A common class for entities.

Code

public function label() {

  // If the default label flag is enabled, this is being invoked recursively.
  // In this case we need to use our default label callback directly. This may
  // happen if a module provides a label callback implementation different
  // from ours, but then invokes Entity::label() or entity_class_label() from
  // there.
  if ($this->defaultLabel || isset($this->entityInfo['label callback']) && $this->entityInfo['label callback'] == 'entity_class_label') {
    return $this
      ->defaultLabel();
  }
  $this->defaultLabel = TRUE;
  $label = entity_label($this->entityType, $this);
  $this->defaultLabel = FALSE;
  return $label;
}