class Block

Same name in this branch
  1. 10 core/modules/block/src/Entity/Block.php \Drupal\block\Entity\Block
  2. 10 core/modules/block/src/Plugin/migrate/source/Block.php \Drupal\block\Plugin\migrate\source\Block
  3. 10 core/lib/Drupal/Core/Block/Attribute/Block.php \Drupal\Core\Block\Attribute\Block
  4. 10 core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block
Same name in other branches
  1. 9 core/modules/views/src/Plugin/views/display/Block.php \Drupal\views\Plugin\views\display\Block
  2. 9 core/modules/block/src/Entity/Block.php \Drupal\block\Entity\Block
  3. 9 core/modules/block/src/Plugin/migrate/source/Block.php \Drupal\block\Plugin\migrate\source\Block
  4. 9 core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block
  5. 8.9.x core/modules/views/src/Plugin/views/display/Block.php \Drupal\views\Plugin\views\display\Block
  6. 8.9.x core/modules/block/src/Entity/Block.php \Drupal\block\Entity\Block
  7. 8.9.x core/modules/block/src/Plugin/migrate/source/Block.php \Drupal\block\Plugin\migrate\source\Block
  8. 8.9.x core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block
  9. 11.x core/modules/views/src/Plugin/views/display/Block.php \Drupal\views\Plugin\views\display\Block
  10. 11.x core/modules/block/src/Entity/Block.php \Drupal\block\Entity\Block
  11. 11.x core/modules/block/src/Plugin/migrate/source/Block.php \Drupal\block\Plugin\migrate\source\Block
  12. 11.x core/lib/Drupal/Core/Block/Attribute/Block.php \Drupal\Core\Block\Attribute\Block
  13. 11.x core/lib/Drupal/Core/Block/Annotation/Block.php \Drupal\Core\Block\Annotation\Block

The plugin that handles a block.

Hierarchy

Expanded class hierarchy of Block

See also

\Drupal\views\Plugin\Block\ViewsBlock

\Drupal\views\Plugin\Derivative\ViewsBlock

Related topics

207 string references to 'Block'
AjaxFormCacheTest::testBlockForms in core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormCacheTest.php
Tests AJAX forms in blocks.
AjaxFormCacheTest::testQueryString in core/tests/Drupal/FunctionalJavascriptTests/Ajax/AjaxFormCacheTest.php
Tests AJAX forms on pages with a query string.
AreaDisplayLinkTest::setUp in core/modules/views/tests/src/Kernel/Handler/AreaDisplayLinkTest.php
BigPipeInterfacePreviewThemeSuggestionsTest::setUp in core/modules/big_pipe/tests/src/Kernel/BigPipeInterfacePreviewThemeSuggestionsTest.php
big_pipe_theme_suggestions_big_pipe_interface_preview in core/modules/big_pipe/big_pipe.module
Implements hook_theme_suggestions_HOOK().

... See full list

File

core/modules/views/src/Plugin/views/display/Block.php, line 24

Namespace

Drupal\views\Plugin\views\display
View source
class Block extends DisplayPluginBase {
    
    /**
     * Whether the display allows attachments.
     *
     * @var bool
     */
    protected $usesAttachments = TRUE;
    
    /**
     * The entity type manager.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The block manager.
     *
     * @var \Drupal\Core\Block\BlockManagerInterface
     */
    protected $blockManager;
    
    /**
     * Constructs a new Block instance.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin_id for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager.
     * @param \Drupal\Core\Block\BlockManagerInterface $block_manager
     *   The block manager.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, BlockManagerInterface $block_manager) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->entityTypeManager = $entity_type_manager;
        $this->blockManager = $block_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager'), $container->get('plugin.manager.block'));
    }
    
    /**
     * {@inheritdoc}
     */
    protected function defineOptions() {
        $options = parent::defineOptions();
        $options['block_description'] = [
            'default' => '',
        ];
        $options['block_category'] = [
            'default' => $this->t('Lists (Views)'),
        ];
        $options['block_hide_empty'] = [
            'default' => FALSE,
        ];
        $options['allow'] = [
            'contains' => [
                'items_per_page' => [
                    'default' => 'items_per_page',
                ],
            ],
        ];
        return $options;
    }
    
