Personal tools
Namespaces

Variants
Actions

How To Update WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Framework Cron Commands)
(→‎Update Process)
Line 16: Line 16:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|1. '''Backup your WHMSC installation'''
+
|style="padding: 0px 0px 15px 15px;"|1. '''Backup your WHMSC installation:'''
 
*  Before proceeding, create a full backup of your WHMCS files and database. This step is crucial in case of an update failure or other issues.
 
*  Before proceeding, create a full backup of your WHMCS files and database. This step is crucial in case of an update failure or other issues.
 
|}
 
|}
Line 34: Line 34:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|5. '''Adjust the license file (if required)'''
+
|style="padding: 0px 0px 15px 15px;"|5. '''Adjust the license file (if required):'''
 
* In some cases, you may need to navigate to the module's folder and delete the existing <code>license.php</code> file.
 
* In some cases, you may need to navigate to the module's folder and delete the existing <code>license.php</code> file.
 
* Rename <code>license_RENAME.php</code> to <code>license.php</code> and edit it by entering your module’s license key.
 
* Rename <code>license_RENAME.php</code> to <code>license.php</code> and edit it by entering your module’s license key.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|6. '''Clear Cache'''
+
|style="padding: 0px 0px 15px 15px;"|6. '''Clear cache:'''
 
* Navigate to ''/your_whmcs/template_c/'' and delete all files except ''index.php'' to remove old cache data.
 
* Navigate to ''/your_whmcs/template_c/'' and delete all files except ''index.php'' to remove old cache data.
 
* Refresh your browser cache using one of the following key combinations:
 
* Refresh your browser cache using one of the following key combinations:
Line 47: Line 47:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|7. '''Check for additional update steps:'''
 
|style="padding: 0px 0px 15px 15px;"|7. '''Check for additional update steps:'''
−
* Some modules may require additional actions for a successful update
+
* Some modules may require additional actions for a successful update.
 
* Review the module’s [https://www.docs.modulesgarden.com documentation] for specific instructions related to file permissions, cron jobs, integration codes, or PHP version compatibility.  
 
* Review the module’s [https://www.docs.modulesgarden.com documentation] for specific instructions related to file permissions, cron jobs, integration codes, or PHP version compatibility.  
 
|}
 
|}

Revision as of 14:11, 3 March 2025

Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!
We are sorry for the inconvenience caused.

This guide provides essential instructions for updating any ModuelsGarden modules for WHMCS.

Follow the steps one by one to ensure a smooth update process while minimizing the risk of data loss or unexpected issues.
It also includes a set of cron commands that can help automate certain tasks related to module updates.

Carefully review the entire guide before proceeding to avoid potential complications.

Update Process

To successfully update a module, follow these steps:
1. Backup your WHMSC installation:
  • Before proceeding, create a full backup of your WHMCS files and database. This step is crucial in case of an update failure or other issues.
2. Download the latest version of the module from our client area.
3. Remove the old module files:
  • Navigate to your WHMCS root directory.
  • Delete all files related to the previous module version, except for the license.php file to retain the module’s configuration settings.
  • If you have custom attachments or additional files uploaded to the module, ensure you do not delete them.
4. Upload and extract the new files:
  • Upload the latest module files to your WHMCS directory.
  • Verify the module’s folder structure, as some packaging changes might have occurred.
5. Adjust the license file (if required):
  • In some cases, you may need to navigate to the module's folder and delete the existing license.php file.
  • Rename license_RENAME.php to license.php and edit it by entering your module’s license key.
6. Clear cache:
  • Navigate to /your_whmcs/template_c/ and delete all files except index.php to remove old cache data.
  • Refresh your browser cache using one of the following key combinations:
    • Windows/Linux: Ctrl + F5, Shift + F5, or Ctrl + Shift + R
    • Mac: Command ⌘ + Shift + R
7. Check for additional update steps:
  • Some modules may require additional actions for a successful update.
  • Review the module’s documentation for specific instructions related to file permissions, cron jobs, integration codes, or PHP version compatibility.
8. Activate the updated module:
  • Log in to the WHMCS admin area.
  • Navigate to 'System Settings' → 'Addon Modules' and locate the updated module.
  • Click the Activate button to enable the module.
9. Reissue the license:
  • Log in to the client area where your license is managed.
  • Navigate to Products and find the relevant license.
  • Click Reissue License to update the installation.

Module Cron Commands

The following cron commands are available for managing modules based on the new framework:
  • Check available product versions for updates: 
 php cron.php module upgrade list
  • Run an upgrade to a specified version (replace <version> with target version number): 
 php cron.php module upgrade run <version>

for example: 

 php cron.php module upgrade run 3.5.0
  • Activate the module (triggers module logic without affecting WHMCS activation): 
 php cron.php module activate
  • Deactivate the module (triggers module logic without affecting WHMCS activation): 
 php cron.php module deactivate
  • Deactivate the module and remove database tables (irreversible action, permanently deletes module-related tables): 
 php cron.php module deactivate --remove-database-tables

Conclusions

Following these steps will ensure proper module management in WHMCS. Always back up your installation before making changes, and verify the module functionality after updating.
If any issues arise, refer to your module documentation or contact our support team for assistance.
Retrieved from "https://www.docs.modulesgarden.com/index.php?title=How_To_Update_WHMCS_Module&oldid=74976"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
cPanel Modules
General
FAQ
Community