function entity_label

Returns the label of an entity.

See the 'label callback' component of the hook_entity_info() return value for more information.

Parameters

$entity_type: The entity type; e.g., 'node' or 'user'.

$entity: The entity for which to generate the label.

Return value

The entity label, or FALSE if not found.

1 call to entity_label()
EntityPropertiesTestCase::testEntityLabel in modules/field/tests/field.test
Tests label key and label callback of an entity.
1 string reference to 'entity_label'
taxonomy_menu in modules/taxonomy/taxonomy.module
Implements hook_menu().

File

includes/common.inc, line 8372

Code

function entity_label($entity_type, $entity) {
    $label = FALSE;
    $info = entity_get_info($entity_type);
    if (isset($info['label callback']) && function_exists($info['label callback'])) {
        $label = $info['label callback']($entity, $entity_type);
    }
    elseif (!empty($info['entity keys']['label']) && isset($entity->{$info['entity keys']['label']})) {
        $label = $entity->{$info['entity keys']['label']};
    }
    return $label;
}

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