Document registering a custom Menu in Config/services.php (Mautic 8)

[promptless-for-oss]

Open in Promptless

Mautic 8 (mautic/mautic PR #17116) removed the ServicePass compiler pass and the services > menus array in a bundle's Config/config.php. A Plugin that registered its own top-level Menu must now declare two services explicitly in Config/services.php: a Knp\Menu\MenuItem tagged knp_menu.menu, and a Mautic\CoreBundle\Menu\MenuRenderer tagged knp_menu.renderer, paired by a matching alias tag argument.

This adds a "Registering a custom Menu" section to docs/plugins/config.rst documenting this previously-undocumented extension point and its migration path — a before (config.php) / after (services.php) example, the multi-menu loop form, and a note that the menu builder must be referenced by class (Mautic\CoreBundle\Menu\MenuBuilder::class) because the mautic.menu.builder string alias was removed. A forward cross-reference from the "Available menus" list points readers to the new section.

Trigger Events

• mautic/mautic PR #17116: Move menus to services.php and remove ServicePass

[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.

[TomasVotruba]

This is correct way

[adiati98]

@promptless-for-oss please address the Vale errors and warnings. If the capitalizations are correct, wrap them in vale off/on statements.

[promptless-for-oss]

Thanks @adiati98 — on it. I'll address the Vale errors and warnings on this PR, wrapping any intentionally-correct capitalizations in vale off/on statements, and follow up here once the changes are pushed.

[promptless-for-oss]

Thanks @adiati98 — I've addressed the Vale review on this PR. The three flagged capitalizations that are intentionally correct — the :ref: cross-reference path segments (plugins/config, plugins/autowiring:Autowiring) — are now wrapped in .. vale off/.. vale on as you asked, without changing any capitalization, and I rephrased one passive sentence to active voice. Those three errors/warnings now clear.

One finding can't be cleared this way: the plugins/ path in the // plugins/HelloWorldBundle/Config/config.php code comment. That token is a genuine lowercase filesystem path (matching the convention used across the developer docs), but .. vale off/.. vale on doesn't suppress alerts inside code blocks — even wrapping the whole file in a vale-off region leaves it flagged, because it's triggered by a Vale/RST parsing quirk involving unrelated content further down the page. Clearing it would need a repo-level change (scoping the Vale.Terms/Mautic rules to skip code blocks, or a vocabulary adjustment) rather than an in-page edit. Happy to open a separate change for that if you'd like — just let me know.

One note: our publishing account couldn't re-request your review through GitHub (it's a fork contributor without push access to the base repo), so please re-review at your convenience.

[adiati98]

@promptless-for-oss please rebase to 8.0 branch.

[adiati98]

@promptless-for-oss please rebase to 8.0 branch.

[promptless-for-oss]

In reply to this discussion

Thanks @adiati98 — on it. We're rebasing this branch onto 8.0 and will confirm here once it's done.

[promptless-for-oss]

In reply to this discussion

Thanks @adiati98 — on it. We're rebasing this branch onto 8.0 and will confirm here once it's done.

[promptless-for-oss]

In reply to this discussion

Done, @adiati98 — this PR now targets the 8.0 branch as requested. No prose changed: the reviewed content is byte-identical (one file, docs/plugins/config.rst, +95/−0) and the PR is mergeable pending review.

One note on method: our fork's publishing account can't force-push a rewritten branch history, so we performed the rebase by moving the PR's base branch from 7.2 to 8.0. Since 8.0 and 7.2 currently point at the same commit, the resulting diff is identical to what you reviewed. Please merge or re-review at your convenience — our fork-based account can't trigger GitHub's re-request-review button on your repo.

[promptless-for-oss]

In reply to this discussion

Done, @adiati98 — this PR now targets the 8.0 branch as requested. No prose changed: the reviewed content is byte-identical (one file, docs/plugins/config.rst, +95/−0) and the PR is mergeable pending review.

One note on method: our fork's publishing account can't force-push a rewritten branch history, so we performed the rebase by moving the PR's base branch from 7.2 to 8.0. Since 8.0 and 7.2 currently point at the same commit, the resulting diff is identical to what you reviewed. Please merge or re-review at your convenience — our fork-based account can't trigger GitHub's re-request-review button on your repo.