Skip to content

Commit

Permalink
[DOCS] Clarify switch to options.hideModules user TSconfig option
Browse files Browse the repository at this point in the history
While introducing the new module registration API,
the previously used page TSconfig options to hide
modules has been replaced by an extended user TSconfig
option. This change (page TSconfig -> user TSconfig)
is now clarified in the corresponding changelog.

Resolves: #103627
Releases: main, 12.4
Change-Id: Ic701cf0674c8ff1ed18273ad2629b2217947f7c9
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83812
Reviewed-by: Garvin Hicking <gh@faktor-e.de>
Reviewed-by: Lina Wolf <112@linawolf.de>
Tested-by: Josef Glatz <typo3@josefglatz.at>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Garvin Hicking <gh@faktor-e.de>
Reviewed-by: Josef Glatz <typo3@josefglatz.at>
Tested-by: Lina Wolf <112@linawolf.de>
  • Loading branch information
o-ba authored and linawolf committed Apr 16, 2024
1 parent 05fb034 commit e15c44e
Showing 1 changed file with 18 additions and 6 deletions.
Expand Up @@ -26,10 +26,10 @@ Therefore, the :php:`$GLOBALS['TBE_MODULES_EXT']` has been removed, while the
corresponding :php:`ExtensionManagementUtility::insertModuleFunction()` API
method has no effect.

The related TSconfig options :typoscript:`mod.web_info.menu.function`
The related page TSconfig options :typoscript:`mod.web_info.menu.function`
as well as :typoscript:`mod.web_ts.menu.function` have been removed in favor
of the existing :typoscript:`hideModules` option and the module access logic,
which due to the new registration, now also covers those modules.
of the existing :typoscript:`hideModules` user TSconfig option and the module
access logic, which due to the new registration, now also covers those modules.

Additionally, the following hooks have been removed, because their use cases
does no longer exist:
Expand All @@ -44,7 +44,7 @@ The global :php:`TBE_MODULES_EXT` array does no longer exist and the
:php:`ExtensionManagementUtility::insertModuleFunction()` API method no
longer has any effect.

The TSconfig options :typoscript:`mod.web_info.menu.function`
The page TSconfig options :typoscript:`mod.web_info.menu.function`
and :typoscript:`mod.web_ts.menu.function` are no longer evaluated.

Using one of mentioned, :php:`TypoScriptTemplateModuleController` related
Expand All @@ -57,7 +57,7 @@ All installations using the global :php:`TBE_MODULES_EXT` array or
calling :php:`ExtensionManagementUtility::insertModuleFunction()` in
custom extension code.

All installations using one of the removed TSconfig options or one
All installations using one of the removed page TSconfig options or one
of the removed hooks.

Migration
Expand Down Expand Up @@ -96,17 +96,29 @@ Will now be registered in :file:`Configuration/Backend/Modules.php`:
],
],
To hide a "third-level" module in the doc header menu, use the
To hide a "third-level" module in the doc header menu, use the user TSconfig
:typoscript:`options.hideModules` option:

.. code-block:: typoscript
:caption: **Page** TSconfig
# before
mod.web_info.menu.function.TYPO3\CMS\Info\Controller\TranslationStatusController = 0
.. code-block:: typoscript
:caption: **User** TSconfig
# after
options.hideModules := addToList(web_info_translations)
.. note::

While the previously used TSconfig options `mod.*.menu.function` are bound
to a page is the new `options.hideModules` option based on user and user
group level. This allows greater influence and furthermore allows to hide
any module, even if the module is not connected to a page.

Additionally, use the module access logic to restrict access to those modules.

Remove any registration of the mentioned hooks. There is no direct migration,
Expand Down

0 comments on commit e15c44e

Please sign in to comment.