class ViewsDisplayExtender

Same name in other branches
  1. 8.9.x core/modules/views/src/Annotation/ViewsDisplayExtender.php \Drupal\views\Annotation\ViewsDisplayExtender
  2. 10 core/modules/views/src/Attribute/ViewsDisplayExtender.php \Drupal\views\Attribute\ViewsDisplayExtender
  3. 10 core/modules/views/src/Annotation/ViewsDisplayExtender.php \Drupal\views\Annotation\ViewsDisplayExtender
  4. 11.x core/modules/views/src/Attribute/ViewsDisplayExtender.php \Drupal\views\Attribute\ViewsDisplayExtender
  5. 11.x core/modules/views/src/Annotation/ViewsDisplayExtender.php \Drupal\views\Annotation\ViewsDisplayExtender

Defines a Plugin annotation object for views display extender plugins.

Hierarchy

Expanded class hierarchy of ViewsDisplayExtender

See also

\Drupal\views\Plugin\views\display_extender\DisplayExtenderPluginBase

Related topics

Views display extender plugins
Plugins that offer additional display options across display types.
Annotations
Annotations for class discovery and metadata description.
4 classes are annotated with ViewsDisplayExtender
DefaultDisplayExtender in core/modules/views/src/Plugin/views/display_extender/DefaultDisplayExtender.php
Default display extender plugin; does nothing.
DisplayExtenderTest in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest.php
Defines a display extender test plugin.
DisplayExtenderTest2 in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest2.php
Defines another display extender test plugin.
DisplayExtenderTest3 in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest3.php
Defines the third display extender test plugin.

File

core/modules/views/src/Annotation/ViewsDisplayExtender.php, line 14

Namespace

Drupal\views\Annotation
View source 
class ViewsDisplayExtender extends ViewsPluginAnnotationBase {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The plugin title used in the views UI.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $title = '';
    
    /**
     * (optional) The short title used in the views UI.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $short_title = '';
    
    /**
     * A short help string; this is displayed in the views UI.
     *
     * @var \Drupal\Core\Annotation\Translation
     *
     * @ingroup plugin_translatable
     */
    public $help = '';
    
    /**
     * Whether or not the plugin is selectable in the UI.
     *
     * If it's set to TRUE, you can still use it via the API in config files.
     *
     * @var bool
     */
    public $no_ui;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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
ViewsDisplayExtender::$help public property A short help string; this is displayed in the views UI.
ViewsDisplayExtender::$id public property The plugin ID.
ViewsDisplayExtender::$no_ui public property Whether or not the plugin is selectable in the UI.
ViewsDisplayExtender::$short_title public property (optional) The short title used in the views UI.
ViewsDisplayExtender::$title public property The plugin title used in the views UI.
ViewsPluginAnnotationBase::$register_theme public property Whether or not to register a theme function automatically.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.