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 implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\Block\BlockBase implements BlockPluginInterface, PluginWithFormsInterface uses ContextAwarePluginAssignmentTrait, PluginWithFormsTrait
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements ContextAwarePluginInterface
Related topics
- Block API
- Information about the classes and interfaces that make up the Block API.
File
- core/lib/Drupal/Core/Block/BlockBase.php, line 27
Namespace
Drupal\Core\Block
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| BlockBase::$transliteration | protected | property | The transliteration service. |
| BlockBase::access | public | function | Indicates whether the block should be shown. Overrides BlockPluginInterface::access |
| BlockBase::baseConfigurationDefaults | protected | function | Returns generic default configuration for block plugins. |
| BlockBase::blockAccess | protected | function | Indicates whether the block should be shown. |
| BlockBase::blockForm | public | function | Returns the configuration form elements specific to this block plugin. Overrides BlockPluginInterface::blockForm |
| BlockBase::blockSubmit | public | function | Adds block type-specific submission handling for the block form. Overrides BlockPluginInterface::blockSubmit |
| BlockBase::blockValidate | public | function | Adds block type-specific validation for the block form. Overrides BlockPluginInterface::blockValidate |
| BlockBase::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. Overrides PluginFormInterface::buildConfigurationForm |
| BlockBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies |
| BlockBase::defaultConfiguration | public | function | Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration |
| BlockBase::getConfiguration | public | function | Gets this plugin's configuration. Overrides ConfigurablePluginInterface::getConfiguration |
| BlockBase::getMachineNameSuggestion | public | function | Suggests a machine name to identify an instance of this block. Overrides BlockPluginInterface::getMachineNameSuggestion |
| BlockBase::label | public | function | Returns the user-facing block label. Overrides BlockPluginInterface::label |
| BlockBase::setConfiguration | public | function | Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration |
| BlockBase::setConfigurationValue | public | function | Sets a particular value in the block settings. Overrides BlockPluginInterface::setConfigurationValue |
| BlockBase::setTransliteration | public | function | Sets the transliteration service. |
| BlockBase::submitConfigurationForm | public | function | Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit(). Overrides PluginFormInterface::submitConfigurationForm |
| BlockBase::transliteration | protected | function | Wraps the transliteration service. |
| BlockBase::validateConfigurationForm | public | function | Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). Overrides PluginFormInterface::validateConfigurationForm |
| BlockBase::__construct | public | function | Overrides \Drupal\Component\Plugin\PluginBase::__construct(). Overrides ContextAwarePluginBase::__construct |
| BlockPluginInterface::build | public | function | Builds and returns the renderable array for this block plugin. |
| ContextAwarePluginAssignmentTrait::addContextAssignmentElement | protected | function | Builds a form element for assigning a context to a given slot. |
| ContextAwarePluginAssignmentTrait::contextHandler | protected | function | Wraps the context handler. Overrides ContextAwarePluginBase::contextHandler |
| ContextAwarePluginAssignmentTrait::t | abstract protected | function | Ensures the t() method is available. Overrides StringTranslationTrait::t |
| ContextAwarePluginBase::$context | protected | property | The data objects representing the context of this plugin. |
| ContextAwarePluginBase::createContextFromConfiguration | protected | function | Overrides ContextAwarePluginBase::createContextFromConfiguration |
| ContextAwarePluginBase::getCacheContexts | public | function | The cache contexts associated with this object. |
| ContextAwarePluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. |
| ContextAwarePluginBase::getCacheTags | public | function | The cache tags associated with this object. |
| ContextAwarePluginBase::getContext | public | function | This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext |
| ContextAwarePluginBase::getContextDefinition | public | function | Overrides ContextAwarePluginBase::getContextDefinition |
| ContextAwarePluginBase::getContextDefinitions | public | function | Overrides ContextAwarePluginBase::getContextDefinitions |
| ContextAwarePluginBase::getContextMapping | public | function | Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping |
| ContextAwarePluginBase::getContexts | public | function | Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts |
| ContextAwarePluginBase::getContextValue | public | function | Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue |
| ContextAwarePluginBase::getContextValues | public | function | Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues |
| ContextAwarePluginBase::setContext | public | function | Set a context on this plugin. Overrides ContextAwarePluginBase::setContext |
| ContextAwarePluginBase::setContextMapping | public | function | Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping |
| ContextAwarePluginBase::setContextValue | public | function | Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue |
| ContextAwarePluginBase::validateContexts | public | function | Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts |
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | |
| DependencySerializationTrait::__wakeup | public | function | |
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. |
| 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::getPluginDefinition | public | function | Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition |
| PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId |
| PluginWithFormsTrait::getFormClass | public | function | Gets the form class for the given operation. Overrides PluginWithFormsInterface::getFormClass |
| PluginWithFormsTrait::hasFormClass | public | function | Gets whether the plugin has a form class for the given operation. Overrides PluginWithFormsInterface::hasFormClass |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. |
| 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. |
| TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. |
| TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. |
| TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. |
Please login to continue.