handpressed/wp-multitenancy-boilerplate

WordPress multitenancy boilerplate configured and managed with Composer and PHP dotenv.

dev-main 2022-01-18 19:01 UTC

Requires

• php: >=7.3
• composer/installers: @stable
• johnpbloch/wordpress: @stable
• oscarotero/env: ^1.1.0
• roots/wp-password-bcrypt: 1.0.0
• vlucas/phpdotenv: ^2.4

Suggests

• wp-cli/wp-cli: @stable

MIT

• Nicholas at HandPressed

• framework
• composer
• cms
• wordpress
• boilerplate
• wpackagist
• multitenancy
• phpdotenv

README

Use Composer to configure and manage a WordPress instance (including themes and plugins) that's shared with multiple sites.

• WordPress Multitenancy Boilerplate
  • Features
  • Requirements
  • Prerequisites
  • Installation
  • Configuration
    • Themes
    • Plugins
    • Constants
  • Directory Structure
  • Adding Sites
    • Configuration
  • See Also
  • Credit

Features

• Improved directory structure
• Dependency management with Composer
• Easy WordPress configuration with environment and constants files
• Environment variables with PHP dotenv
• Enhanced security (separated web root and secure passwords with roots/wp-password-bcrypt)
• WordPress multitenancy (a single instance of WordPress core, themes and plugins serving multiple sites)

Requirements

• PHP 7.4+
• Composer

Prerequisites

Install Composer:

$ curl -sS https://getcomposer.org/installer | php && mv composer.phar /usr/local/bin/composer

Installation

$ composer create-project handpressed/wp-multitenancy-boilerplate {directory}

$ cd {directory}

Replace {directory} with the name of your new WordPress project, e.g. its domain name.

Composer will download WordPress, move it to /var/opt/wp and then symlink /var/opt/wp to web/wp (see Directory Structure).

Composer will also symlink /var/opt/wp/wp-content/themes to web/app/themes, /var/opt/wp/wp-content/plugins to web/app/plugins and /var/opt/wp/wp-content/mu-plugins to web/app/mu-plugins.

Sites can now share this single instance of WordPress.

Configuration

Open the conf/.env file and add your new site's home URL (WP_HOME) and database credentials (DB_NAME, DB_USER, DB_PASSWORD). You can also define the database $table_prefix (default is wp_) if required.

Set your site's vhost document root to /path/to/{directory}/web.

Themes

Add themes in web/app/themes as you would for a normal WordPress install.

Plugins

WordPress Packagist is already registered in the composer.json file so any plugins from the WordPress Plugin Directory can easily be required.

To add a plugin, use composer require <namespace>/<packagename> from the command-line. If it's from WordPress Packagist then the namespace is always wpackagist-plugin, e.g.:

$ composer require wpackagist-plugin/wp-optimize

Whenever you add a new plugin or update WordPress core, run composer update to install your new packages.

Themes and plugins are installed in the symlinked themes and plugins directories in /var/opt/wp/wp-content and will be available to all multitenancy sites.

Note: Some plugins may make modifications to the core wp-config.php file. Any modifications to wp-config.php that are needed by an individual site should be moved to the site's conf/wp-constants.php file.

Constants

Put custom core, theme and plugin constants in conf/wp-constants.php.

Directory Structure

├── composer.json             → Manage versions of WordPress, plugins and dependencies
├── conf                      → WordPress configuration files
│   ├── .env       	      → WordPress environment variables (WP_HOME, DB_NAME, DB_USER, DB_PASSWORD required)
│   ├── wp-constants.php      → Custom core, theme and plugin constants
│   ├── wp-env-config.php     → Primary WordPress config file (wp-config.php equivalent)
│   └── wp-salts.php          → Authentication unique keys and salts (auto generated)
├── vendor                    → Composer packages (never edit)
└── web                       → Web root (vhost document root)
    ├── app                   → wp-content equivalent
    │   ├── mu-plugins        ↔ Must-use plugins symlinked to /var/opt/wp/wp-content/mu-plugins
    │   ├── plugins           ↔ Plugins symlinked to /var/opt/wp/wp-content/plugins
    │   ├── themes            ↔ Themes symlinked to /var/opt/wp/wp-content/themes
    │   └── uploads           → Uploads
    ├── index.php             → Loads the WordPress environment and template (never edit)
    └── wp                    ↔ WordPress core symlinked to /var/opt/wp (never edit)
    	└── wp-config.php     → Required by WordPress - loads conf/wp-env-config.php (never edit)

↔ denotes a symlink.

Adding Sites

Use WP Multitenancy Add Site.

$ composer create-project handpressed/wp-multitenancy-add-site {new_directory}

$ cd {new_directory}

Replace {new_directory} with the name of your new project, e.g. its domain name.

Configuration

Open the conf/.env file and add the new site's home URL (WP_HOME) and database credentials (DB_NAME, DB_USER, DB_PASSWORD). You can also define the database $table_prefix (default is wp_) if required.

Set the new site's vhost document root to /path/to/{new_directory}/web.

Added sites will use the existing WordPress instance (including themes and plugins) in var/opt/wp.

See Also

WordPress Substratum

Credit

Based on handpressed/substratum. Inspired by roots/bedrock and wpscholar/wp-skeleton.