Key plugin install/update event subscribers on the event class (Mautic 8)

[promptless-for-oss]

Open in Promptless

Since Mautic 8, PluginBundle dispatches its events using the Symfony 4.3 style, where the event object's class name is the event name. The plugin install and update subscriber example in docs/plugins/installation.rst now keys getSubscribedEvents() on PluginInstallEvent::class and PluginUpdateEvent::class instead of the PluginEvents::ON_PLUGIN_INSTALL and PluginEvents::ON_PLUGIN_UPDATE string constants, and drops the now-unused PluginEvents import. A version-aware note explains that Mautic dispatches these events by the event object alone (Symfony 4.3 style).

---

Review feedback applied (maintainer @escopecz on this PR):

• "No need to say this. The constants will be removed too and they do nothing when used." — applied: removed the claim that the PluginEvents constants remain defined but unused.
• "No need to mention the silent failure. The constants will be removed." — applied: removed the silent-failure explanation entirely.
• "Drop 'Only PluginBundle event dispatch changed in Mautic 8. Event families that still dispatch by a string constant should keep keying subscribers on that constant.' As all the events are updated the same way." — applied verbatim: removed both sentences from the version-aware note, leaving only "Mautic dispatches these events by the event object alone, so the event's class name serves as the event name. This matches the Symfony 4.3 dispatch style."

Trigger Events

• GitHub PR mautic/mautic#17162: Dispatch PluginBundle events by class name (Symfony 4.3 style)

[promptless-for-oss]

I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed.

[promptless-for-oss]

Thanks @escopecz — noted. Since the PluginEvents constants are being removed too and do nothing when used, I'll revise this PR so it no longer describes them as still-defined-but-unused, and push an update here shortly.

[promptless-for-oss]

Update: confirmed against #17162 — I'm dropping both the "constants remain defined but unused" and the "silent failure" points from the note, keeping the Symfony 4.3 explanation and the guidance for event families that still dispatch by string constant. Revising the PR now.

[promptless-for-oss]

@escopecz both comments are addressed. The note in docs/plugins/installation.rst no longer says the PluginEvents constants remain defined-but-unused and no longer mentions silent listener failure. It now explains only that Mautic 8 dispatches these events by the event object (Symfony 4.3 style), scopes that to PluginBundle, and keeps the guidance that event families still dispatching by a string constant should keep keying on that constant. Pushed to this PR; Vale passes on the edited file.

[promptless-for-oss]

Thanks @escopecz — got it. I'll drop that sentence about PluginBundle being the only event dispatch that changed, since all the events are being updated the same way, and update this PR shortly.

[promptless-for-oss]

Done @escopecz — the version-aware note in docs/plugins/installation.rst no longer includes the "Only PluginBundle event dispatch changed in Mautic 8…" scoping sentences. Since all Mautic events are being migrated to the Symfony 4.3 dispatch-by-class style the same way, the note now simply states that Mautic dispatches these events by the event object alone. The change is live on this PR branch.

[promptless-for-oss]

I noticed that some CI checks failed for this PR. I'm investigating whether the failures are caused by this suggestion. If they're unrelated or pre-existing, I'll leave this suggestion unchanged and create a separate suggestion if a standalone docs fix is needed.

[escopecz]

Good 👍

The base branch was changed.