Guide

Installation

Mantle installs like any other WordPress plugin. A packaged release ships with its autoloader already built; a source checkout needs Composer.

Choose an installation method

Reference

Installation methods

Pick the method that matches how you obtained Mantle.
3 fields
Release zip string
Upload through Plugins → Add New → Upload Plugin. The zip already contains vendor/, so no build step is required.
Source checkout string
Clone the repository into wp-content/plugins/ and run composer install. Required for development.
Must-use plugin string
Place the plugin directory in wp-content/mu-plugins/ for site-wide activation that cannot be switched off from the Plugins screen.

Install from a release zip

  1. Download the release zip from the Releases page.
  2. In WordPress admin, go to Plugins → Add New → Upload Plugin.
  3. Upload the zip and choose Install Now, then Activate.

Activation redirects the activating user to the setup wizard. See First run.

Install from source

A source checkout has no vendor/ directory, so the Composer autoloader must be built before the plugin can boot.

Clone and build bash 
cd wp-content/plugins
git clone https://github.com/linchpin/mantle.git
cd mantle
composer install

If composer install has not run, Mantle cannot find \\Mantle\\Core\\Bootstrap and shows an admin notice instead of booting:

Error
Mantle bootstrap class not found

The plugin renders this admin notice when includes/Core/Bootstrap.php cannot be loaded. Reinstall the plugin, or run composer install in the plugin directory if you are working from a source checkout.

admin notice

Build the admin interface

The React admin dashboard is compiled into build/. A release zip ships with build/ already populated; a source checkout does not.

Terminal 
npm installnpm run build
npm run start rebuilds on change; npm run build produces the minified production bundle.

Install as a must-use plugin

Place the whole plugin directory in wp-content/mu-plugins/. WordPress does not auto-load plugins from subdirectories of mu-plugins/, so add a loader file alongside it:

php wp-content/mu-plugins/mantle-loader.php 
<?php/** * Load Mantle from the mu-plugins subdirectory. */require_once WPMU_PLUGIN_DIR . '/mantle/mantle.php';
Must-use plugins in subdirectories need an explicit require.

Verify the installation

Confirm the plugin is active and its settings schema is intact.

Verify bash 
wp plugin list --name=mantle --field=status
wp mantle settings audit
active
Option: mantle
Schema keys: 102
Saved keys: 102
Missing schema keys: 0
Orphaned saved keys: 0

Success: Settings audit passed. Saved keys match the registered schema.

The key count reflects the schema registered by whichever modules are present, so it grows if you add modules that register their own settings. What matters is that Missing schema keys and Orphaned saved keys are both 0. See wp mantle settings audit for the flags that repair a mismatch.

Next steps

Was this helpful?