function hook_entity_view_display_alter
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_display_alter()
- 8.9.x core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_display_alter()
- 10 core/lib/Drupal/Core/Entity/entity.api.php \hook_entity_view_display_alter()
Alter the settings used for displaying an entity.
Parameters
\Drupal\Core\Entity\Display\EntityViewDisplayInterface $display: The entity view display that will be used to display the entity components.
array $context: An associative array containing:
- entity_type: The entity type, e.g., 'node' or 'user'.
- bundle: The bundle, e.g., 'page' or 'article'.
- view_mode: The view mode, e.g., 'full', 'teaser', etc.
Related topics
File
-
core/
lib/ Drupal/ Core/ Entity/ entity.api.php, line 1781
Code
function hook_entity_view_display_alter(\Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, array $context) {
// Leave field labels out of the search index.
if ($context['entity_type'] == 'node' && $context['view_mode'] == 'search_index') {
foreach ($display->getComponents() as $name => $options) {
if (isset($options['label'])) {
$options['label'] = 'hidden';
$display->setComponent($name, $options);
}
}
}
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.