diff options
| author | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-12-08 07:06:27 +0000 |
|---|---|---|
| committer | Angie Byron <webchick@24967.no-reply.drupal.org> | 2010-12-08 07:06:27 +0000 |
| commit | 6d13ffa4869fc6a07f5d874a6c3a640349bfd719 (patch) | |
| tree | a79d6c2849e156df49d5d6acd5a886640b5bfc73 /includes | |
| parent | 1d9e77a513d02d0922af8d207edf44a7acff08cc (diff) | |
| download | brdo-6d13ffa4869fc6a07f5d874a6c3a640349bfd719.tar.gz brdo-6d13ffa4869fc6a07f5d874a6c3a640349bfd719.tar.bz2 | |
#977346 by jhodgdon, joachim: Fixed More detailed docs for entity_label
Diffstat (limited to 'includes')
| -rw-r--r-- | includes/common.inc | 9 |
1 files changed, 6 insertions, 3 deletions
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; |