Controls visibility of non-OpenSPP navigation menus by modifying ir.ui.menu group assignments. Automatically hides predefined menus from standard Odoo modules during installation and provides UI for manual toggle. Stores original group assignments to enable reversible hide/show operations.
- Track menu visibility state and preserve original group assignments in configuration records
- Hide menus by replacing group_ids with
group_hide_menus_user(only users in this group see hidden menus) - Restore menus by reverting to original group_ids
- Auto-hide 15 predefined menus during module installation via
ir.module.module.next()hook - Manual toggle via list view with hide/show action buttons
| Model | Description |
|---|---|
spp.hide.menu |
Stores menu reference, state (show/hide), and original group_ids |
After installing, the module automatically hides menus from:
project_todo, mail, spreadsheet_dashboard, project,
mass_mailing, survey, hr, calendar, contacts,
account, event, stock, utm, fastapi, queue_job.
To manually configure:
- Navigate to Settings > Users & Companies > Hidden Menus
- Click Create to add a menu to track
- Use Hide Menu or Show Menu buttons to toggle visibility
- Menu: Settings > Users & Companies > Hidden Menus (requires Technical Features group)
| Group | Access |
|---|---|
base.group_system |
Full CRUD |
spp_hide_menus_base.group_hide_menus_user |
See menus hidden from other users (assigned via privilege system) |
- Inherit
ir.module.moduleand extendMENU_APPdictionary to add custom menus to auto-hide list - Inherit
spp.hide.menuto add custom metadata or hide/show logic
base, spp_security
Table of contents
_register_hooknow re-hides menus only after a registry load that installed or updated modules (registry.updated_modules), which is every path that can resetgroup_ids. Other loads — each HTTP and cron worker, and the job worker, reloading after another process signals a change — no longer repeat the sameir.ui.menu/spp.hide.menuwrites, which raced the upgrading process for the same rows during deploys.- Operator-facing change: hidden menus that become visible for any
reason other than a module update (for example a manual edit of a
menu's groups) are no longer re-hidden by a plain restart. Upgrade the
module (
-u spp_hide_menus_base) to re-apply hiding.
- Enforce
UNIQUE(menu_id)onspp.hide.menu: a second configuration row for the same menu madehide_menus()raiseExpected singletonfrom_register_hookand abort the registry load — a total outage (#408).hide_menus()now also reads its state off a single governing row, so a database on which the constraint could not be applied keeps working. - Ship a pre-migration that de-duplicates existing rows before the
constraint lands, preferring a row that can still restore its menu.
The surplus rows' external ids are repointed onto the surviving row
and marked
noupdate, so the seeding module's next upgrade adopts the survivor instead of recreating a duplicate, and dropping the seed later cannot garbage-collect it. - Behaviour note for module authors: installing a module that seeds an
spp.hide.menurecord for a menu that already has a configuration row now fails loudly with anIntegrityErrorinstead of silently inserting the duplicate that used to brick the next registry load. Target the existing record or drop the seed.
- Keep hidden menus hidden after a module upgrade resets their
group_idsvia XML. Re-applying now runs from_register_hookso it covers every upgrade path (immediate,base.module.upgradewizard, and CLI-u), not just the immediate path handled bynext().
- Initial migration to OpenSPP2
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
- OpenSPP.org
Current maintainers:
This module is part of the OpenSPP/OpenSPP2 project on GitHub.
You are welcome to contribute.