class DisplayVariant

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Display/Attribute/DisplayVariant.php \Drupal\Core\Display\Attribute\DisplayVariant
  2. 11.x core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php \Drupal\Core\Display\Annotation\DisplayVariant
  3. 10 core/lib/Drupal/Core/Display/Attribute/DisplayVariant.php \Drupal\Core\Display\Attribute\DisplayVariant
  4. 10 core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php \Drupal\Core\Display\Annotation\DisplayVariant
  5. 8.9.x core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php \Drupal\Core\Display\Annotation\DisplayVariant

Defines a display variant annotation object.

Display variants are used to dictate the output of a given Display, which can be used to control the output of many parts of Drupal.

Variants are usually chosen by some selection criteria, and are instantiated directly. Each variant must define its own approach to rendering, and can either load its own data or be injected with data from another Display object.

@todo: Revise description when/if Displays are added to core: https://www.drupal.org/node/2292733

Plugin namespace: Plugin\DisplayVariant

For working examples, see

Hierarchy

Expanded class hierarchy of DisplayVariant

See also

\Drupal\Core\Display\VariantInterface

\Drupal\Core\Display\VariantBase

\Drupal\Core\Display\VariantManager

\Drupal\Core\Display\PageVariantInterface

Plugin API

Related topics

1 class is annotated with DisplayVariant
TestDisplayVariant in core/modules/system/tests/modules/display_variant_test/src/Plugin/DisplayVariant/TestDisplayVariant.php
Provides a display variant that requires configuration.

File

core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php, line 35

Namespace

Drupal\Core\Display\Annotation
View source
class DisplayVariant extends Plugin {
  
  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;
  
  /**
   * The administrative label.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $admin_label = '';

}

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