Add documentation to hook_form_alter() and similar hooks that the data structures passed in are subject to change

Created on 5 September 2015, over 9 years ago
Updated 15 January 2025, 7 days ago

Problem/Motivation

In 🌱 [meta] Document @internal APIs both explicitly in phpdoc and implicitly in d.o documentation Active we have the following line:

Render arrays (including form arrays)
While the render and form APIs themselves are stable, the exposed data structures used to build and cache pages and forms are not. We will change these structures where necessary to make usability improvements or add features in minor versions.

And also:

Controllers
Core modules contain many route controllers that are bound to individual routes. These controllers are not part of the API of the module unless specifically marked with an @api tag on the method or class.

We should add documentation to hook_form_alter(), hook_entity_view() that also says this, so that people don't need to read the bc policy to find it out.

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

📌 Task
Status

Active

Version

11.0 🔥

Component

documentation

Created by

🇬🇧United Kingdom catch

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

Production build 0.71.5 2024