Document Mautic 8.0 class-name dispatch for PageBundle events - #648
Open
promptless-for-oss wants to merge 4 commits into
Open
Document Mautic 8.0 class-name dispatch for PageBundle events#648promptless-for-oss wants to merge 4 commits into
promptless-for-oss wants to merge 4 commits into
Conversation
PR mautic/mautic#17203 dispatches PageDisplayEvent and TrackingEvent by their event-class name in Mautic 8.0. Update the plugin-extension and tracking-script subscriber examples to key getSubscribedEvents() on <Event>::class, and add notes explaining that a subscriber left on the old PageEvents::* constant silently stops receiving the event. Leave PAGE_ON_BUILD and PAGE_ON_TOGGLE_PUBLISH keyed on their string constants (shared PageEvent class) and note why.
adiati98
reviewed
Sep 2, 2026
Contributor
Author
|
Thanks @adiati98 — on it. I'll reword to drop 'will' (present tense instead), check the rest of the diff for the same, run Vale, and push the update to this PR shortly. |
Applies @adiati98's review comment on PR mautic#648: Mautic style avoids 'will'. Change is verb-tense only (will expose -> exposes) in docs/mauticjs_api/tracking_script.rst.
Contributor
Author
|
Done @adiati98 — reworded "This will expose..." to "This exposes..." in |
promptless-for-oss
marked this pull request as ready for review
September 2, 2026 18:03
promptless-for-oss
requested review from
a team,
adiati98 and
favour-chibueze
September 2, 2026 18:03
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
3 participants
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.
Open in Promptless
Mautic 8.0 (mautic/mautic PR #17203) dispatches several PageBundle events by their event-object class name instead of the
Mautic\PageBundle\PageEventsstring constants, following the Symfony 4.3+ convention. This updates the developer-documentation subscriber examples so plugin developers use the key form that actually fires in 8.0, and warns anyone with an existing subscriber that it must be re-keyed.plugin_extensions/landing_pages.rst: thePageDisplayEventsubscriber examples (PageSubscriber and PreferenceCenterSubscriber) now keygetSubscribedEvents()onPageDisplayEvent::class, with notes explaining that a subscriber left on the oldPageEvents::PAGE_ON_DISPLAYconstant silently stops receiving the event (Mautic raises no error). A note in the Toggle 'Available for use' section explains thatPAGE_ON_TOGGLE_PUBLISHandPAGE_ON_BUILDstay keyed on their string constants because they dispatch the sharedPageEventclass.mauticjs_api/tracking_script.rst: the TrackingSubscriber example now keys onTrackingEvent::class, with a matching note.The
PageEventsconstants remain defined for backward compatibility but are no longer used internally to dispatch these events.Trigger Events
Review feedback applied
docs/mauticjs_api/tracking_script.rst: applied verbatim. Reworded "This will expose the payload..." to "This exposes the payload..." (present-tense active voice). This was the only use of "will" anywhere in this PR's diff, so no further rewording was needed.