class PageTitle

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Render/Element/PageTitle.php \Drupal\Core\Render\Element\PageTitle
  2. 10 core/lib/Drupal/Core/Render/Element/PageTitle.php \Drupal\Core\Render\Element\PageTitle
  3. 11.x core/lib/Drupal/Core/Render/Element/PageTitle.php \Drupal\Core\Render\Element\PageTitle

Provides a render element for the title of an HTML page.

This represents the title of the HTML page's body.

Plugin annotation

@RenderElement("page_title");

Hierarchy

Expanded class hierarchy of PageTitle

3 #type uses of PageTitle
BatchController::batchPage in core/modules/system/src/Controller/BatchController.php
Returns a system batch page.
PageTitleBlock::build in core/lib/Drupal/Core/Block/Plugin/Block/PageTitleBlock.php
Builds and returns the renderable array for this block plugin.
SimplePageVariant::build in core/lib/Drupal/Core/Render/Plugin/DisplayVariant/SimplePageVariant.php
Builds and returns the renderable array for the display variant.

File

core/lib/Drupal/Core/Render/Element/PageTitle.php, line 12

Namespace

Drupal\Core\Render\Element
View source
class PageTitle extends RenderElement {
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        return [
            '#theme' => 'page_title',
            // The page title: either a string for plain titles or a render array for
            // formatted titles.
'#title' => NULL,
        ];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
PageTitle::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
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
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes

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