Personal tools
Namespaces

Variants
Actions

How To Update WHMCS Module

From ModulesGarden Wiki
Revision as of 13:03, 23 November 2017 by Joanna (Talk | contribs)

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 system 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 module's settings.

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

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

7. Remove all files from '\your_whmcs\template_c\' directory.
8. (Addon Modules Only) Log in to your WHMCS system admin area.

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

Additional Instructions

It may happen, that after the update of a module, additional steps still have to be taken in order the module function properly.

If so, we advice to check the module's wiki article and check whether additional actions are needed.

Especially look for:
1. Folders which need specific write permissions (chmods).
2. Earlier settings of chmods which got overwritten.
3. New cron job added or old cron job removed.
4. Use of migration tool needed to import settings from earlier 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.

In case of failure, return to the previous version of the module and report a problem.


Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community