class PageDisplayVariant
Same name in other branches
- 9 core/lib/Drupal/Core/Display/Annotation/PageDisplayVariant.php \Drupal\Core\Display\Annotation\PageDisplayVariant
- 10 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
- 10 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 implements \Drupal\Component\Annotation\AnnotationInterface
- class \Drupal\Core\Display\Annotation\DisplayVariant extends \Drupal\Component\Annotation\Plugin
- class \Drupal\Core\Display\Annotation\PageDisplayVariant extends \Drupal\Core\Display\Annotation\DisplayVariant
- class \Drupal\Core\Display\Annotation\DisplayVariant extends \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
3 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.
- PlaceBlockPageVariant in core/
modules/ block_place/ src/ Plugin/ DisplayVariant/ PlaceBlockPageVariant.php - Allows blocks to be placed directly within a region.
- 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\AnnotationView source
class PageDisplayVariant extends DisplayVariant {
}Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.