class ViewsExposedFilterBlock
Same name in this branch
- 8.9.x core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
Same name in other branches
- 9 core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
- 9 core/modules/views/src/Plugin/Block/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Block\ViewsExposedFilterBlock
- 10 core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
- 10 core/modules/views/src/Plugin/Block/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Block\ViewsExposedFilterBlock
- 11.x core/modules/views/src/Plugin/Derivative/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock
- 11.x core/modules/views/src/Plugin/Block/ViewsExposedFilterBlock.php \Drupal\views\Plugin\Block\ViewsExposedFilterBlock
Provides a 'Views Exposed Filter' block.
Plugin annotation
@Block(
id = "views_exposed_filter_block",
admin_label = @Translation("Views Exposed Filter Block"),
deriver = "Drupal\views\Plugin\Derivative\ViewsExposedFilterBlock"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Block\BlockBase extends \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Render\PreviewFallbackInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait
- class \Drupal\views\Plugin\Block\ViewsBlockBase extends \Drupal\Core\Block\BlockBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\views\Plugin\Block\ViewsExposedFilterBlock extends \Drupal\views\Plugin\Block\ViewsBlockBase
- class \Drupal\views\Plugin\Block\ViewsBlockBase extends \Drupal\Core\Block\BlockBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\Core\Block\BlockBase extends \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Render\PreviewFallbackInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface
Expanded class hierarchy of ViewsExposedFilterBlock
File
-
core/
modules/ views/ src/ Plugin/ Block/ ViewsExposedFilterBlock.php, line 17
Namespace
Drupal\views\Plugin\BlockView 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() {
$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 (is_array($output) && !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 | Overriden Title | Overrides |
---|---|---|---|---|---|
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 | |||
ViewsBlockBase::blockSubmit | public | function | 1 | ||
ViewsBlockBase::buildConfigurationForm | public | function | |||
ViewsBlockBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
ViewsBlockBase::defaultConfiguration | public | function | 1 | ||
ViewsBlockBase::getPreviewFallbackString | public | function | |||
ViewsBlockBase::getViewExecutable | public | function | Gets the view executable. | ||
ViewsBlockBase::__construct | public | function | Constructs a \Drupal\views\Plugin\Block\ViewsBlockBase object. | ||
ViewsExposedFilterBlock::build | public | function | |||
ViewsExposedFilterBlock::getCacheContexts | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.