Document Mautic 8 class-name dispatch for Email, Point, User, API, and Category bundle events - #652
Open
promptless-for-oss wants to merge 6 commits into
Open
Conversation
…d Category bundle events Mautic 8 (mautic/mautic#17217) migrates selected bundle events from *Events string-constant dispatch to Symfony 4.3+ class-name dispatch. Update the two documented subscriber examples that reference converted events (MonitoredEmailEvent, ApiPlatformPermissionContextEvent) to key getSubscribedEvents() on EventClass::class, add migration notes and debug:event-dispatcher verification tips, and correct the blanket 'always use the event constants' advice on the Available events page.
adiati98
reviewed
Sep 2, 2026
adiati98
left a comment
Contributor
There was a problem hiding this comment.
@promptless-for-oss please address the Vale warnings.
Contributor
Author
|
Thanks @adiati98 — on it. I'll run Vale on the changed RST files, fix the flagged warnings, and push the update to this PR shortly. |
…c 8 dispatch notes Rewrites the passive constructions Vale (Google.Passive) flagged on the lines this PR changed in the Monitored Inbox and API permission-context sections. Names Mautic as the actor and the old-to-new dispatch contrast (class vs. string constant); technical meaning is unchanged.
Contributor
Author
|
Done @adiati98 — addressed the Vale warnings on the changed lines by converting the flagged passive voice to active in |
promptless-for-oss
marked this pull request as ready for review
September 2, 2026 18:00
promptless-for-oss
requested review from
a team,
adiati98 and
favour-chibueze
September 2, 2026 18:00
Replace this page's copy of the general Mautic 8 class-name event dispatch explanation with a cross-reference to the shared "Mautic 8: class-name event dispatch" section in plugins/event_listeners.rst, keeping the bundle-specific facts. Part of consolidating the duplicated note across the open Mautic 8 dev-docs PRs.
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
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 continues migrating bundle events from
*Eventsstring-constant dispatch to native Symfony 4.3+ class-name dispatch (source PR mautic/mautic#17217, following the same pattern as the already-documented Core, Report, Stage, Dashboard, and SMS bundles). For a converted event, Mautic now dispatches by the event object alone, so plugin developers must keygetSubscribedEvents()on the event class rather than the old constant. The*Eventsconstants remain defined for backward compatibility but no longer dispatch these events — a subscriber still keyed on the old constant silently stops firing, with no exception and nothing logged.This updates the two subscriber examples in the developer docs that reference a converted event —
MonitoredEmailEventin the Monitored Inbox Integration section andApiPlatformPermissionContextEventin the API permission-context event section — to key onEventClass::class, adds a migration note and abin/console debug:event-dispatcherverification tip to each, and corrects the now-inaccurate blanket "always use the event constants" guidance on the Available events page. Of the eleven events this PR converts, these are the only two currently documented with a subscriber example; the Email note also flags thatEMAIL_PRE_FETCHandEMAIL_PARSEin the same subscriber are unchanged and keep their string constants.Files touched:
docs/plugin_extensions/emails.rst,docs/plugin_extensions/api.rst,docs/plugins/event_listeners.rst.Trigger Events