class ViewsExposedFilterBlock

Same name in this branch
  1. 11.x core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
Same name in other branches
  1. 9 core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
  2. 9 core/modules/views/src/Plugin/Block/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Block\ViewsExposedFilterBlock
  3. 8.9.x core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
  4. 8.9.x core/modules/views/src/Plugin/Block/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Block\ViewsExposedFilterBlock
  5. 10 core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
  6. 10 core/modules/views/src/Plugin/Block/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Block\ViewsExposedFilterBlock

Provides a 'Views Exposed Filter' block.

Hierarchy

Expanded class hierarchy of ViewsExposedFilterBlock

File

core/modules/views/src/Plugin/Block/ViewsExposedFilterBlock.php, line 14

Namespace

Drupal\views\Plugin\Block
View source
class ViewsExposedFilterBlock extends ViewsBlockBase {
    
    /**
     * {@inheritdoc}
     */
    public function getCacheContexts() {
        $contexts = $this->view->display_handler
            ->getCacheMetadata()
            ->getCacheContexts();
        return Cache::mergeContexts(parent::getCacheContexts(), $contexts);
    }
    
    /**
     * {@inheritdoc}
     *
     * @return array
     *   A renderable array representing the content of the block with additional
     *   context of current view and display ID.
     */
    public function build() : array {
        $output = $this->view->display_handler
            ->viewExposedFormBlocks() ?? [];
        // Provide the context for block build and block view alter hooks.
        // \Drupal\views\Plugin\Block\ViewsBlock::build() adds the same context in
        // \Drupal\views\ViewExecutable::buildRenderable() using
        // \Drupal\views\Plugin\views\display\DisplayPluginBase::buildRenderable().
        if (!empty($output)) {
            $output += [
                '#view' => $this->view,
                '#display_id' => $this->displayID,
            ];
        }
        // Before returning the block output, convert it to a renderable array with
        // contextual links.
        $this->addContextualLinks($output, 'exposed_filter');
        // Set the blocks title.
        if (!empty($this->configuration['label_display']) && ($this->view
            ->getTitle() || !empty($this->configuration['views_label']))) {
            $output['#title'] = [
                '#markup' => empty($this->configuration['views_label']) ? $this->view
                    ->getTitle() : $this->configuration['views_label'],
                '#allowed_tags' => Xss::getHtmlTagList(),
            ];
        }
        return $output;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$inPreview protected property Whether the plugin is being rendered in preview mode.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockForm public function 17
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual
block plugins can add elements to this form by overriding
BlockBase::blockForm(). Most block plugins should not override this
method unless they need to alter the generic form elements.
Aliased as: traitBuildConfigurationForm
BlockPluginTrait::calculateDependencies public function 1
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setInPreview public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission
handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation
for a specific block type, override BlockBase::blockValidate().
1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::getCacheMaxAge public function 6
ContextAwarePluginTrait::getCacheTags public function 3
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function 1
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
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
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2
PluginWithFormsTrait::getFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
PluginWithFormsTrait::hasFormClass public function Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
ViewsBlockBase::$displayID protected property The display ID being used for this View.
ViewsBlockBase::$displaySet protected property Indicates whether the display was successfully set.
ViewsBlockBase::$user protected property The current user.
ViewsBlockBase::$view protected property The View executable object.
ViewsBlockBase::addContextualLinks protected function Converts Views block content to a renderable array with contextual links.
ViewsBlockBase::blockAccess protected function Indicates whether the block should be shown. Overrides BlockPluginTrait::blockAccess
ViewsBlockBase::blockSubmit public function Overrides BlockPluginTrait::blockSubmit 1
ViewsBlockBase::buildConfigurationForm public function Form constructor. Overrides BlockBase::buildConfigurationForm
ViewsBlockBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ViewsBlockBase::defaultConfiguration public function Overrides BlockPluginTrait::defaultConfiguration 1
ViewsBlockBase::getPreviewFallbackString public function Overrides BlockPluginTrait::getPreviewFallbackString
ViewsBlockBase::getViewExecutable public function Gets the view executable.
ViewsBlockBase::__construct public function Constructs a \Drupal\views\Plugin\Block\ViewsBlockBase object. Overrides BlockPluginTrait::__construct
ViewsExposedFilterBlock::build public function Overrides BlockPluginInterface::build
ViewsExposedFilterBlock::getCacheContexts public function Overrides ContextAwarePluginTrait::getCacheContexts

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