class PageDisplayVariant in Drupal 9

Defines a page display variant annotation object.

Page display variants are a specific type of display variant, intended to render entire pages. They must render the crucial parts of a page, which are:

• the title
• the main content
• any messages (#type => status_messages)

Hierarchy

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

See also

\Drupal\Core\Display\VariantInterface

\Drupal\Core\Display\PageVariantInterface

\Drupal\Core\Display\VariantBase

\Drupal\Core\Display\VariantManager

Plugin API

Related topics

Annotations

Annotations for class discovery and metadata description.

2 classes are annotated with PageDisplayVariant

BlockPageVariant in core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php

Provides a page display variant that decorates the main content with blocks.

SimplePageVariant in core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php

Provides a page display variant that simply renders the main content.

File

core/lib/Drupal/Core/Display/Annotation/PageDisplayVariant.php, line 22

Namespace

Drupal\Core\Display\Annotation

class PageDisplayVariant extends DisplayVariant {

}

Members

Name	Modifiers	Type	Description	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