Same name in other branches

1. 8.9.x core/lib/Drupal/Core/Entity/entity.api.php \hook_ENTITY_TYPE_view()
2. 10 core/lib/Drupal/Core/Entity/entity.api.php \hook_ENTITY_TYPE_view()
3. 11.x core/lib/Drupal/Core/Entity/entity.api.php \hook_ENTITY_TYPE_view()

Act on entities of a particular type being assembled before rendering.

Parameters

&$build: A renderable array representing the entity content. The module may add elements to $build prior to rendering. The structure of $build is a renderable array as expected by \Drupal\Core\Render\RendererInterface::render().

\Drupal\Core\Entity\EntityInterface $entity: The entity object.

\Drupal\Core\Entity\Display\EntityViewDisplayInterface $display: The entity view display holding the display options configured for the entity components.

$view_mode: The view mode the entity is rendered in.

See also

hook_ENTITY_TYPE_view_alter()

hook_entity_view()

Related topics

2 functions implement hook_ENTITY_TYPE_view()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

entity_test_entity_prepare_view in core/modules/system/tests/modules/entity_test/entity_test.module

Implements hook_entity_prepare_view().

rdf_entity_prepare_view in core/modules/rdf/rdf.module

Implements hook_entity_prepare_view().

File

core/lib/Drupal/Core/Entity/entity.api.php, line 1558

Code

function hook_ENTITY_TYPE_view(array &$build, \Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode) {
    // Only do the extra work if the component is configured to be displayed.
    // This assumes a 'mymodule_addition' extra field has been defined for the
    // entity bundle in hook_entity_extra_field_info().
    if ($display->getComponent('mymodule_addition')) {
        $build['mymodule_addition'] = [
            '#markup' => mymodule_addition($entity),
            '#theme' => 'mymodule_my_additional_field',
        ];
    }
}

---