class SystemMainBlock

Same name in other branches
  1. 9 core/modules/system/src/Plugin/Block/SystemMainBlock.php \Drupal\system\Plugin\Block\SystemMainBlock
  2. 10 core/modules/system/src/Plugin/Block/SystemMainBlock.php \Drupal\system\Plugin\Block\SystemMainBlock
  3. 11.x core/modules/system/src/Plugin/Block/SystemMainBlock.php \Drupal\system\Plugin\Block\SystemMainBlock

Provides a 'Main page content' block.

Plugin annotation


@Block(
  id = "system_main_block",
  admin_label = @Translation("Main page content"),
  forms = {
    "settings_tray" = FALSE,
  },
)

Hierarchy

Expanded class hierarchy of SystemMainBlock

File

core/modules/system/src/Plugin/Block/SystemMainBlock.php, line 19

Namespace

Drupal\system\Plugin\Block
View source
class SystemMainBlock extends BlockBase implements MainContentBlockPluginInterface {
    
    /**
     * The render array representing the main page content.
     *
     * @var array
     */
    protected $mainContent;
    
    /**
     * {@inheritdoc}
     */
    public function setMainContent(array $main_content) {
        $this->mainContent = $main_content;
    }
    
    /**
     * {@inheritdoc}
     */
    public function build() {
        return $this->mainContent;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title 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::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. 14
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 14
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 14
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 21
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. 32
PluginFormInterface::submitConfigurationForm public function Form submission handler. 31
PluginFormInterface::validateConfigurationForm public function Form validation handler. 17
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
SystemMainBlock::$mainContent protected property The render array representing the main page content.
SystemMainBlock::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
SystemMainBlock::setMainContent public function Sets the main content render array. Overrides MainContentBlockPluginInterface::setMainContent

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