class BlockBase
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Block/BlockBase.php \Drupal\Core\Block\BlockBase
- 8.9.x core/lib/Drupal/Core/Block/BlockBase.php \Drupal\Core\Block\BlockBase
- 10 core/lib/Drupal/Core/Block/BlockBase.php \Drupal\Core\Block\BlockBase
Defines a base block implementation that most blocks plugins will extend.
This abstract class provides the generic block configuration form, default block settings, and handling for general user-defined block visibility settings.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Block\BlockBase extends \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Plugin\PreviewAwarePluginInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of BlockBase
10 files declare their use of BlockBase
- AnnounceBlock.php in core/
modules/ announcements_feed/ src/ Plugin/ Block/ AnnounceBlock.php - ClearCacheBlock.php in core/
modules/ system/ src/ Plugin/ Block/ ClearCacheBlock.php - LocalActionsBlock.php in core/
lib/ Drupal/ Core/ Menu/ Plugin/ Block/ LocalActionsBlock.php - LocalTasksBlock.php in core/
lib/ Drupal/ Core/ Menu/ Plugin/ Block/ LocalTasksBlock.php - NavigationLinkBlock.php in core/
modules/ navigation/ src/ Plugin/ Block/ NavigationLinkBlock.php
File
-
core/
lib/ Drupal/ Core/ Block/ BlockBase.php, line 23
Namespace
Drupal\Core\BlockView source
abstract class BlockBase extends PluginBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewAwarePluginInterface, PreviewFallbackInterface, ContextAwarePluginInterface {
use BlockPluginTrait {
buildConfigurationForm as traitBuildConfigurationForm;
submitConfigurationForm as traitSubmitConfigurationForm;
}
use ContextAwarePluginTrait;
use ContextAwarePluginAssignmentTrait;
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = $this->traitBuildConfigurationForm($form, $form_state);
// Add context mapping UI form elements.
$contexts = $form_state->getTemporaryValue('gathered_contexts') ?: [];
$form['context_mapping'] = $this->addContextAssignmentElement($this, $contexts);
return $form;
}
/**
* {@inheritdoc}
*/
public function submitConfigurationForm(array &$form, FormStateInterface $form_state) : void {
if (!$form_state->getErrors() && $form_state->getValue('context_mapping')) {
$this->configuration['context_mapping'] = $form_state->getValue('context_mapping');
}
$this->traitSubmitConfigurationForm($form, $form_state);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
BlockBase::buildConfigurationForm | public | function | Form constructor. | Overrides PluginFormInterface::buildConfigurationForm | 2 | ||
BlockBase::submitConfigurationForm | public | function | Form submission handler. | Overrides PluginFormInterface::submitConfigurationForm | |||
BlockPluginInterface::BLOCK_LABEL_VISIBLE | constant | Indicates the block label (title) should be displayed to end users. | |||||
BlockPluginInterface::build | public | function | Builds and returns the renderable array for this block plugin. | 57 | |||
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::blockAccess | protected | function | Indicates whether the block should be shown. | 19 | |||
BlockPluginTrait::blockForm | public | function | 17 | ||||
BlockPluginTrait::blockSubmit | public | function | 13 | ||||
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::createPlaceholder | public | function | 6 | ||||
BlockPluginTrait::defaultConfiguration | public | function | 19 | ||||
BlockPluginTrait::getConfiguration | public | function | 1 | ||||
BlockPluginTrait::getMachineNameSuggestion | public | function | 1 | ||||
BlockPluginTrait::getPreviewFallbackString | public | function | 3 | ||||
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(). |
Aliased as: traitSubmitConfigurationForm | |||
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 | |||
BlockPluginTrait::__construct | public | function | 26 | ||||
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::getCacheContexts | public | function | 10 | ||||
ContextAwarePluginTrait::getCacheMaxAge | public | function | 7 | ||||
ContextAwarePluginTrait::getCacheTags | public | function | 4 | ||||
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 | |||||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |||
PluginBase::$pluginId | protected | property | The plugin ID. | ||||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |||
PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | |||
PluginWithFormsTrait::getFormClass | public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass(). | ||||
PluginWithFormsTrait::hasFormClass | public | function | Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass(). |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.