You are here

Home » API reference » Drupal 9 » entity.api.php

function hook_entity_view_mode_alter in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_mode_alter()
  2. 7 modules/system/system.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.

\Drupal\Core\Entity\EntityInterface $entity: The entity that is being viewed.

Related topics

Entity CRUD, editing, and view hooks
Hooks used in various entity operations.
Hooks
Define functions that alter the behavior of Drupal core.
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 core/modules/node/tests/modules/node_test/node_test.module
Implements hook_entity_view_mode_alter().

File

core/lib/Drupal/Core/Entity/entity.api.php, line 1654
Hooks and documentation related to entities.

Code

function hook_entity_view_mode_alter(&$view_mode, \Drupal\Core\Entity\EntityInterface $entity) {

  // For nodes, change the view mode when it is teaser.
  if ($entity
    ->getEntityTypeId() == 'node' && $view_mode == 'teaser') {
    $view_mode = 'my_custom_view_mode';
  }
}