class ViewsDisplayExtender

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

Defines a Plugin attribute 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.
4 files declare their use of ViewsDisplayExtender
DefaultDisplayExtender.php in core/modules/views/src/Plugin/views/display_extender/DefaultDisplayExtender.php
DisplayExtenderTest.php in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest.php
DisplayExtenderTest2.php in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest2.php
DisplayExtenderTest3.php in core/modules/views/tests/modules/views_test_data/src/Plugin/views/display_extender/DisplayExtenderTest3.php

File

core/modules/views/src/Attribute/ViewsDisplayExtender.php, line 15

Namespace

Drupal\views\Attribute
View source 
class ViewsDisplayExtender extends Plugin {
    
    /**
     * Constructs an ViewsDisplayExtender attribute.
     *
     * @param string $id
     *   The plugin ID.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $title
     *   The plugin title used in the views UI.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $short_title
     *   (optional) The short title used in the views UI.
     * @param \Drupal\Core\StringTranslation\TranslatableMarkup|null $help
     *   (optional) A short help string; this is displayed in the views UI.
     * @param bool $no_ui
     *   (optional) Whether the plugin should be not selectable in the UI.
     *   If set to TRUE, you can still use it via the API in config files.
     *   Defaults to FALSE.
     * @param class-string|null $deriver
     *   (optional) The deriver class.
     */
    public function __construct(string $id, ?TranslatableMarkup $title = NULL, ?TranslatableMarkup $short_title = NULL, ?TranslatableMarkup $help = NULL, bool $no_ui = FALSE, ?string $deriver = NULL) {
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
AttributeBase::$class protected property The class used for this attribute class.
AttributeBase::$provider protected property The provider of the attribute class.
AttributeBase::get public function Gets the value of an attribute. Overrides AttributeInterface::get 6
AttributeBase::getClass public function Gets the class of the attribute class. Overrides AttributeInterface::getClass 1
AttributeBase::getId public function Gets the unique ID for this attribute class. Overrides AttributeInterface::getId
AttributeBase::getProvider public function Gets the name of the provider of the attribute class. Overrides AttributeInterface::getProvider
AttributeBase::setClass public function Sets the class of the attributed class. Overrides AttributeInterface::setClass 1
AttributeBase::setProvider public function Sets the name of the provider of the attribute class. Overrides AttributeInterface::setProvider
ViewsDisplayExtender::__construct public function Constructs an ViewsDisplayExtender attribute. Overrides Plugin::__construct

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