    /**
     * Returns plugin-specific settings for the block.
     *
     * @param array $settings
     *   The settings of the block.
     *
     * @return array
     *   An array of block-specific settings to override the defaults provided in
     *   \Drupal\views\Plugin\Block\ViewsBlock::defaultConfiguration().
     *
     * @see \Drupal\views\Plugin\Block\ViewsBlock::defaultConfiguration()
     */
    public function blockSettings(array $settings) {
        $settings['items_per_page'] = 'none';
        return $settings;
    }
    
    /**
     * The display block handler returns the structure necessary for a block.
     */
    public function execute() {
        // Prior to this being called, the $view should already be set to this
        // display, and arguments should be set on the view.
        $element = $this->view
            ->render();
        if ($this->outputIsEmpty() && $this->getOption('block_hide_empty') && empty($this->view->style_plugin->definition['even empty'])) {
            return [];
        }
        else {
            return $element;
        }
    }
    
    /**
     * Provide the summary for page options in the views UI.
     *
     * This output is returned as an array.
     */
    public function optionsSummary(&$categories, &$options) {
        parent::optionsSummary($categories, $options);
        $categories['block'] = [
            'title' => $this->t('Block settings'),
            'column' => 'second',
            'build' => [
                '#weight' => -10,
            ],
        ];
        $block_description = strip_tags($this->getOption('block_description'));
        if (empty($block_description)) {
            $block_description = $this->t('None');
        }
        $block_category = $this->getOption('block_category');
        $options['block_description'] = [
            'category' => 'block',
            'title' => $this->t('Block name'),
            'value' => Unicode::truncate($block_description, 24, FALSE, TRUE),
        ];
        $options['block_category'] = [
            'category' => 'block',
            'title' => $this->t('Block category'),
            'value' => Unicode::truncate($block_category, 24, FALSE, TRUE),
        ];
        $filtered_allow = array_filter($this->getOption('allow'));
        $options['allow'] = [
            'category' => 'block',
            'title' => $this->t('Allow settings'),
            'value' => empty($filtered_allow) ? $this->t('None') : $this->t('Items per page'),
        ];
        $options['block_hide_empty'] = [
            'category' => 'other',
            'title' => $this->t('Hide block if the view output is empty'),
            'value' => $this->getOption('block_hide_empty') ? $this->t('Yes') : $this->t('No'),
        ];
    }
    
    /**
     * Provide the default form for setting options.
     */
    public function buildOptionsForm(&$form, FormStateInterface $form_state) {
        parent::buildOptionsForm($form, $form_state);
        switch ($form_state->get('section')) {
            case 'block_description':
                $form['#title'] .= $this->t('Block admin description');
                $form['block_description'] = [
                    '#type' => 'textfield',
                    '#description' => $this->t('This will appear as the name of this block in administer >> structure >> blocks.'),
                    '#default_value' => $this->getOption('block_description'),
                ];
                break;
            case 'block_category':
                $form['#title'] .= $this->t('Block category');
                $form['block_category'] = [
                    '#type' => 'textfield',
                    '#autocomplete_route_name' => 'block.category_autocomplete',
                    '#description' => $this->t('The category this block will appear under on the <a href=":href">blocks placement page</a>.', [
                        ':href' => Url::fromRoute('block.admin_display')->toString(),
                    ]),
                    '#default_value' => $this->getOption('block_category'),
                ];
                break;
            case 'block_hide_empty':
                $form['#title'] .= $this->t('Block empty settings');
                $form['block_hide_empty'] = [
                    '#title' => $this->t('Hide block if no result/empty text'),
                    '#type' => 'checkbox',
                    '#description' => $this->t('Hide the block if there is no result and no empty text and no header/footer which is shown on empty result'),
                    '#default_value' => $this->getOption('block_hide_empty'),
                ];
                break;
            case 'exposed_form_options':
                $this->view
                    ->initHandlers();
                if (!$this->usesExposed() && parent::usesExposed()) {
                    $form['exposed_form_options']['warning'] = [
                        '#weight' => -10,
                        '#markup' => '<div class="messages messages--warning">' . $this->t('Exposed filters in block displays require "Use AJAX" to be set to work correctly.') . '</div>',
                    ];
                }
                break;
            case 'allow':
                $form['#title'] .= $this->t('Allow settings in the block configuration');
                $options = [
                    'items_per_page' => $this->t('Items per page'),
                ];
                $allow = array_keys(array_filter($this->getOption('allow')));
                $form['allow'] = [
                    '#type' => 'checkboxes',
                    '#default_value' => $allow,
                    '#options' => $options,
                ];
                break;
        }
    }
    
