Guide

Getting started

Install Mantle, complete the setup wizard, and switch on the modules a site needs. Budget about fifteen minutes for a first installation on a staging site.

  1. Install the plugin

    Upload a release zip, or clone the repository and run composer install to build the autoloader. See Installation.

  2. Activate

    Activation records the activating user and redirects them to the setup wizard at admin.php?page=mantle&view=setup.

  3. Complete setup

    Work through the wizard to connect the site and record client details. See First run.

  4. Enable modules

    Turn on the functional modules the site needs. Only enabled modules register REST routes and behaviour.

  5. Verify

    Run wp mantle settings audit and confirm the saved settings match the registered schema.

In this section

  • Installation — release zip, source checkout, and must-use plugin installation.
  • Configuration — the constants Mantle reads and the settings model behind them.
  • First run — activation behaviour, the setup wizard, and enabling modules.

Before you begin

Mantle also assigns its own capabilities to roles, including a power_admin role, and removes them again on uninstall. Review the capability reference before installing on a site with customised roles.

Was this helpful?