class 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

• \Drupal\Core\Render\Plugin\DisplayVariant\SimplePageVariant
• \Drupal\block\Plugin\DisplayVariant\BlockPageVariant

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements \Drupal\Component\Annotation\AnnotationInterface
  • class \Drupal\Core\Display\Annotation\DisplayVariant extends \Drupal\Component\Annotation\Plugin

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

File

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

Namespace

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 = '';

}