TSFE

What is TSFE?

TSFE is short for \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController, a class which exists in the system extension EXT:frontend.

As the name implies: A responsibility of TSFE is page rendering. It also handles reading from and writing to the page cache. For more details it is best to look into the source code.

There are several contexts in which the term TSFE is used:

  • PHP: It is passed as request attribute frontend.controller

  • PHP: It was and is available as global array $GLOBALS['TSFE'] in PHP.

  • TypoScript: TypoScript function TSFE which can be used to access public properties in TSFE.

The TypoScript part is covered in the TypoScript Reference: TSFE. In this section we focus on the PHP part and give an overview, in which way the TSFE class can be used.

Accessing TSFE

Attention

Some of the former public properties and methods have been changed to protected or marked as internal. Often, accessing TSFE is no longer necessary, and there are better alternatives.

Access $GLOBALS['TSFE'] directly only as a last resort, usage is strongly discouraged, if not absolutely necessary.

From the source:

When calling a frontend page, an instance of this object is available as $GLOBALS['TSFE'], even though the Core development strives to get rid of this in the future.

If access to the \TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController instance is necessary, use the request attribute frontend.controller:

$frontendController = $request->getAttribute('frontend.controller');

TSFE is not available in all contexts. In particular, it is only available in frontend contexts, not in the backend or the command line.

Initializing $GLOBALS['TSFE'] in the backend is sometimes done in code examples found online. This is not recommended. TSFE is not initialized in the backend context by the Core (and there is usually no need to do this).

From the PHP documentation:

As of PHP 8.1.0, $GLOBALS is now a read-only copy of the global symbol table. That is, global variables cannot be modified via its copy.

https://www.php.net/manual/en/reserved.variables.globals.php

Howtos

Following are some examples which use TSFE and alternatives to using TSFE, where available:

Access ContentObjectRenderer

Changed in version 13.0: This property has been marked as read-only.

Access the \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer (often referred to as "cObj"):

// !!! discouraged
$cObj = $GLOBALS['TSFE']->cObj;

Obtain TSFE from the request attribute frontend.controller:

$frontendController = $request->getAttribute('frontend.controller');
$cObj = $frontendController->cObj;

In the case of the USER content object (for example, a non-Extbase plugin) use setter injection:

EXT:my_extension/Classes/UserFunctions/MyClass.php
<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\UserFunctions;

use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;

final class MyClass
{
    /**
     * Reference to the parent (calling) cObject set from TypoScript
     */
    private ContentObjectRenderer $cObj;

    public function setContentObjectRenderer(ContentObjectRenderer $cObj): void
    {
        $this->cObj = $cObj;
    }

    // ... other methods
}

Access current page ID

Changed in version 13.0: This property has been marked as read-only.

Access the current page ID:

// !!! discouraged
$pageId = $GLOBALS['TSFE']->id;

Instead, the current page ID can be retrieved using the routing request attribute:

$pageArguments = $request->getAttribute('routing');
$pageId = $pageArguments->getPageId();

New in version 13.0.

Or, alternatively with the frontend.page.information request attribute:

$pageInformation = $request->getAttribute('frontend.page.information');
$pageId = $pageInformation->getId();

Access frontend user information

Changed in version 13.0: The variable $GLOBALS['TSFE']->fe_user has been removed with TYPO3 v13. Migration.

Get current base URL

Changed in version 13.0: The variable $GLOBALS['TSFE']->baseURL has been removed with TYPO3 v13.

Use the request object and retrieve the site attribute which holds the site configuration:

/** @var \TYPO3\CMS\Core\Site\Entity\Site $site */
$site = $request->getAttribute('site');
/** @var array $siteConfiguration */
$siteConfiguration = $site->getConfiguration();
$baseUrl = $siteConfiguration['base'];