Skip navigation


7 entity_uri($entity_type, $entity)

Returns the uri elements of an entity.


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

$entity: The entity for which to generate a path.

Return value

An array containing the 'path' and 'options' keys used to build the uri of the entity, and matching the signature of url(). NULL if the entity has no uri of its own.

12 calls to entity_uri()


drupal/includes/, line 7562
Common functions that many Drupal modules will need to reference.


function entity_uri($entity_type, $entity) {
  // This check enables the URI of an entity to be easily overridden from what
  // the callback for the entity type or bundle would return, and it helps
  // minimize performance overhead when entity_uri() is called multiple times
  // for the same entity.
  if (!isset($entity->uri)) {
    $info = entity_get_info($entity_type);
    list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);

    // A bundle-specific callback takes precedence over the generic one for the
    // entity type.
    if (isset($info['bundles'][$bundle]['uri callback'])) {
      $uri_callback = $info['bundles'][$bundle]['uri callback'];
    elseif (isset($info['uri callback'])) {
      $uri_callback = $info['uri callback'];
    else {
      $uri_callback = NULL;

    // Invoke the callback to get the URI. If there is no callback, set the
    // entity's 'uri' property to FALSE to indicate that it is known to not have
    // a URI.
    if (isset($uri_callback) && function_exists($uri_callback)) {
      $entity->uri = $uri_callback($entity);
      if (!isset($entity->uri['options'])) {
        $entity->uri['options'] = array();
      // Pass the entity data to url() so that alter functions do not need to
      // lookup this entity again.
      $entity->uri['options']['entity_type'] = $entity_type;
      $entity->uri['options']['entity'] = $entity;
    else {
      $entity->uri = FALSE;
  return $entity->uri ? $entity->uri : NULL;