class 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

• class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
  • class \Drupal\Core\Config\Entity\ConfigEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
    • class \Drupal\Core\Entity\EntityDisplayModeBase extends \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Entity\EntityDisplayModeInterface
      • class \Drupal\Core\Entity\Entity\EntityViewMode extends \Drupal\Core\Entity\EntityDisplayModeBase implements \Drupal\Core\Entity\EntityViewModeInterface

Expanded class hierarchy of EntityViewMode

See also

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

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

hook_entity_view_mode_info_alter()

File

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

Namespace

class EntityViewMode extends EntityDisplayModeBase implements EntityViewModeInterface {

}