class EntityViewMode

Same name in this branch
  1. 11.x core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php \Drupal\migrate\Plugin\migrate\destination\EntityViewMode
Same name in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php \Drupal\migrate\Plugin\migrate\destination\EntityViewMode
  2. 9 core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php \Drupal\Core\Entity\Entity\EntityViewMode
  3. 8.9.x core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php \Drupal\migrate\Plugin\migrate\destination\EntityViewMode
  4. 8.9.x core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php \Drupal\Core\Entity\Entity\EntityViewMode
  5. 10 core/modules/migrate/src/Plugin/migrate/destination/EntityViewMode.php \Drupal\migrate\Plugin\migrate\destination\EntityViewMode
  6. 10 core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php \Drupal\Core\Entity\Entity\EntityViewMode

Defines the entity view mode configuration entity class.

View modes let entities be displayed differently depending on the context. For instance, a node can be displayed differently on its own page ('full' mode), on the home page or taxonomy listings ('teaser' mode), or in an RSS feed ('rss' mode). Modules taking part in the display of the entity (notably the Field API) can adjust their behavior depending on the requested view mode. An additional 'default' view mode is available for all entity types. This view mode is not intended for actual entity display, but holds default display settings. For each available view mode, administrators can configure whether it should use its own set of field display settings, or just replicate the settings of the 'default' view mode, thus reducing the amount of display configurations to keep track of.

Plugin annotation


@ConfigEntityType(
  id = "entity_view_mode",
  label = @Translation("View mode"),
  entity_keys = {
    "id" = "id",
    "label" = "label",
    "description" = "description",
  },
  config_export = {
    "id",
    "label",
    "description",
    "targetEntityType",
    "cache",
  },
  constraints = {
    "ImmutableProperties" = {"id", "targetEntityType"},
  }
)

Hierarchy

Expanded class hierarchy of EntityViewMode

See also

\Drupal\Core\Entity\EntityDisplayRepositoryInterface::getAllViewModes()

\Drupal\Core\Entity\EntityDisplayRepositoryInterface::getViewModes()

hook_entity_view_mode_info_alter()

28 files declare their use of EntityViewMode
CKEditor5AllowedTagsTest.php in core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php
comment.module in core/modules/comment/comment.module
Enables users to comment on published content.
CommentIntegrationTest.php in core/modules/comment/tests/src/Kernel/CommentIntegrationTest.php
CommentInterfaceTest.php in core/modules/comment/tests/src/Functional/CommentInterfaceTest.php
DisplayApiTest.php in core/modules/field/tests/src/Kernel/DisplayApiTest.php

... See full list

File

core/lib/Drupal/Core/Entity/Entity/EntityViewMode.php, line 47

Namespace

Drupal\Core\Entity\Entity
View source
class EntityViewMode extends EntityDisplayModeBase implements EntityViewModeInterface {

}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.