Review 13.4 Merged

90013[BUGFIX] Add missing page type to settings

Benjamin Franzke CR +2 V +2 Normal +203 −12 updated 07/08/25, 08:01

Commit message

During the initial development of the settings API we had a set of
must-haves defined. This included the page type as we set the goal
to have a better user experience configuring the system for the
integrator. This was defined as an essential part of driving adoption.

Due to time constraints, and lack of development power this did not
make it into the initial release of the LTS version – as more important
issues needed to be handled before the release.

The lack of this type raised huge UX and DX issues, as for example
the pagetree is not visible anymore to hover over nodes since
the settings editor is running without the context of a pagetree
that existed in the constant editor. On the DX side, we can
only declare integers and still have no idea when fetching the
setting what the meaning for this value is. One of the essential
points the settings API was introduced to solve.

For that reason we are extending the setting types with an
additional page type, and also move it to the current stable LTS.
Even this is released after the LTS version we feel that the
benefits will help users better optimize and utilize the
settings for their projects, in addition to help moving forward
to v14 once it is released as developers need to have the option
to make their settings work on 2 major versions.

This type currently implements a page browser to allow the user to
select a page for a specific setting, while still displaying the UID
in the field. The user can now simply select a page instead of
having to remember the page UID as before.

This behavior will degrade gracefully when the type is used
outside of the backend scope and for example is for some
reason used in the "install tool" context. It will simply
not render the page browser as intended and fallback to its
underlying integer storage.

Usage Example:

  plugin.my_plugin.settings.storagePid:
    category: myplugin
    type: page
    default: 0

We are aware that this is still not the final form of this type.
There are still issues to be solved, like making the Reference-Index
aware of these references to, for example, block pages from
deletion when they are referenced in the settings, to avoid
misconfiguration.

With that in mind, this is something we are not yet sure how to
solve, and we felt it was too intrusive for now to pursue —
it needs more thought. For now, we are only implementing the meaning
for the DX and the convenience for the UX.

Review

  • Code review CR +2 Done
    • Benjamin Franzke +2
  • Verified V +2 Done
    • Benjamin Franzke +2
    • core-ci +1 CI

Issues 1

Files 11

Review log 45

  1. Benjamin Franzke commented on patch set 1 07/08/25, 07:48

    Cherry Picked from branch main.
  2. Benjamin Franzke marked it work in progress 07/08/25, 07:48

  3. Benjamin Franzke commented on patch set 1 CR +2 V +2 07/08/25, 07:54

    This change is ready for review.
  4. core-ci voted on patch set 1 V +1 07/08/25, 07:59 Core CI is happy: https://git.typo3.org/typo3/CI/cms/-/pipelines/81464

  5. Benjamin Franzke merged patch set 2 07/08/25, 08:01