How To Update WHMCS Module

From ModulesGarden Wiki
Jump to: navigation, search

This article will help you go through the process of updating any WHMCS module.

Follow the steps presented below to complete a basic module's update.
Additionally, you can view the list of additional actions that might be required to conduct the update mechanism properly.

Update Instructions

1. In the beginning, please make a backup of your WHMCS files and database.
2. Addon Modules Only: Log in to your WHMCS admin area.

Go to 'Settings' 'Addon Modules' and deactivate the module you wish to update.
Note: This step is recommended but skip it if you want to keep your current module's settings.

3. Download the latest version of the module from our website.
4. Remove all files of the previous module's version (except the license.php file).
5. Upload and extract the new files into your WHMCS root directory. They will overwrite the old files.
6. Proceed to the module's location and remove the 'license.php' file.

Now, rename 'license_RENAME.php' to 'license.php' file and edit it by providing your module's license.
Note: This step is mandatory only in a few cases, due to the changes in the packaging system.

7. Remove all files from the '\your_whmcs\template_c\' directory.

Note: This will remove cache, which will prevent WHMCS from storing obsolete parts of the module and read the new version.

8. Addon Modules Only: Log in to your WHMCS admin area.

Go to 'Settings' 'Addon Modules' and activate the recently updated module.

Once these instructions are carried out, your module should be updated correctly.

Otherwise, please refer to the additional steps described below.

Additional Guidance

It may happen that after the update of a module, additional steps still have to be taken in order to ensure its proper functioning.

If so, we advise you to check the module's documentation and see whether some specific actions are needed.

In particular, search for the following elements:
1. Folders which need specific write permissions (chmods).
2. Previous settings of chmods which were overwritten.
3. Either a new cron job added or an old one removed.
4. The use of the migration tool needed to import the settings from a previous version.
5. Settings removed during the update.
6. Integration codes that need to be changed after the update.
7. Additional steps listed in the installation instruction.
8. If you upgraded your WHMCS server from the PHP 5.x to PHP 7.x version, make sure that the uploaded module's package supports the correct PHP version as well.

In case of failure, return to the previous version of the module and contact us.
Personal tools

WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions