Attention
TYPO3 v10 has reached end-of-life as of April 30th 2023 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 v10 here: TYPO3 ELTS.
PHP API¶
The PHP API to retrieve page and user TSconfig in a backend module is straight forward:
use TYPO3\CMS\Backend\Utility\BackendUtility;
public function someBackendAction() {
// Retrieve user TSconfig of currently logged in user
$userTsConfig = $GLOBALS['BE_USER']->getTSConfig();
// Retrieve page TSconfig of the given page id
$pageTsConfig = BackendUtility::getPagesTSconfig($currentPageId);
}
Both methods return the entire TSconfig as a php array. The former retrieves the User TSconfig while the latter retrieves the Page TSconfig.
All imports, overrides, modifications etc are already resolved. This includes Page TSconfig overrides by User TSconfig.
Similar to other TypoScript related API methods, properties that contain sub properties return their sub properties using the property name with a trailing dot, while a single property is accessible by the property name itself. The example below gives more insight on this.
If accessing TSconfig arrays, the PHP null coalescence operator ?? is
almost always useful: TSconfig options may or not be set, accessing non-existent
array keys in PHP would thus raise PHP notice level warnings.
Combining the array access with a fallback using ?? helps when accessing these
optional array structures.
// Incoming (user) TSconfig:
// options.someToggle = 1
// options.somePartWithSubToggles = foo
// options.somePartWithSubToggles.aValue = bar
// Parsed array returned by getTSConfig(), note the dot if a property has sub keys:
// [
// 'options.' => [
// 'someToggle' => '1',
// 'somePartWithSubToggles' => 'foo',
// 'somePartWithSubToggles.' => [
// 'aValue' => 'bar',
// ],
// ],
// ],
public function someBackendAction() {
$userTsConfig = $this->getBackendUser->getTSConfig();
// Typical call to retrieve a sanitized value:
$isToggleEnabled = (bool)($userTsConfig['options.']['someToggle'] ?? false);
// Retrieve a sub set, note the dot at the end:
$subArray = $userTsConfig['options.']['somePartWithSubToggles.'] ?? [];
}