[TASK] Allow sets to be excluded from site configuration GUI

[TYPO3IncTeam]

ℹ️ View this commit on Github
👥 Authored by Benjamin Franzke [email protected]
✔️ Merged by Andreas Kienast [email protected]

Commit message

[TASK] Allow sets to be excluded from site configuration GUI

Sets that are intended for code-wise structuring only and should
not be referenced by integrators via site configuration directly
can now be excluded from the site configuration GUI by marking
them as hidden.

config.yaml:
name: foo/bar
hidden: true

Integrators can additionally choose to mark external sets as
hidden via User TSConfig, e.g. in Configuration/user.tsconfig:

options.sites.hideSets := addToList(typo3/fluid-styled-content)

This might be used if only a certain subset of site sets
should be available in the backend UI.

Releases: main
Resolves: #105190
Change-Id: If7b8c9e2c2d9cb328f9bfaede2e09cab80076980
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/86407
Tested-by: core-ci [email protected]
Reviewed-by: Andreas Kienast [email protected]
Reviewed-by: Benjamin Kott [email protected]
Tested-by: Benjamin Kott [email protected]
Tested-by: Andreas Kienast [email protected]

➗ Modified files

13.1/Feature-103437-IntroduceSiteSets.rst

@@ -107,6 +107,40 @@ This setting will be exposed as site setting whenever the set
 `my-vendor/my-set` is applied to a site configuration.
 
 
+Hidden sets
+-----------
+
+Sets may be hidden from the backend set selection in
+:guilabel:`Site Management > Sites` and the console command
+:bash:`bin/typo3 site:sets:list` by adding a `hidden` flag to the
+:file:`config.yaml` definition:
+
+
+..  code-block:: yaml
+    :caption: EXT:my_extension/Configuration/Sets/MyHelperSet/config.yaml
+
+    name: my-vendor/my-helperset
+    label: A helper Set that is not visible inside the GUI
+    hidden: true
+
+
+Integrators may choose to hide existing sets from the list of available
+sets for backend users via User TSConfig, in case only a curated list of sets
+shall be selectable:
+
+..  code-block:: typoscript
+    :caption: EXT:my_extension/Configuration/user.tsconfig
+
+    options.sites.hideSets := addToList(typo3/fluid-styled-content)
+
+
+The :guilabel:`Site Management > Sites` GUI will not show hidden sets,
+but makes one exception if a hidden set has already been applied to a site
+(e.g. by manual modification of :file:`config.yaml`). In this case a set
+marked as hidden will be shown in the list of currently activated sets (that means
+it can be introspected and removed via backend UI).
+
+
 Impact
 ======