smoolabs/wordpress-plugin-updater

A library for WordPress plugins, to utilize license verification and auto-updating using WordPress License Server.

wordpress-plugin-updater

The WordPress Plugin Integration for the WordPress License Server., _(*1)

Usage

There's two ways you can integrate this and enable automatic updates for your own plugin., _(*2)

Using Composer

If you're already using Composer, you'll know what to do., _(*3)

If not, you'll need to install Composer on your computer and run composer init. This will initialize composer in your packages root., _(*4)

Once that is complete, run this:, _(*5)

composer require smoolabs/wordpress-plugin-updater

Composer will then install the integration into the vendor/ folder., _(*6)

To include the plugin files now, simply include the vendor/autoload.php file., _(*7)

<?php

require_once 'vendor/autoload.php';

Without Composer

Download this repository as a .zip file and extract it somewhere into your plugin files. Then just include the loader.php file., _(*8)

<?php

require_once '/path/to/updater/loader.php';

Setup

There's only one thing you'll need to do, to enable the integration once you've included it into your project., _(*9)

In your plugins main file, paste this code:, _(*10)

$client = \Smoolabs\WPU\V4\WPLSController::initClient('http://url-to-wpls.com', array(
    'name'      => 'Example Plugin Name',
    'version'   => '1.0.0',
    'path'      => __FILE__,
    'slug'      => 'example-plugin-slug'
));

Now, replace Example Plugin Name with your plugins name, http://update-server-url.com with the URL where you hosted the update server, my-example-plugin with your plugin slug (for example the plugin folders name) and 1.0.0 with your current plugins version., _(*11)

That's all you have to do! The plugin will now receive automatic updates once you make them available on your server (of course, only if the user supplied a license)!, _(*12)

Disabling functionality until License is entered

You may want to stop your buyers from using your plugin until they have entered their licenses. You can easily disable functionality like this:, _(*13)

// Your Updater instance
$client = \Smoolabs\...;

if ($client->isActivated()) {
  /* 
   * The User has activated the plugin.
   * Add your plugin functionality here.
   */
} else {
  /* 
   * The User has *NOT* activated the plugin.
   * Add activation messages etc here, for example on your plugin settings page.
   */
}

Please make sure that this complies with Envato's rules on locking fieatures behind licenses! The plugin may not be accepted otherwise., _(*14)