Personal tools


How To Update WHMCS Module

From ModulesGarden Wiki
(Redirected from Modules Update)
Jump to: navigation, search

Read the below article carefully as it contains crucial information on how to update any of ModuelsGarden modules for WHMCS.

Follow the steps one by one to complete successfully the module update and avoid losing data or any other unexpected issues.
You will also find here a current list of additional actions that might be required to perform the update properly.

Please read the whole article first and then go on with a safe update.

Update Instructions

1. Start with making a backup copy of your WHMCS files and database.

This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.

2. Download the latest version of the module from our client area.
3. Remove all the files of the previous module's version from the WHMCS root directory (except the license.php file).

Only in this way all the old and useless hooks will be properly deleted but the module current configuration settings will remain untouched as they are stored in the base.
Note: If you have some attachments or other files uploaded into the module and you do not want to lose them with the update, please do not delete them.

4. Upload and extract the new files into your WHMCS root directory.
5. This step is mandatory only in a few cases due to the changes in the packaging system.

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.

6. Next, move to '/your_whmcs/template_c/' directory and delete all the files that are inside it except the index.php file.

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

Important: It is strongly advised to refresh your browser's cache. Visit the target page of the module and press any of the following key combinations simultaneously.
The key combinations may vary depending on the browser or system you are using:

  • Ctrl + F5
  • Shift + F5
  • Ctrl + Shift + R
  • Command ⌘ + Shift + R (for Mac)
7. It is adviced to move to the module's documentation and confirm that there are no additional steps required in the Update Instruction section.
8. Addon Modules Only: Log in to your WHMCS admin area and proceed to the updated module addon.

Important: We do not recommend deactivating the old version of the module addon before updating the new one.
Such action is no longer required for the module addon to be successfully updated.

Once the instructions are carried out, the module update is ready and correct.

Additional Instructions

In case of some modules, for example SMS Center For WHMCS, additional steps are required.

Please move to the module's documentation page and check whether there are any specific actions required.
Review the following sections: "Installation", "Update Instructions" and "Common Problems" sections:

Search for information on:
1. Folders which need specific writing 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 the 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.
WHMCS Modules
WHMCS Translations
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions