interface TitleBlockPluginInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Block/TitleBlockPluginInterface.php \Drupal\Core\Block\TitleBlockPluginInterface
  2. 8.9.x core/lib/Drupal/Core/Block/TitleBlockPluginInterface.php \Drupal\Core\Block\TitleBlockPluginInterface
  3. 11.x core/lib/Drupal/Core/Block/TitleBlockPluginInterface.php \Drupal\Core\Block\TitleBlockPluginInterface

The interface for "title" blocks.

A title block shows the title returned by the controller.

Hierarchy

Expanded class hierarchy of TitleBlockPluginInterface

All classes that implement TitleBlockPluginInterface

See also

\Drupal\Core\Render\Element\PageTitle

Related topics

Block API
Information about the classes and interfaces that make up the Block API.
3 files declare their use of TitleBlockPluginInterface
BlockPageVariant.php in core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php
BlockViewBuilder.php in core/modules/block/src/BlockViewBuilder.php
PageTitleBlock.php in core/lib/Drupal/Core/Block/Plugin/Block/PageTitleBlock.php

File

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

Namespace

Drupal\Core\Block
View source 
interface TitleBlockPluginInterface extends BlockPluginInterface {
    
    /**
     * Sets the title.
     *
     * @param string|array $title
     *   The page title: either a string for plain titles or a render array for
     *   formatted titles.
     */
    public function setTitle($title);

}

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. 54
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. 13
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. 31
PluginFormInterface::submitConfigurationForm public function Form submission handler. 29
PluginFormInterface::validateConfigurationForm public function Form validation handler. 16
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
TitleBlockPluginInterface::setTitle public function Sets the title. 1

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