Skip to main content

Developer Documentation

This guide provides developers with everything needed to integrate with, extend, or develop addons for Ultimate Multisite. Ultimate Multisite transforms a WordPress Multisite network into a Website-as-a-Service (WaaS) platform.

What's Available​

  • REST API — Complete CRUD operations for all entities (customers, sites, memberships, payments, products, domains) with API key authentication
  • Hooks Reference — 200+ action hooks and 280+ filter hooks for lifecycle events and customization
  • Integration Guide — Examples for CRM integration, analytics, custom gateways, and webhooks
  • Code Examples — Advanced patterns for dynamic pricing, site provisioning, custom limitations, and multi-gateway processing
  • Addon Development — Structured framework for building addon plugins

Requirements​

  • WordPress Multisite installation
  • PHP 7.4 or higher
  • Ultimate Multisite plugin activated

Composer / Bedrock Installation​

Ultimate Multisite is available on Packagist as ultimate-multisite/ultimate-multisite. This is the recommended installation method for Bedrock-based WordPress setups and other Composer-managed environments.

composer require ultimate-multisite/ultimate-multisite
Renamed package (v2.6.1+)

The Composer package was renamed from devstone/ultimate-multisite to ultimate-multisite/ultimate-multisite in v2.6.1. If your composer.json references the old vendor name, update the require entry and run composer update.

After installation, network-activate the plugin from the Network Admin:

wp plugin activate ultimate-multisite --network

Or, if you are loading the plugin as a must-use plugin via Bedrock's autoloader, use the wp_ultimo_skip_network_active_check filter to bypass the activation guard:

add_filter( 'wp_ultimo_skip_network_active_check', '__return_true' );

Quick Start​

Use the REST API​

curl -u "api_key:api_secret" https://yoursite.com/wp-json/wu/v2/customers

Hook into Events​

add_action('wu_customer_post_create', function($customer) {
    // React to new customer signups
});

Build an Addon​

# Generate addon scaffold from the template
bash create-addon.sh

See each section for detailed documentation and examples.