From 6d13ffa4869fc6a07f5d874a6c3a640349bfd719 Mon Sep 17 00:00:00 2001 From: Angie Byron Date: Wed, 8 Dec 2010 07:06:27 +0000 Subject: #977346 by jhodgdon, joachim: Fixed More detailed docs for entity_label --- includes/common.inc | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'includes') diff --git a/includes/common.inc b/includes/common.inc index 938fcab03..4d6dddf2e 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -7464,13 +7464,16 @@ function entity_uri($entity_type, $entity) { /** * Returns the label of an entity. * + * See the 'label callback' component of the hook_entity_info() return value + * for more information. + * * @param $entity_type - * The entity type; e.g. 'node' or 'user'. + * The entity type; e.g., 'node' or 'user'. * @param $entity - * The entity for which to generate a path. + * The entity for which to generate the label. * * @return - * A string with the entity label (e.g. node title), or FALSE if not found. + * The entity label, or FALSE if not found. */ function entity_label($entity_type, $entity) { $label = FALSE; -- cgit v1.2.3