You are here

Home » API reference » Drupal 7 » system.api.php

function hook_entity_prepare_view in Drupal 7

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_prepare_view()
  2. 9 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_prepare_view()

Act on entities as they are being prepared for view.

Allows you to operate on multiple entities as they are being prepared for view. Only use this if attaching the data during the entity_load() phase is not appropriate, for example when attaching other 'entity' style objects.

Parameters

$entities: The entities keyed by entity ID.

$type: The type of entities being loaded (i.e. node, user, comment).

$langcode: The language to display the entity in.

Related topics

Hooks
Allow modules to interact with the Drupal core.
1 invocation of hook_entity_prepare_view()
entity_prepare_view in includes/common.inc
Invoke hook_entity_prepare_view().

File

modules/system/system.api.php, line 547
Hooks provided by Drupal core and the System module.

Code

function hook_entity_prepare_view($entities, $type, $langcode) {

  // Load a specific node into the user object for later theming.
  if ($type == 'user') {
    $nodes = mymodule_get_user_nodes(array_keys($entities));
    foreach ($entities as $uid => $entity) {
      $entity->user_node = $nodes[$uid];
    }
  }
}