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)
 
(10 intermediate revisions by one user not shown)
Line 2: Line 2:
 
<meta name="description" content="We Will Guide You Step By Step And Show You How To Successfully Update Any WHMCS Module Designed By ModulesGarden."></meta>
 
<meta name="description" content="We Will Guide You Step By Step And Show You How To Successfully Update Any WHMCS Module Designed By ModulesGarden."></meta>
  
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!<br/>
+
=WHMCS Module Update Process=
−
We are sorry for the inconvenience caused.</h4>
+
  
 
{|
 
{|
Line 11: Line 10:
 
Carefully review the entire guide before proceeding to avoid potential complications.
 
Carefully review the entire guide before proceeding to avoid potential complications.
 
|}
 
|}
 +
 +
==Updating Major Versions==
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|'''Important notes on updating across major versions'''<br/>
 +
When updating a module across major versions ''(for example, from 1.2.x to 1.4.x)'', it is strongly recommended to perform the update '''step by step''', moving through each major module version.<br/>
 +
For example:
 +
* First update to the latest available 1.3.x version
 +
* Then update to the latest available 1.4.x version <br/> '''''Note:''' <code>x</code> refers to the latest release within given version (e.g., 1.3.4, 1.4.2, etc.).''
 +
 +
Skipping major versions may lead to issues such as missing updates, errors during installation, or compatibility problems.
 +
 +
Before updating to each version, make sure that the module version you are moving to is compatible with your current:
 +
* WHMCS version
 +
* PHP version
 +
* IonCube Loader version
 +
 +
'''If the module requires a newer version of WHMCS, PHP, or IonCube than the one you are using, be sure to upgrade them before proceeding.'''
 +
|}
 +
 
==Update Process==
 
==Update Process==
 
{|
 
{|
Line 16: Line 34:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|1. '''Backup your WHMSC installation'''
+
|style="padding: 0px 0px 15px 15px;"|1. '''Backup your WHMCS 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 52:
 
|}
 
|}
 
{|
 
{|
−
|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 65:
 
{|
 
{|
 
|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.  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|8. '''Activate the updated module:'''
+
|style="padding: 0px 0px 15px 15px;"|8. '''Deactivate and reactivate the updated module:'''
 
* Log in to the WHMCS admin area.
 
* Log in to the WHMCS admin area.
 
* Navigate to '' 'System Settings' → 'Addon Modules' '' and locate the updated module.
 
* Navigate to '' 'System Settings' → 'Addon Modules' '' and locate the updated module.
−
* Click the '''Activate''' button to enable the module.
+
* Click the '''Deactivate''' button to disable the module.
 +
* Click the '''Activate''' button to enable the module again.
 
|}
 
|}
 
{|
 
{|
Line 72: Line 91:
 
* '''Check available product versions''' for updates:   
 
* '''Check available product versions''' for updates:   
 
   
 
   
−
   php cron.php module upgrade list   
+
   php cron.php upgrade list   
  
 
* '''Run an upgrade to a specified version''' (replace <version> with target version number):
 
* '''Run an upgrade to a specified version''' (replace <version> with target version number):
  
−
   php cron.php module upgrade run <version>   
+
   php cron.php upgrade run <version>   
 
''for example:''  
 
''for example:''  
−
   php cron.php module upgrade run 3.5.0  
+
   php -q /.../whmcs/modules/addons/WordressManager/cron/cron.php upgrade run 3.0.0  
  
 
* '''Activate the module''' (triggers module logic without affecting WHMCS activation):  
 
* '''Activate the module''' (triggers module logic without affecting WHMCS activation):  
  
−
   php cron.php module activate   
+
   php cron.php activate   
  
 
* '''Deactivate the module''' (triggers module logic without affecting WHMCS activation):
 
* '''Deactivate the module''' (triggers module logic without affecting WHMCS activation):
  
−
   php cron.php module deactivate  
+
   php cron.php deactivate  
  
 
* '''Deactivate the module''' and '''remove database tables''' (irreversible action, permanently deletes module-related tables):
 
* '''Deactivate the module''' and '''remove database tables''' (irreversible action, permanently deletes module-related tables):
  
−
   php cron.php module deactivate --remove-database-tables  
+
   php cron.php deactivate --remove-database-tables  
 
|}
 
|}
 
<!--
 
<!--

Latest revision as of 09:05, 13 August 2025

Contents

[edit] WHMCS Module Update Process

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.

[edit] Updating Major Versions

Important notes on updating across major versions

When updating a module across major versions (for example, from 1.2.x to 1.4.x), it is strongly recommended to perform the update step by step, moving through each major module version.
For example:

  • First update to the latest available 1.3.x version
  • Then update to the latest available 1.4.x version
    Note: x refers to the latest release within given version (e.g., 1.3.4, 1.4.2, etc.).

Skipping major versions may lead to issues such as missing updates, errors during installation, or compatibility problems.

Before updating to each version, make sure that the module version you are moving to is compatible with your current:

  • WHMCS version
  • PHP version
  • IonCube Loader version

If the module requires a newer version of WHMCS, PHP, or IonCube than the one you are using, be sure to upgrade them before proceeding.

[edit] Update Process

To successfully update a module, follow these steps:
1. Backup your WHMCS 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. Deactivate and reactivate the updated module:
  • Log in to the WHMCS admin area.
  • Navigate to 'System Settings' → 'Addon Modules' and locate the updated module.
  • Click the Deactivate button to disable the module.
  • Click the Activate button to enable the module again.
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.

[edit] 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 upgrade list
  • Run an upgrade to a specified version (replace <version> with target version number): 
 php cron.php upgrade run <version>

for example: 

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

[edit] 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=77192"
Navigation
WHMCS Modules
WHMCS Widgets
Tools And Applications
Translations
General
FAQ
Community