W3cubDocs

/Drupal 8

class 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

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.

File

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

Namespace

Drupal\Core\Display\Annotation

Members

Name Modifiers Type Description
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.
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get
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
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.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Display!Annotation!PageDisplayVariant.php/class/PageDisplayVariant/8.1.x