    /**
     * Perform any necessary changes to the form values prior to storage.
     *
     * There is no need for this function to actually store the data.
     */
    public function submitOptionsForm(&$form, FormStateInterface $form_state) {
        parent::submitOptionsForm($form, $form_state);
        $section = $form_state->get('section');
        switch ($section) {
            case 'block_description':
            case 'block_category':
            case 'allow':
            case 'block_hide_empty':
                $this->setOption($section, $form_state->getValue($section));
                break;
        }
    }
    
    /**
     * Adds the configuration form elements specific to this views block plugin.
     *
     * This method allows block instances to override the views items_per_page.
     *
     * @param \Drupal\views\Plugin\Block\ViewsBlock $block
     *   The ViewsBlock plugin.
     * @param array $form
     *   The form definition array for the block configuration form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     *
     * @return array
     *   The renderable form array representing the entire configuration form.
     *
     * @see \Drupal\views\Plugin\Block\ViewsBlock::blockForm()
     */
    public function blockForm(ViewsBlock $block, array &$form, FormStateInterface $form_state) {
        $allow_settings = array_filter($this->getOption('allow'));
        $block_configuration = $block->getConfiguration();
        foreach ($allow_settings as $type => $enabled) {
            if (empty($enabled)) {
                continue;
            }
            switch ($type) {
                case 'items_per_page':
                    $form['override']['items_per_page'] = [
                        '#type' => 'select',
                        '#title' => $this->t('Items per block'),
                        '#options' => [
                            'none' => $this->t('@count (default setting)', [
                                '@count' => $this->getPlugin('pager')
                                    ->getItemsPerPage(),
                            ]),
                            1 => 1,
                            2 => 2,
                            3 => 3,
                            4 => 4,
                            5 => 5,
                            6 => 6,
                            10 => 10,
                            12 => 12,
                            20 => 20,
                            24 => 24,
                            40 => 40,
                            48 => 48,
                        ],
                        '#default_value' => $block_configuration['items_per_page'],
                    ];
                    break;
            }
        }
        return $form;
    }
    
    /**
     * Handles form validation for the views block configuration form.
     *
     * @param \Drupal\views\Plugin\Block\ViewsBlock $block
     *   The ViewsBlock plugin.
     * @param array $form
     *   The form definition array for the block configuration form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     *
     * @see \Drupal\views\Plugin\Block\ViewsBlock::blockValidate()
     */
    public function blockValidate(ViewsBlock $block, array $form, FormStateInterface $form_state) {
    }
    
    /**
     * Handles form submission for the views block configuration form.
     *
     * @param \Drupal\views\Plugin\Block\ViewsBlock $block
     *   The ViewsBlock plugin.
     * @param array $form
     *   The form definition array for the full block configuration form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     *
     * @see \Drupal\views\Plugin\Block\ViewsBlock::blockSubmit()
     */
    public function blockSubmit(ViewsBlock $block, $form, FormStateInterface $form_state) {
        if ($items_per_page = $form_state->getValue([
            'override',
            'items_per_page',
        ])) {
            $block->setConfigurationValue('items_per_page', $items_per_page);
        }
        $form_state->unsetValue([
            'override',
            'items_per_page',
        ]);
    }
    
