function hook_entity_view_mode_alter
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_mode_alter()
- 8.9.x core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_mode_alter()
- 10 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_mode_alter()
- 11.x core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_mode_alter()
Change the view mode of an entity that is being displayed.
Parameters
string $view_mode: The view_mode that is to be used to display the entity.
array $context: Array with contextual information, including:
- entity_type: The type of the entity that is being viewed.
- entity: The entity object.
- langcode: The langcode the entity is being viewed in.
Related topics
1 function implements hook_entity_view_mode_alter()
Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.
- node_test_entity_view_mode_alter in modules/
node/ tests/ node_test.module - Implements hook_entity_view_mode_alter().
File
-
modules/
system/ system.api.php, line 480
Code
function hook_entity_view_mode_alter(&$view_mode, $context) {
// For nodes, change the view mode when it is teaser.
if ($context['entity_type'] == 'node' && $view_mode == 'teaser') {
$view_mode = 'my_custom_view_mode';
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.