ultraleet/wp-requirements-checker

Helper library for WordPress plugins to check for minimum PHP and WP versions.

1.1.0 2019-10-10 05:24 UTC

MIT

• Rene Aavik

README

Helper library for WordPress plugins to check for minimum PHP and WP versions.

When there's any version mismatch when your plugin is activated, the library will display notices about required versions on the admin page. It will also automatically deactivate the plugin.

This way, when unsupported PHP language features or WP functionality is used in your plugin, it won't break the site and make it difficult for the admin to fix the issues.

Since version 1.1.0, you can also add in other plugins that your plugin depends on (for instance, when creating an add-on).

Usage

There are multiple ways to use this library, depending on the way you are developing your plugin. The main ones are using Composer, and just including the library manually. You can find instructions for both of these below.

Using Composer

Require the library like so:

composer require ultraleet/wp-requirements-checker

In your main plugin file, first make sure that the Composer autoloader is included:

require_once('vendor/autoload.php');

Then, instantiate the library and check the requirements. Make sure you continue loading your plugin only when the check passes:

$requirementsChecker = new \Ultraleet\WP\RequirementsChecker(array(
    'title' => 'My WordPress Plugin Title', // Required
    'file' => __FILE__, // Required
    'php' => '7.2',
    'wp' => '4.9',
    'plugins' => array(
        'Required Plugin' => 'plugin-dir/plugin-file.php',
    ),
));

if ($requirementsChecker->passes()) {
    // Continue loading your plugin from separate files and/or classes.
}

// This should be the end of the main plugin file.

Note, that only elements with the comment 'Required' are needed for the library to work. You can pick and choose which ones of the other options you want to check for.

Using manual loading

Download the file src/RequirementsChecker.php from this repository and place it somewhere within your project tree.

Let's say you placed it in the lib directory in your plugin root. Then include the file in your main plugin file:

require_once('lib/RequirementsChecker.php');

The rest of the process is exactly the same as shown above.