BlockBase
abstract class BlockBase extends PluginBase implements BlockPluginInterface, PluginWithFormsInterface, PreviewFallbackInterface, ContextAwarePluginInterface (View source)
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.
Traits
Provides the base implementation of a block plugin.
Provides a trait to add context-aware functionality to plugins.
Handles context assignments for context-aware plugins.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides a trait for the messenger service.
Provides a trait with typical behavior for plugins which have forms.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected TransliterationInterface | $transliteration | The transliteration service. |
from BlockPluginTrait |
| protected ContextInterface[] | $context | The data objects representing the context of this plugin. |
from ContextAwarePluginTrait |
| protected bool internal | $initializedContextConfig | Tracks whether the context has been initialized from configuration. |
from ContextAwarePluginTrait |
Methods
{@inheritdoc}
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
Returns generic default configuration for block plugins.
Wraps the context handler.
Builds a form element for assigning a context to a given slot.
Details
__construct(array $configuration, $plugin_id, $plugin_definition)
{@inheritdoc}
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
abstract protected
getPluginDefinition()
{@inheritdoc}
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
getFormClass($operation)
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::getFormClass().
hasFormClass($operation)
Implements \Drupal\Core\Plugin\PluginWithFormsInterface::hasFormClass().
label()
{@inheritdoc}
getConfiguration()
{@inheritdoc}
setConfiguration(array $configuration)
{@inheritdoc}
protected array
baseConfigurationDefaults()
Returns generic default configuration for block plugins.
defaultConfiguration()
{@inheritdoc}
setConfigurationValue($key, $value)
{@inheritdoc}
calculateDependencies()
{@inheritdoc}
access(AccountInterface $account, $return_as_object = FALSE)
{@inheritdoc}
protected AccessResult
blockAccess(AccountInterface $account)
Indicates whether the block should be shown.
Blocks with specific access checking should override this method rather than access(), in order to avoid repeating the handling of the $return_as_object argument.
array
buildConfigurationForm(array $form, FormStateInterface $form_state)
Form constructor.
Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and
array_parents, see \Drupal\Core\Render\Element\FormElement.
blockForm($form, FormStateInterface $form_state)
{@inheritdoc}
validateConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate().
blockValidate($form, FormStateInterface $form_state)
{@inheritdoc}
submitConfigurationForm(array $form, FormStateInterface $form_state)
{@inheritdoc}
Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
blockSubmit($form, FormStateInterface $form_state)
{@inheritdoc}
getMachineNameSuggestion()
{@inheritdoc}
getPreviewFallbackString()
{@inheritdoc}
protected TransliterationInterface
transliteration()
Wraps the transliteration service.
setTransliteration(TransliterationInterface $transliteration)
Sets the transliteration service.
getContexts()
{@inheritdoc}
ContextInterface
getContext($name)
{@inheritdoc}
setContext($name, ContextInterface $context)
{@inheritdoc}
getContextValues()
{@inheritdoc}
getContextValue($name)
{@inheritdoc}
setContextValue($name, $value)
{@inheritdoc}
getContextMapping()
{@inheritdoc}
setContextMapping(array $context_mapping)
{@inheritdoc}
ContextDefinitionInterface[]
getContextDefinitions()
{@inheritdoc}
ContextDefinitionInterface
getContextDefinition($name)
{@inheritdoc}
validateContexts()
{@inheritdoc}
getCacheContexts()
{@inheritdoc}
getCacheTags()
{@inheritdoc}
getCacheMaxAge()
{@inheritdoc}
protected ContextHandlerInterface
contextHandler()
Wraps the context handler.
protected array
addContextAssignmentElement(ContextAwarePluginInterface $plugin, array $contexts)
Builds a form element for assigning a context to a given slot.