README

Library to be bundled with WordPress plugins to enforce users to upgrade their PHP versions or switch to a decent host.

Installation

We recommend installing the library using Composer, as follows.

composer require wpupdatephp/wp-update-php

Another option is to download the class file manually.

Usage

Usage of this library depends on how you start your plugin. The core does_it_meet_required_php_version method does all the checking for you and adds an admin notice in case the version requirement is not met.

For example, when you start your plugin by instantiating a new object, you should wrap a conditional check around it.

Example:

$updatePhp = new WPUpdatePhp( '5.6.0' );

if ( $updatePhp->does_it_meet_required_php_version() ) {
    // Instantiate new object here
}

// The version check has failed, an admin notice has been thrown

Including the library file

Adding the library via Composer has preference. The Composer autoloader will automatically take care of preventing including two classes with the same name.

In case you want to include the file manually, please wrap the include or require call in a class_exists conditional, like so:

if ( ! class_exists( 'WPUpdatePhp' ) ) {
	// do the file include or require here
}

Setting the name of the plugin

The notice that will be thrown can also contain the name of the plugin. Use the set_plugin_name( $name ) method on the WPUpdatePhp object to provide the name. This call needs to be made before the does_it_meet_required_php_version() method is called to check versions.

License

(GPLv2 license or later)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

wpupdatephp / wp-update-php

Maintainers

Details