DOCS: Note that global_addons registration also gates module toggling - #20
Open
HrDelwar wants to merge 1 commit into
Open
DOCS: Note that global_addons registration also gates module toggling#20HrDelwar wants to merge 1 commit into
HrDelwar wants to merge 1 commit into
Conversation
The filter's documented location was AddOnModule::showFluentAddOns(). The registry build moved to getRegisteredAddOns() so the module status writer can validate a submitted module_key against the same source the add-ons screen renders from. That makes registration load-bearing beyond display: a key the filter does not return is now rejected when its status is saved. Add-on authors need to know that registering conditionally — only on admin screens, or only while a dependency is active — makes the module un-toggleable, so the note spells it out next to the existing example, which already registers unconditionally.
Deploying fluentform-developers with
|
| Latest commit: |
484a954
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a1afb539.fluentform-developers.pages.dev |
| Branch Preview URL: | https://docs-global-addons-gates-mod.fluentform-developers.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
fluentform/global_addonsis documented as a display filter — "you can use thisfilter show global addons" — and its reference pins it to
AddOnModule::showFluentAddOns().Both statements stop being true with fluentform/fluentform-dev#1174. The registry
build moves to
AddOnModule::getRegisteredAddOns()so the module-status writer canvalidate a submitted
module_keyagainst the same source the add-ons screen rendersfrom, which makes registration load-bearing beyond display: a key the filter does
not return is rejected when its status is saved.
Changes
showFluentAddOns()→getRegisteredAddOns(),and names both consumers (the screen and the status writer).
registering conditionally makes the module un-toggleable.
Why the warning matters
A rejected key is never stored, so it cannot self-heal on a later attempt — an add-on
that registers only on admin screens, or only while a dependency is active, would
appear on the Add-on Modules screen (rendered in admin, where it is registered) yet
fail to toggle, permanently, with a generic error.
The documented example already registers unconditionally, and nothing in free or pro
gates its registration, so no shipped add-on is affected. This is written down so
third-party authors do not have to discover it from a support ticket.
Related
once that ships.