interface TitleBlockPluginInterface in Drupal 10

The interface for "title" blocks.

A title block shows the title returned by the controller.

Hierarchy

• interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Cache\CacheableDependencyInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface
  • interface \Drupal\Core\Block\BlockPluginInterface
    • interface \Drupal\Core\Block\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

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);

}