---
title: "Page title API"
manual: "TYPO3 Explained"
version: "12.4"
permalink: "https://docs.typo3.org/permalink/t3coreapi:pagetitle@12.4"
source: "ApiOverview/Seo/PageTitleApi.rst"
rendered: "2026-10-21T15:29:37+00:00"
---

> [!WARNING]
> **Attention**
>
> TYPO3 v12 has reached end-of-life as of April 30th 2026 and
> is no longer being maintained. Use the version switcher on the top
> left of this page to select documentation for a supported version of TYPO3.
>
> Need more time before upgrading?
> You can purchase Extended Long Term Support (ELTS) for TYPO3 v12 here:
> [TYPO3 ELTS](https://typo3.com/services/extended-support-elts).

# Page title API {#pagetitle}

In order to keep setting the page titles in control, you can use the PageTitle
API. The API uses *page title providers* to define the page title based on
page record and the content on the page.

Based on the priority of the providers, the
`\TYPO3\CMS\Core\PageTitle\PageTitleProviderManager` will check the
providers if a title is given by the provider. It will start with the highest
priority and will end with the lowest priority.

By default, the Core ships two providers. If you have installed the [system
extension SEO](https://docs.typo3.org/c/typo3/cms-seo/12.4/en-us/Index.html), the provider with the (by default) highest
priority will be the `\TYPO3\CMS\Seo\PageTitle\SeoTitlePageTitleProvider`.
When an editor has set a value for the SEO title in the page properties of the
page, this provider will provide that title to the
`PageTitleProviderManager`. If you have not installed the SEO system
extension, the field and provider are not available.

The fallback provider with the lowest priority is the
`\TYPO3\CMS\Core\PageTitle\RecordPageTitleProvider`. When no other title is
set by a provider, this provider will return the title of the page.

Besides the providers shipped by the Core, you can add own providers. An
integrator can define the priority of the providers for his project.

> [!NOTE]
> **See also**
>
> The page title is further influenced by [Properties of 'config'](https://docs.typo3.org/m/typo3/reference-typoscript/12.4/en-us/TopLevelObjects/Config.html#setup-config-pagetitle)
> and [websiteTitle](https://docs.typo3.org/permalink/t3coreapi:sitehandling-basics-websitetitle@12.4).

**Table of contents**

-   [Create your own page title provider](https://docs.typo3.org/permalink/t3coreapi:create-your-own-page-title-provider@12.4)
-   [Define the priority of PageTitleProviders](https://docs.typo3.org/permalink/t3coreapi:define-the-priority-of-pagetitleproviders-1@12.4)

## Create your own page title provider {#create-your-own-page-title-provider}

Extension developers may want to have an own provider for page titles. For
example, if you have an extension with records and a detail view, the title of
the page record will not be the correct title. To make sure to display the
correct page title, you have to create your own page title provider. It is
quite easy to create one.

### Example: Set the page title from your extension's controller {#example-set-the-page-title-from-your-extension-s-controller}

First, create a PHP class in your extension that implements the
`\TYPO3\CMS\Core\PageTitle\PageTitleProviderInterface`, for example by
extending `\TYPO3\CMS\Core\PageTitle\AbstractPageTitleProvider`.  Within
this method you can create your own logic to define the correct title.

**EXT:my_extension/Classes/PageTitle/MyOwnPageTitleProvider.php**

```php
<?php

declare(strict_types=1);

namespace MyVendor\MySitepackage\PageTitle;

use TYPO3\CMS\Core\PageTitle\AbstractPageTitleProvider;

final class MyOwnPageTitleProvider extends AbstractPageTitleProvider
{
    public function setTitle(string $title): void
    {
        $this->title = $title;
    }
}

```

Usage example in an [Extbase](https://docs.typo3.org/permalink/t3coreapi:extbase@12.4) controller:

**EXT:my_extension/Classes/Controller/SomeController.php**

```php
<?php

use MyVendor\MySitepackage\PageTitle\MyOwnPageTitleProvider;
use Psr\Http\Message\ResponseInterface;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

final class SomeController extends ActionController
{
    public function __construct(
        private readonly MyOwnPageTitleProvider $titleProvider,
    ) {}

    public function someAction(): ResponseInterface
    {
        $this->titleProvider->setTitle('Title from controller action');
        // do something
        return $this->htmlResponse();
    }
}

```

Configure the new page title provider in your TypoScript setup:

**EXT:my_sitepackage/Configuration/TypoScript/setup.typoscript**

```typoscript
config {
  pageTitleProviders {
    sitepackage {
      provider = MyVendor\MySitepackage\PageTitle\MyOwnPageTitleProvider
      before = record
    }
  }
}

```

### Example: Use values from the site configuration in the page title {#example-use-values-from-the-site-configuration-in-the-page-title}

If you want to use data from the [site configuration](https://docs.typo3.org/permalink/t3coreapi:sitehandling@12.4), for
example the site title, you can implement a page title provider as follows:

**EXT:my_sitepackage/Classes/PageTitle/WebsiteTitleProvider.php**

```php
<?php

declare(strict_types=1);

namespace MyVendor\MySitepackage\PageTitle;

use TYPO3\CMS\Core\PageTitle\PageTitleProviderInterface;
use TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;

final class WebsiteTitleProvider implements PageTitleProviderInterface
{
    public function __construct(
        private readonly SiteFinder $siteFinder,
    ) {}

    public function getTitle(): string
    {
        $site = $this->siteFinder->getSiteByPageId($this->getTypoScriptFrontendController()->page['uid']);
        $titles = [
            $this->getTypoScriptFrontendController()->page['title'],
            $site->getAttribute('websiteTitle'),
        ];

        // do something
        return implode(' - ', $titles);
    }

    private function getTypoScriptFrontendController(): TypoScriptFrontendController
    {
        return $GLOBALS['TSFE'];
    }
}

```

As we need to [inject](https://docs.typo3.org/permalink/t3coreapi:dependencyinjection@12.4) the class `SiteFinder`
to retrieve the current site configuration, we must make the new page title
provider [public](https://docs.typo3.org/permalink/t3coreapi:knowing-what-to-make-public@12.4):

**EXT:my_sitepackage/Configuration/Services.yaml**

```yaml
services:
  _defaults:
    autowire: true
    autoconfigure: true
    public: false

  MyVendor\MySitepackage\PageTitle\WebsiteTitleProvider:
    public: true

```

Then **flush the cache** in **Admin Tools > Maintenance > Flush TYPO3
and PHP Cache**.

Configure the new page title provider to be used in your TypoScript setup:

**EXT:my_sitepackage/Configuration/TypoScript/setup.typoscript**

```typoscript
config {
  pageTitleProviders {
    sitepackage {
      provider = MyVendor\MySitepackage\PageTitle\WebsiteTitleProvider
      before = record
      after = seo
    }
  }
}

```

The registered page title providers are called after each other in the
configured order. The first provider that returns a non-empty value is used,
the providers later in the order are ignored.

Therefore our custom provider should be loaded before `record`, the
default provider which always returns a value. If the system extension
[EXT:seo](https://extensions.typo3.org/extension/seo) is loaded the default **SEO Title** has a particular format,
you can change this by loading your custom provider before `seo`.

## Define the priority of PageTitleProviders {#define-the-priority-of-pagetitleproviders}

The priority of the providers is set by the TypoScript property
`config.pageTitleProviders`. This way an integrator is able to set
the priorities for his project and can even have conditions in place.

By default, the Core has the following setup:

```typoscript
config.pageTitleProviders {
    record {
        provider = TYPO3\CMS\Core\PageTitle\RecordPageTitleProvider
    }
}
```

The sorting of the providers is based on the `before` and
`after` parameters. If you want a provider to be handled before a
specific other provider, just set that provider in the `before`,
do the same with `after`.

If you have installed the system extension SEO, you will also get a second
provider. The configuration will be:

```typoscript
config.pageTitleProviders {
    record {
        provider = TYPO3\CMS\Core\PageTitle\RecordPageTitleProvider
    }
    seo {
        provider = TYPO3\CMS\Seo\PageTitle\SeoTitlePageTitleProvider
        before = record
    }
}
```

First the `SeoTitlePageTitleProvider` (because it will be handled before
`record`) and, if this providers did not provide a title, the
`RecordPageTitleProvider` will be checked.

You can override these settings within your own installation. You can add as
many providers as you want. Be aware that if a provider returns a non-empty
value, all provider with a lower priority will not be checked.