interface MessagesBlockPluginInterface

The interface for "messages" (#type => status_messages) blocks.

Hierarchy

Expanded class hierarchy of MessagesBlockPluginInterface

All classes that implement MessagesBlockPluginInterface

See also

\Drupal\Core\Messenger\MessengerInterface

\Drupal\Core\Render\Element\StatusMessages

\Drupal\block\Plugin\DisplayVariant\BlockPageVariant

Related topics

Block API
Information about the classes and interfaces that make up the Block API.
2 files declare their use of MessagesBlockPluginInterface
BlockPageVariant.php in core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php
SystemMessagesBlock.php in core/modules/system/src/Plugin/Block/SystemMessagesBlock.php

File

View on git.drupalcode.org

core/lib/Drupal/Core/Block/MessagesBlockPluginInterface.php, line 14

Namespace

Drupal\Core\Block
View source 
interface MessagesBlockPluginInterface extends BlockPluginInterface {

}

Members

Title Modifiers Object type Summary Overrides
BlockPluginInterface::access public function Indicates whether the block should be shown.
BlockPluginInterface::blockForm public function Returns the configuration form elements specific to this block plugin.
BlockPluginInterface::blockSubmit public function Adds block type-specific submission handling for the block form.
BlockPluginInterface::blockValidate public function Adds block type-specific validation for the block form.
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. 53
BlockPluginInterface::getMachineNameSuggestion public function Suggests a machine name to identify an instance of this block.
BlockPluginInterface::label public function Returns the user-facing block label.
BlockPluginInterface::setConfigurationValue public function Sets a particular value in the block settings.
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 24
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 13
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 13
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 19
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
PluginFormInterface::buildConfigurationForm public function Form constructor. 46
PluginFormInterface::submitConfigurationForm public function Form submission handler. 41
PluginFormInterface::validateConfigurationForm public function Form validation handler. 28
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 2

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