class DisplayVariant

Defines a display variant attribute 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.

Plugin namespace: Plugin\DisplayVariant

For working examples, see

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

Attributes

Hierarchy

• class \Drupal\Component\Plugin\Attribute\AttributeBase implements \Drupal\Component\Plugin\Attribute\AttributeInterface
  • class \Drupal\Component\Plugin\Attribute\Plugin extends \Drupal\Component\Plugin\Attribute\AttributeBase
    • class \Drupal\Core\Display\Attribute\DisplayVariant extends \Drupal\Component\Plugin\Attribute\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

File

core/lib/Drupal/Core/Display/Attribute/DisplayVariant.php, line 31

Namespace

class DisplayVariant extends Plugin {
  
  /**
   * Constructs a DisplayVariant plugin attribute object.
   *
   * @param string $id
   *   The plugin ID.
   * @param \Drupal\Core\StringTranslation\TranslatableMarkup $admin_label
   *   The administrative label.
   * @param class-string|null $deriver
   *   (optional) The deriver class.
   */
  public function __construct(public readonly string $id, public readonly TranslatableMarkup $admin_label, public readonly ?string $deriver = NULL) {
  }

}

Members