function hook_entity_view in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view()
Act on entities being assembled before rendering.
Parameters
&$build: A renderable array representing the entity content.
\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.
The module may add elements to $build prior to rendering. The structure of $build is a renderable array as expected by drupal_render().
See also
Related topics
1 function implements hook_entity_view()
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- comment_entity_view in core/
modules/ comment/ comment.module - Implements hook_entity_view().
1 invocation of hook_entity_view()
- EntityViewBuilder::buildMultiple in core/
lib/ Drupal/ Core/ Entity/ EntityViewBuilder.php - Builds multiple entities' views; augments entity defaults.
File
- core/
lib/ Drupal/ Core/ Entity/ entity.api.php, line 1287 - Hooks and documentation related to entities.
Code
function hook_entity_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'] = array(
'#markup' => mymodule_addition($entity),
'#theme' => 'mymodule_my_additional_field',
);
}
}