Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 4.74 KB

UPGRADING.md

File metadata and controls

47 lines (25 loc) · 4.74 KB
Raw

This project follows semantic versioning principles with a very minor requirement for minor releases:

  • For patch releases: e.g. 1.9.X and 1.9.Y should be entirely compatible (no code changes required) for all values of X and Y.
  • Minor releases (e.g. 1.A to 1.B) require you to update the name of the class that you instantiate. Otherise all code should remain compatible - but you should still read the notes below to understand changes made.

Upgrading from 1.8 to 1.9.

You should alter the class name that you instantiate to Updraft_Manager_Updater_1_9. The minimum PHP version required from version 1.9 onwards is PHP 5.6 or higher; therefore, if you need to still support earlier versions, then you should remain with the 1.8 series. Also, if your composer.json file was using the fork of yahniselsts/plugin-update-checker at https://github.com/DavidAnderson684/plugin-update-checker, then you should remove this, since that fork is only needed and suitable for earlier releases.

Upgrading from 1.7 to 1.8.

You should alter the class name that you instantiate to Updraft_Manager_Updater_1_8. Also, the constructor signature has altered for more future flexibility. The first three parameters (mothership URL, owner UID, relative plugin file) are the same; but all parameters after that are replaced by a single (optional) fourth parameter, $options. All options are now passed via this array via key/value pairs. The previous parameters auto_backoff, debug, interval_hours are now (optional) keys in this array. A fourth option, require_login (boolean), is also available. It defaults in 1.8.0 to true (retaining the previous behaviour), but may change in future, so set it if you have a preference. If false, then updates checks will be made even if no credentials have (yet) been provided. This will enable showing updates information (but not actual updating) even when people have not authenticated, which may motivate them to authenticate.

Upgrading from 1.6 to 1.7.

Ignore the 1.7 series; it added a new method (require_login()) that was ineffective for its purpose.

Upgrading from 1.5 to 1.6.

There are no API-breaking changes. You can use your code unmodified (beyond altering the class name that you instantiate from Updraft_Manager_Updater_1_5 to Updraft_Manager_Updater_1_6). The version bump is necessitated by a version bump in a dependency.

Upgrading from 1.4 to 1.5.

There are no API-breaking changes. You can use your code unmodified (beyond altering the class name that you instantiate from Updraft_Manager_Updater_1_4 to Updraft_Manager_Updater_1_5). The version bump is necessitated by a version bump in a dependency.

Upgrading from 1.3 to 1.4.

There are no API-breaking changes. You can use your code unmodified (beyond altering the class name that you instantiate from Updraft_Manager_Updater_1_3 to Updraft_Manager_Updater_1_4).

New feature: The udmupdater_wp_api_options filter has been added to allow easy modification of parameters to wp_remote_* calls. Note that you may also wish to use the puc_request_info_options-(slug) filter that the base updates checker class uses if you need to catch all calls.

Upgrading from 1.2 to 1.3.

There are no API-breaking changes. You can use your code unmodified (beyond altering the class name that you instantiate from Updraft_Manager_Updater_1_2 to Updraft_Manager_Updater_1_3).

New feature (on by default): The 1.3 series allows the user to opt-in to automatic updates of the plugin, using a checkbox on the "Plugins" page. If you do not wish your user to have this facility, then call the method set_allow_auto_updates(false) after instantiating the Updraft_Manager_Updater_1_3 object.

Upgrading from 1.1 to 1.2.

The 1.2 series supports installing the updater and its dependency via composer. This again means a potential change in directory structure.

In consequence, it has been necessary to bump the class version major/minor version numbers from 1.1 to 1.2. There are no API changes, but it is necessary just to alter the name of the class being accessed in your updater.php file (the file that loads the class) to Updraft_Manager_Updater_1_2.

Upgrading from 1.0 to 1.1.

The 1.1 series supports installing and updating Yahnis Elsts' PluginUpdateChecker class (which is a dependency) via composer, as well as via the previous method of manually downloading it into a "puc" sub-directory. This introduces a subtle incompatibility with older releases, affecting sites which have two or more plugins installed.

In consequence, it has been necessary to bump the class version major/minor version numbers from 1.0 to 1.1. There are no API changes, but it is necessary just to alter the name of the class being accessed in your updater.php file (the file that loads the class) from Updraft_Manager_Updater_1_0 to Updraft_Manager_Updater_1_1.