TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:09 +02:00
commit af8cc155b5
6818 changed files with 642608 additions and 0 deletions
@@ -0,0 +1,59 @@
+.. include:: /Includes.rst.txt
+
+.. _feature-99048-1668081533:
+
+========================================
+Feature: #99048 - Site settings read API
+========================================
+
+See :issue:`99048`
+
+Description
+===========
+
+Settings for site-specific functionality can now be retrieved by a dedicated
+:php:`\TYPO3\CMS\Core\Site\Entity\SiteSettings` object, accessible via a
+:php:`\TYPO3\CMS\Core\Site\Entity\Site` object like :php:`$site->getSettings()`.
+
+Settings can be used in custom frontend code to deliver features which might
+vary per-site for extensions.
+
+
+Impact
+======
+
+Accessing site settings, which was previously possible via:
+
+:php:`$site->getConfiguration()['settings']['redirects'] ?? []`
+
+in custom PHP code, is now easier via the :php:`SiteSettings` PHP object.
+
+The :php:`SiteSettings` object can be used to access settings either by
+the dot notation ("flat", a default value can be given as optional second
+argument), e.g.:
+
+..  code-block:: php
+
+    $redirectStatusCode = (int)$siteSettings->get('redirects.httpStatusCode', 307);
+
+or by accessing all options for a certain group:
+
+..  code-block:: php
+
+    $allSettingsRelatedToRedirects = $siteSettings->get('redirects');
+
+or even fetching all settings:
+
+..  code-block:: php
+
+    $allSettings = $siteSettings->all();
+
+In addition, settings can now be accessed in TypoScript via :typoscript:`getData`
+with the key :typoscript:`siteSettings`:
+
+..  code-block:: typoscript
+
+    page.10 = TEXT
+    page.10.data = siteSettings:redirects.httpStatusCode
+
+.. index:: PHP-API, TypoScript ext:core