class PageDisplayVariant
Same name in this branch
- 10 core/lib/Drupal/Core/Display/Attribute/PageDisplayVariant.php \Drupal\Core\Display\Attribute\PageDisplayVariant
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Display/Annotation/PageDisplayVariant.php \Drupal\Core\Display\Annotation\PageDisplayVariant
- 8.9.x core/lib/Drupal/Core/Display/Annotation/PageDisplayVariant.php \Drupal\Core\Display\Annotation\PageDisplayVariant
- 11.x core/lib/Drupal/Core/Display/Annotation/PageDisplayVariant.php \Drupal\Core\Display\Annotation\PageDisplayVariant
- 11.x core/lib/Drupal/Core/Display/Attribute/PageDisplayVariant.php \Drupal\Core\Display\Attribute\PageDisplayVariant
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 extends \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\Core\Display\Annotation\DisplayVariant implements \Drupal\Component\Annotation\Plugin
- class \Drupal\Core\Display\Annotation\PageDisplayVariant implements \Drupal\Core\Display\Annotation\DisplayVariant
- class \Drupal\Core\Display\Annotation\DisplayVariant implements \Drupal\Component\Annotation\Plugin
Expanded class hierarchy of PageDisplayVariant
See also
\Drupal\Core\Display\VariantInterface
\Drupal\Core\Display\PageVariantInterface
\Drupal\Core\Display\VariantBase
\Drupal\Core\Display\VariantManager
Related topics
File
-
core/
lib/ Drupal/ Core/ Display/ Annotation/ PageDisplayVariant.php, line 22
Namespace
Drupal\Core\Display\AnnotationView source
class PageDisplayVariant extends DisplayVariant {
}Members
| Title Sort descending | 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 | 6 |
| Plugin::getClass | public | function | Gets the class of the annotated class. | Overrides AnnotationInterface::getClass | 1 |
| 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 | 1 |
| 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. | 3 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.