class SystemMainBlock
Same name and namespace in other branches
- 11.x core/modules/system/src/Plugin/Block/SystemMainBlock.php \Drupal\system\Plugin\Block\SystemMainBlock
- 10 core/modules/system/src/Plugin/Block/SystemMainBlock.php \Drupal\system\Plugin\Block\SystemMainBlock
- 9 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
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait extends \Drupal\Component\Plugin\ContextAwarePluginBase
- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Render\PreviewFallbackInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\ContextAwarePluginBase
- class \Drupal\system\Plugin\Block\SystemMainBlock implements \Drupal\Core\Block\MainContentBlockPluginInterface extends \Drupal\Core\Block\BlockBase
- class \Drupal\Core\Block\BlockBase implements \Drupal\Core\Block\BlockPluginInterface, \Drupal\Core\Plugin\PluginWithFormsInterface, \Drupal\Core\Render\PreviewFallbackInterface uses \Drupal\Core\Block\BlockPluginTrait, \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait extends \Drupal\Core\Plugin\ContextAwarePluginBase
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait extends \Drupal\Component\Plugin\ContextAwarePluginBase
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of SystemMainBlock
File
-
core/
modules/ system/ src/ Plugin/ Block/ SystemMainBlock.php, line 19
Namespace
Drupal\system\Plugin\BlockView 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 | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
BlockPluginInterface::BLOCK_LABEL_VISIBLE | constant | Indicates the block label (title) should be displayed to end users. | ||||
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. | |||
BlockPluginTrait::blockForm | public | function | 1 | |||
BlockPluginTrait::blockSubmit | public | function | ||||
BlockPluginTrait::blockValidate | public | function | ||||
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. |
|||
BlockPluginTrait::calculateDependencies | public | function | ||||
BlockPluginTrait::defaultConfiguration | public | function | ||||
BlockPluginTrait::getConfiguration | public | function | ||||
BlockPluginTrait::getMachineNameSuggestion | public | function | ||||
BlockPluginTrait::getPreviewFallbackString | public | function | ||||
BlockPluginTrait::label | public | function | ||||
BlockPluginTrait::setConfiguration | public | function | ||||
BlockPluginTrait::setConfigurationValue | 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(). |
|||
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(). |
|||
BlockPluginTrait::__construct | public | function | 2 | |||
ContextAwarePluginAssignmentTrait::addContextAssignmentElement | protected | function | Builds a form element for assigning a context to a given slot. | |||
ContextAwarePluginAssignmentTrait::contextHandler | protected | function | Wraps the context handler. | |||
ContextAwarePluginBase::$context | protected | property | The data objects representing the context of this plugin. | |||
ContextAwarePluginBase::$contexts | Deprecated | private | property | Data objects representing the contexts passed in the plugin configuration. | ||
ContextAwarePluginBase::createContextFromConfiguration | protected | function | ||||
ContextAwarePluginBase::getCacheContexts | public | function | ||||
ContextAwarePluginBase::getCacheMaxAge | public | function | 1 | |||
ContextAwarePluginBase::getCacheTags | public | function | ||||
ContextAwarePluginBase::getContext | public | function | This code is identical to the Component in order to pick up a different Context class. |
|||
ContextAwarePluginBase::getContextDefinition | public | function | ||||
ContextAwarePluginBase::getContextDefinitions | public | function | ||||
ContextAwarePluginBase::getContextMapping | public | function | ||||
ContextAwarePluginBase::getContexts | public | function | ||||
ContextAwarePluginBase::getContextValue | public | function | ||||
ContextAwarePluginBase::getContextValues | public | function | ||||
ContextAwarePluginBase::setContext | public | function | ||||
ContextAwarePluginBase::setContextMapping | public | function | ||||
ContextAwarePluginBase::setContextValue | public | function | ||||
ContextAwarePluginBase::validateContexts | public | function | ||||
ContextAwarePluginBase::__get | public | function | Implements magic __get() method. | |||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | ||||
DependencySerializationTrait::__wakeup | public | function | ||||
MessengerTrait::$messenger | protected | property | The messenger. | 3 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 3 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
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 | ||||
PluginBase::getDerivativeId | public | function | ||||
PluginBase::getPluginDefinition | public | function | 1 | |||
PluginBase::getPluginId | public | function | ||||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | |||
PluginWithFormsTrait::getFormClass | public | function | ||||
PluginWithFormsTrait::hasFormClass | public | function | ||||
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. | 1 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | |||
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 | ||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.