class DisplayVariant

Same name in other branches
  1. 9 core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php \Drupal\Core\Display\Annotation\DisplayVariant
  2. 10 core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php \Drupal\Core\Display\Annotation\DisplayVariant
  3. 11.x core/lib/Drupal/Core/Display/Annotation/DisplayVariant.php \Drupal\Core\Display\Annotation\DisplayVariant
  4. 11.x core/lib/Drupal/Core/Display/Attribute/DisplayVariant.php \Drupal\Core\Display\Attribute\DisplayVariant
  5. 10 core/lib/Drupal/Core/Display/Attribute/DisplayVariant.php \Drupal\Core\Display\Attribute\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

Annotations
Annotations for class discovery and metadata description.
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 = '';

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DisplayVariant::$admin_label public property The administrative label.
DisplayVariant::$id public property The plugin ID.
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider 1
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2

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