Skip to content

Commit 93fd6fd

Browse files
authored
[TASK] Make a list of page title providers (#6002)
preparation for TYPO3-Documentation/Changelog-To-Doc#1308 Releases: main, 13.4
1 parent 5933746 commit 93fd6fd

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

Documentation/ApiOverview/Seo/PageTitleApi.rst

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,13 @@
66
Page title API
77
==============
88

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

1313
Based on the priority of the providers, the
1414
:php:`\TYPO3\CMS\Core\PageTitle\PageTitleProviderManager` will check the
15-
providers if a title is given by the provider. It will start with the highest
16-
priority and will end with the lowest priority.
17-
18-
By default, the Core ships two providers. If you have installed
19-
:composer:`typo3/cms-seo`, the provider with the (by default) highest
20-
priority will be the :php:`\TYPO3\CMS\Seo\PageTitle\SeoTitlePageTitleProvider`.
21-
When an editor has set a value for the SEO title in the page properties of the
22-
page, this provider will provide that title to the
23-
:php:`PageTitleProviderManager`. If you have not installed the SEO system
24-
extension, the field and provider are not available.
25-
26-
The fallback provider with the lowest priority is the
27-
:php:`\TYPO3\CMS\Core\PageTitle\RecordPageTitleProvider`. When no other title is
28-
set by a provider, this provider will return the title of the page.
15+
providers if a title is given by the provider.
2916

3017
Besides the providers shipped by the Core, you can add own providers. An
3118
integrator can define the priority of the providers for his project.
@@ -38,8 +25,42 @@ integrator can define the priority of the providers for his project.
3825
.. contents:: Table of contents
3926
:local:
4027

41-
.. index:: PageTitle; Custom PageTitleProvider
28+
.. _page-title-provider-list:
29+
30+
List of page title providers shipped by the Core
31+
================================================
32+
33+
The TYPO3 Core ships the following page title providers by default, listed from
34+
highest to lowest priority.
35+
36+
.. _page-title-provider-seo:
37+
38+
SeoTitlePageTitleProvider
39+
-------------------------
40+
41+
System extension :composer:`typo3/cms-seo` ships
42+
the :php:`\TYPO3\CMS\Seo\PageTitle\SeoTitlePageTitleProvider`. It is only
43+
available if the extension is installed. It has the identifier `seo`.
4244

45+
When an editor has set a value for the SEO title in the page properties of the
46+
page, this provider will provide that title.
47+
48+
If you have not installed the SEO system
49+
extension, the field and provider are not available.
50+
51+
.. _page-title-provider-record:
52+
53+
RecordPageTitleProvider
54+
-----------------------
55+
56+
The fallback provider with the lowest priority is the
57+
:php:`\TYPO3\CMS\Core\PageTitle\RecordPageTitleProvider`. It has the identifier
58+
`record`.
59+
60+
When no other title is set by a provider, this provider will return the title
61+
of the page as defined in the page properties.
62+
63+
.. index:: PageTitle; Custom PageTitleProvider
4364
.. _page-title-provider-custom:
4465

4566
Create your own page title provider

0 commit comments

Comments
 (0)