UM Extended - Docs

Create Extensions

We've created a plugin um-wpcli that integrates WP-CLIopen in new window for our custom commands to test & scaffold new Ultimate Member extensions. This tool will help you create extensions from scratch following our plugin file & directory structures and follow best practices with PHP(PSR4) & WordPress Coding Standards.

Installation

Prerequisites

UM Extended plugin can be cloned with:

gh repo clone ultimatemember/Extended

curl -d '' https://github.com/ultimatemember/Extended.git

wp plugin install https://github.com/ultimatemember/Extended/archive/refs/heads/main.zip --force

Clone in the Plugins Directory

We recommend that you clone the plugin into /wp-content/plugins/ directory. This is how we develop our plugins. This allows us to test plugins directly on our local WordPress site and commits our changes to the repository.

Install Dependencies

Once the plugin has been cloned & extracted, run the following command within the extended directory /wp-content/plugins/Extended/:

composer install

Activate the Plugin

Activate the Extended plugin via the Plugins manager or via WP-CLI with:

wp plugin activate Extended

and run the Scaffold commands below.

Scaffold

UM Extended plugin has a um-wpcli extension that integrates WP-CLI to help you in creating and testing extensions. You can create a new extension with:

wp um dev scaffold robert

the generated file structure should look like this:

Extended/src/
├─ um-robert
│  ├─ src
│  │  └─ Core.php
│  │  └─ Enqueue.php
│  ├─ assets
│  │  └─ frontend/js/
│  │  └─ frontend/css/
│  │  └─ frontend/images/
│  │  └─ admin/js/
│  │  └─ admin/css/
│  │  └─ admin/images/
│  └─ um-robert.php
│  └─ composer.json

Once the extension has been generated, you must run composer update in the Extended directory to autoload and register the namespace & source directory of the new extension.