Skip to content

Add warning for header_register_callback usage #5760

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jordikroon merged 4 commits into from
Aug 14, 2026
+8 −0
Merged

Add warning for header_register_callback usage #5760

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e399d96
Add warning for header_register_callback usage
beryllium Aug 13, 2026
90b77fd
Update to use simplepara and depersonalized wording
beryllium Aug 13, 2026
c730762
Fix XML tag from simplepara to simpara
beryllium Aug 13, 2026
4ce98bc
Clarify warning about callback registration behavior
beryllium Aug 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions reference/network/functions/header-register-callback.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@
headers to be sent, and before any other output is sent, creating a window
to manipulate the outgoing headers before being sent.
</para>
<warning>
<simpara>
Callbacks are not stacked. Subsequent calls to <function>header_register_callback</function>
will silently de-register any existing <parameter>callback</parameter>, regardless of where
it was set. Be aware that dependencies may overwrite the callback.
Troubleshooting this scenario can be difficult.
</simpara>
</warning>
</refsect1>

<refsect1 role="parameters">
Expand Down