function hook_entity_view_alter

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_alter()
  2. 8.9.x core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_alter()
  3. 10 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_alter()
  4. 11.x core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_alter()

Alter the results of ENTITY_view().

This hook is called after the content has been assembled in a structured array and may be used for doing processing which requires that the complete entity content structure has been built.

If a module wishes to act on the rendered HTML of the entity rather than the structured content array, it may use this hook to add a #post_render callback. Alternatively, it could also implement hook_preprocess_ENTITY(). See drupal_render() and theme() for details.

Parameters

$build: A renderable array representing the entity content.

$type: The type of entity being rendered (i.e. node, user, comment).

See also

hook_entity_view()

hook_comment_view_alter()

hook_node_view_alter()

hook_taxonomy_term_view_alter()

hook_user_view_alter()

Related topics

File

modules/system/system.api.php, line 459

Code

function hook_entity_view_alter(&$build, $type) {
    if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) {
        // Change its weight.
        $build['an_additional_field']['#weight'] = -10;
        // Add a #post_render callback to act on the rendered HTML of the entity.
        $build['#post_render'][] = 'my_module_node_post_render';
    }
}

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