    /**
     * Allows to change the display settings right before executing the block.
     *
     * @param \Drupal\views\Plugin\Block\ViewsBlock $block
     *   The block plugin for views displays.
     */
    public function preBlockBuild(ViewsBlock $block) {
        $config = $block->getConfiguration();
        if ($config['items_per_page'] !== 'none') {
            $this->view
                ->setItemsPerPage($config['items_per_page']);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function usesExposedFormInBlock() {
        return TRUE;
    }
    
    /**
     * {@inheritdoc}
     */
    public function remove() {
        parent::remove();
        if ($this->entityTypeManager
            ->hasDefinition('block')) {
            $plugin_id = 'views_block:' . $this->view->storage
                ->id() . '-' . $this->display['id'];
            foreach ($this->entityTypeManager
                ->getStorage('block')
                ->loadByProperties([
                'plugin' => $plugin_id,
            ]) as $block) {
                $block->delete();
            }
        }
        if ($this->blockManager instanceof CachedDiscoveryInterface) {
            $this->blockManager
                ->clearCachedDefinitions();
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
Block::$blockManager protected property The block manager.
Block::$entityTypeManager protected property The entity type manager.
Block::$usesAttachments protected property Whether the display allows attachments. Overrides DisplayPluginBase::$usesAttachments
Block::blockForm public function Adds the configuration form elements specific to this views block plugin.
Block::blockSettings public function Returns plugin-specific settings for the block.
Block::blockSubmit public function Handles form submission for the views block configuration form.
Block::blockValidate public function Handles form validation for the views block configuration form.
Block::buildOptionsForm public function Provide the default form for setting options. Overrides DisplayPluginBase::buildOptionsForm
Block::create public static function Creates an instance of the plugin. Overrides PluginBase::create
Block::defineOptions protected function Information about options for all kinds of purposes will be held here. Overrides DisplayPluginBase::defineOptions
Block::execute public function The display block handler returns the structure necessary for a block. Overrides DisplayPluginBase::execute
Block::optionsSummary public function Provide the summary for page options in the views UI. Overrides DisplayPluginBase::optionsSummary
Block::preBlockBuild public function Allows to change the display settings right before executing the block.
Block::remove public function Reacts on deleting a display. Overrides DisplayPluginBase::remove
Block::submitOptionsForm public function Perform any necessary changes to the form values prior to storage. Overrides DisplayPluginBase::submitOptionsForm
Block::usesExposedFormInBlock public function Checks to see if the display can put the exposed form in a block. Overrides DisplayPluginBase::usesExposedFormInBlock
Block::__construct public function Constructs a new Block instance. Overrides DisplayPluginBase::__construct
DependencyTrait::$dependencies protected property The object&#039;s dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
DisplayPluginBase::$default_display public property
DisplayPluginBase::$display public property The display information coming directly from the view entity.
DisplayPluginBase::$extenders protected property Stores all available display extenders.
DisplayPluginBase::$handlers public property An array of instantiated handlers used in this display.
DisplayPluginBase::$has_exposed public property
DisplayPluginBase::$output public property Stores the rendered output of the display.
DisplayPluginBase::$plugins protected property An array of instantiated plugins used in this display.
DisplayPluginBase::$unpackOptions protected static property Static cache for unpackOptions, but not if we are in the UI.
DisplayPluginBase::$usesAJAX protected property Whether the display allows the use of AJAX or not. 2
DisplayPluginBase::$usesAreas protected property Whether the display allows area plugins. 2
DisplayPluginBase::$usesMore protected property Whether the display allows the use of a &#039;more&#039; link or not. 1
DisplayPluginBase::$usesOptions protected property Denotes whether the plugin has an additional options form. Overrides PluginBase::$usesOptions 1
DisplayPluginBase::$usesPager protected property Whether the display allows the use of a pager or not. 4
DisplayPluginBase::$view public property The top object of a view. Overrides PluginBase::$view
DisplayPluginBase::acceptAttachments public function Determines whether this display can use attachments. Overrides DisplayPluginInterface::acceptAttachments
DisplayPluginBase::access public function Determines if the user has access to this display of the view. Overrides DisplayPluginInterface::access
DisplayPluginBase::ajaxEnabled public function Whether the display is actually using AJAX or not. Overrides DisplayPluginInterface::ajaxEnabled
DisplayPluginBase::applyDisplayCacheabilityMetadata protected function Applies the cacheability of the current display to the given render array.
DisplayPluginBase::attachTo public function Allows displays to attach to other views. Overrides DisplayPluginInterface::attachTo 2
DisplayPluginBase::buildBasicRenderable public static function Builds a basic render array which can be properly render cached. Overrides DisplayPluginInterface::buildBasicRenderable 1
DisplayPluginBase::buildRenderable public function Builds a renderable array of the view. Overrides DisplayPluginInterface::buildRenderable 1
DisplayPluginBase::buildRenderingLanguageOptions protected function Returns the available rendering strategies for language-aware entities.
DisplayPluginBase::calculateCacheMetadata public function Calculates the display&#039;s cache metadata by inspecting each handler/plugin. Overrides DisplayPluginInterface::calculateCacheMetadata
DisplayPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides PluginBase::calculateDependencies 2
DisplayPluginBase::defaultableSections public function Lists the &#039;defaultable&#039; sections and what items each section contains. Overrides DisplayPluginInterface::defaultableSections 1
DisplayPluginBase::destroy public function Clears a plugin. Overrides PluginBase::destroy
DisplayPluginBase::displaysExposed public function Determines if this display should display the exposed filters widgets. Overrides DisplayPluginInterface::displaysExposed 2
DisplayPluginBase::elementPreRender public function #pre_render callback for view display rendering. Overrides DisplayPluginInterface::elementPreRender
DisplayPluginBase::getAllHandlers protected function Gets all the handlers used by the display.
DisplayPluginBase::getAllPlugins protected function Gets all the plugins used by the display.
DisplayPluginBase::getArgumentsTokens public function Returns to tokens for arguments. Overrides DisplayPluginInterface::getArgumentsTokens
DisplayPluginBase::getArgumentText public function Provides help text for the arguments. Overrides DisplayPluginInterface::getArgumentText 1
DisplayPluginBase::getAttachedDisplays public function Find out all displays which are attached to this display. Overrides DisplayPluginInterface::getAttachedDisplays
DisplayPluginBase::getCacheMetadata public function Gets the cache metadata. Overrides DisplayPluginInterface::getCacheMetadata
DisplayPluginBase::getExtenders public function Gets the display extenders. Overrides DisplayPluginInterface::getExtenders
DisplayPluginBase::getFieldLabels public function Retrieves a list of fields for the current display. Overrides DisplayPluginInterface::getFieldLabels
DisplayPluginBase::getHandler public function Get the handler object for a single handler. Overrides DisplayPluginInterface::getHandler
DisplayPluginBase::getHandlers public function Get a full array of handlers for $type. This caches them. Overrides DisplayPluginInterface::getHandlers
DisplayPluginBase::getLinkDisplay public function Returns the ID of the display to use when making links. Overrides DisplayPluginInterface::getLinkDisplay
DisplayPluginBase::getMoreUrl protected function Get the more URL for this view.
DisplayPluginBase::getOption public function Gets an option, from this display or the default display. Overrides DisplayPluginInterface::getOption
DisplayPluginBase::getPagerText public function Provides help text for pagers. Overrides DisplayPluginInterface::getPagerText 1
DisplayPluginBase::getPath public function Returns the base path to use for this display. Overrides DisplayPluginInterface::getPath 1
DisplayPluginBase::getPlugin public function Get the instance of a plugin, for example style or row. Overrides DisplayPluginInterface::getPlugin
DisplayPluginBase::getRoutedDisplay public function Points to the display which can be linked by this display. Overrides DisplayPluginInterface::getRoutedDisplay
DisplayPluginBase::getSpecialBlocks public function Provides the block system with any exposed widget blocks for this display. Overrides DisplayPluginInterface::getSpecialBlocks
DisplayPluginBase::getType public function Returns the display type that this display requires. Overrides DisplayPluginInterface::getType 4
DisplayPluginBase::getUrl public function Returns a URL to $this display or its configured linked display. Overrides DisplayPluginInterface::getUrl
DisplayPluginBase::hasPath public function Checks to see if the display has a &#039;path&#039; field. Overrides DisplayPluginInterface::hasPath 1
DisplayPluginBase::initDisplay public function Initializes the display plugin. Overrides DisplayPluginInterface::initDisplay 1
DisplayPluginBase::isBaseTableTranslatable protected function Returns whether the base table is of a translatable entity type.
DisplayPluginBase::isDefaultDisplay public function Determines if this display is the &#039;default&#039; display. Overrides DisplayPluginInterface::isDefaultDisplay 1
DisplayPluginBase::isDefaulted public function Determines if an option is set to use the default or current display. Overrides DisplayPluginInterface::isDefaulted
DisplayPluginBase::isEnabled public function Whether the display is enabled. Overrides DisplayPluginInterface::isEnabled
DisplayPluginBase::isIdentifierUnique public function Checks if the provided identifier is unique. Overrides DisplayPluginInterface::isIdentifierUnique
DisplayPluginBase::isMoreEnabled public function Whether the display is using the &#039;more&#039; link or not. Overrides DisplayPluginInterface::isMoreEnabled
DisplayPluginBase::isPagerEnabled public function Whether the display is using a pager or not. Overrides DisplayPluginInterface::isPagerEnabled
DisplayPluginBase::mergeDefaults public function Merges default values for all plugin types. Overrides DisplayPluginInterface::mergeDefaults
DisplayPluginBase::mergeHandler protected function Merges handlers default values.
DisplayPluginBase::mergePlugin protected function Merges plugins default values.
DisplayPluginBase::newDisplay public function Reacts on adding a display. Overrides DisplayPluginInterface::newDisplay 1
DisplayPluginBase::optionLink public function Returns a link to a section of a form. Overrides DisplayPluginInterface::optionLink
DisplayPluginBase::optionsOverride public function If override/revert was clicked, perform the proper toggle. Overrides DisplayPluginInterface::optionsOverride
DisplayPluginBase::outputIsEmpty public function Is the output of the view empty. Overrides DisplayPluginInterface::outputIsEmpty
DisplayPluginBase::overrideOption public function Set an option and force it to be an override. Overrides DisplayPluginInterface::overrideOption
DisplayPluginBase::preExecute public function Sets up any variables on the view prior to execution. Overrides DisplayPluginInterface::preExecute
DisplayPluginBase::preview public function Renders the display for the purposes of a live preview. Overrides DisplayPluginInterface::preview 3
DisplayPluginBase::query public function Add anything to the query that we might need to. Overrides PluginBase::query 1
DisplayPluginBase::render public function Renders this display. Overrides DisplayPluginInterface::render 3
DisplayPluginBase::renderArea public function Renders one of the available areas. Overrides DisplayPluginInterface::renderArea
DisplayPluginBase::renderFilters public function Does nothing (obsolete function). Overrides DisplayPluginInterface::renderFilters
DisplayPluginBase::renderMoreLink public function Renders the &#039;more&#039; link. Overrides DisplayPluginInterface::renderMoreLink
DisplayPluginBase::renderPager public function Checks to see if the display plugins support pager rendering. Overrides DisplayPluginInterface::renderPager 1
DisplayPluginBase::setOption public function Sets an option, on this display or the default display. Overrides DisplayPluginInterface::setOption
DisplayPluginBase::setOverride public function Flip the override setting for the given section. Overrides DisplayPluginInterface::setOverride
DisplayPluginBase::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides PluginBase::trustedCallbacks
DisplayPluginBase::useGroupBy public function Does the display have groupby enabled? Overrides DisplayPluginInterface::useGroupBy
DisplayPluginBase::useMoreAlways public function Should the enabled display more link be shown when no more items? Overrides DisplayPluginInterface::useMoreAlways
DisplayPluginBase::useMoreText public function Does the display have custom link text? Overrides DisplayPluginInterface::useMoreText
DisplayPluginBase::usesAJAX public function Whether the display allows the use of AJAX or not. Overrides DisplayPluginInterface::usesAJAX 2
DisplayPluginBase::usesAreas public function Returns whether the display can use areas. Overrides DisplayPluginInterface::usesAreas 2
DisplayPluginBase::usesAttachments public function Returns whether the display can use attachments. Overrides DisplayPluginInterface::usesAttachments 6
DisplayPluginBase::usesExposed public function Determines if this display uses exposed filters. Overrides DisplayPluginInterface::usesExposed 3
DisplayPluginBase::usesFields public function Determines if the display&#039;s style uses fields. Overrides DisplayPluginInterface::usesFields
DisplayPluginBase::usesLinkDisplay public function Checks to see if the display has some need to link to another display. Overrides DisplayPluginInterface::usesLinkDisplay 1
DisplayPluginBase::usesMore public function Whether the display allows the use of a &#039;more&#039; link or not. Overrides DisplayPluginInterface::usesMore 1
DisplayPluginBase::usesPager public function Whether the display allows the use of a pager or not. Overrides DisplayPluginInterface::usesPager 4
DisplayPluginBase::validate public function Validate that the plugin is correct and can be saved. Overrides PluginBase::validate 3
DisplayPluginBase::validateOptionsForm public function Validate the options form. Overrides PluginBase::validateOptionsForm 2
DisplayPluginBase::viewExposedFormBlocks public function Renders the exposed form as block. Overrides DisplayPluginInterface::viewExposedFormBlocks
PluginBase::$definition public property Plugins&#039; definition.
PluginBase::$displayHandler public property The display object this plugin is for.
PluginBase::$options public property Options for this plugin will be held here.
PluginBase::$position public property The handler position.
PluginBase::$renderer protected property Stores the render API renderer. 3
PluginBase::doFilterByDefinedOptions protected function Do the work to filter out stored options depending on the defined options.
PluginBase::filterByDefinedOptions public function Filter out stored options depending on the defined options. Overrides ViewsPluginInterface::filterByDefinedOptions
PluginBase::getAvailableGlobalTokens public function Returns an array of available token replacements. Overrides ViewsPluginInterface::getAvailableGlobalTokens
PluginBase::getProvider public function Returns the plugin provider. Overrides ViewsPluginInterface::getProvider
PluginBase::getRenderer protected function Returns the render API renderer. 1
PluginBase::globalTokenForm public function Adds elements for available core tokens to a form. Overrides ViewsPluginInterface::globalTokenForm
PluginBase::globalTokenReplace public function Returns a string with any core tokens replaced. Overrides ViewsPluginInterface::globalTokenReplace
PluginBase::INCLUDE_ENTITY constant Include entity row languages when listing languages.
PluginBase::INCLUDE_NEGOTIATED constant Include negotiated languages when listing languages.
PluginBase::init public function Initialize the plugin. Overrides ViewsPluginInterface::init 6
PluginBase::listLanguages protected function Makes an array of languages, optionally including special languages.
PluginBase::pluginTitle public function Return the human readable name of the display. Overrides ViewsPluginInterface::pluginTitle
PluginBase::preRenderAddFieldsetMarkup public static function Moves form elements into fieldsets for presentation purposes. Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup
PluginBase::preRenderFlattenData public static function Flattens the structure of form elements. Overrides ViewsPluginInterface::preRenderFlattenData
PluginBase::queryLanguageSubstitutions public static function Returns substitutions for Views queries for languages.
PluginBase::setOptionDefaults protected function Fills up the options of the plugin with defaults.
PluginBase::summaryTitle public function Returns the summary of the settings in the display. Overrides ViewsPluginInterface::summaryTitle 6
PluginBase::themeFunctions public function Provide a full list of possible theme templates used by this style. Overrides ViewsPluginInterface::themeFunctions 1
PluginBase::unpackOptions public function Unpacks options over our existing defaults. Overrides ViewsPluginInterface::unpackOptions
PluginBase::usesOptions public function Returns the usesOptions property. Overrides ViewsPluginInterface::usesOptions 8
PluginBase::viewsTokenReplace protected function Replaces Views&#039; tokens in a given string. 1
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT constant Query string to indicate the site default language.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING Deprecated constant Untrusted callbacks trigger E_USER_WARNING errors.

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