Personal tools
Namespaces

Variants
Actions

How To Update WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Additional Guidance)
(→‎Module Cron Commands)
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
<meta name="keywords" content="modulesgarden whmcs modules update, whmcs 5.2 addon modules, whmcs 5.2.2 addon modules, whmcs v.5.2 addon modules, whmcs v.5.2.2 addon modules, whmcs v5.2 addon modules, whmcs v5.2.2 addon modules"></meta>
+
<meta name="keywords" content="modulesgarden whmcs modules update, whmcs products update, whmcs modules update, whmcs modules download, whmcs modules version, whmcs modules upload, update instructions, update guide, whmcs modules upgrade"></meta>
−
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About Addons And Modules Update In WHMCS V5.2.2"></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>
 +
 
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|This article will help you go through the process of updating any WHMCS module.<br />
+
|style="padding: 10px 0px 30px 15px;"|This guide provides essential instructions for updating any [https://www.modulesgarden.com/products/whmcs ModuelsGarden modules for WHMCS]. <br/>
−
Follow the steps presented below to complete a basic module's update.<br />
+
Follow the steps one by one to ensure a smooth update process while minimizing the risk of data loss or unexpected issues.<br /> It also includes a set of cron commands that can help automate certain tasks related to module updates. <br/>
−
Additionally, you can view the list of additional actions that might be required to conduct the update mechanism properly.
+
 
 +
Carefully review the entire guide before proceeding to avoid potential complications.
 
|}
 
|}
−
==Update Instructions==
+
==Update Process==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''1. In the beginning, please make a backup of your WHMCS files and database.'''
+
|style="padding: 10px 0px 20px 15px;"|To successfully update a module, follow these steps:<br/>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|2. '''Addon Modules Only:''' Log in to your WHMCS admin area.<br />
+
|style="padding: 0px 0px 15px 15px;"|1. '''Backup your WHMSC installation:'''
−
Go to '' 'Settings' '' → '' 'Addon Modules' '' and deactivate the module you wish to update.<br />
+
*  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.
−
'' '''Note:''' This step is recommended but skip it if you want to keep your current module's settings.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|3. Download the latest version of the module from our website.
+
|style="padding: 0px 0px 20px 15px;"|2. '''Download the latest version of the module''' from our [https://www.modulesgarden.com/client-area/products client area].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|4. Remove all files of the previous module's version (except the license.php file).
+
|style="padding: 0px 0px 15px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|5. Upload and extract the new files into your WHMCS root directory. They will overwrite the old files.
+
|style="padding: 0px 0px 15px 15px;"|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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|6. Proceed to the module's location and remove the '' 'license.php' '' file.<br />
+
|style="padding: 0px 0px 15px 15px;"|5. '''Adjust the license file (if required):'''
−
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module's license.<br />
+
* In some cases, you may need to navigate to the module's folder and delete the existing <code>license.php</code> file.
−
'' '''Note:''' This step is mandatory only in a few cases, due to the changes in the packaging system.''
+
* 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 20px 15px;"|7. Remove all files from the '' '\your_whmcs\template_c\' '' directory.
+
|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.
 +
* Refresh your browser cache using one of the following key combinations:
 +
** Windows/Linux: <code>Ctrl + F5</code>, <code>Shift + F5</code>, or <code>Ctrl + Shift + R</code>
 +
** Mac: <code>Command ⌘ + Shift + R</code>
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|8. (Addon Modules Only) Log in to your WHMCS admin area.<br />
+
|style="padding: 0px 0px 15px 15px;"|7. '''Check for additional update steps:'''
−
Go to '' 'Settings' '' → '' 'Addon Modules' '' and activate the recently updated module.
+
* 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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|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.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|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.
 
|}
 
|}
  
−
==Additional Guidance==
+
==Module Cron Commands==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|It may happen that after the update of a module, additional steps still have to be taken in order to ensure its proper functioning.<br />
+
|style="padding: 10px 0px 0px 0px;"|The following cron commands are available for managing modules based on the new framework:
−
If so, we advise you to check the module's documentation and see whether some specific actions are needed.<br /><br />
+
|}
−
In particular, search for the following elements:<br />
+
{|
−
1. Folders which need specific write permissions (chmods).<br />
+
|style="padding: 0px 0px 30px 0px;"|
 +
 
 +
* '''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
 +
|}
 +
<!--
 +
==Additional Instructions==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|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. <br />
 +
Review  the following sections: '' "Installation", "Update Instructions" ''  and '' "Common Problems" '' sections:<br />
 +
 
 +
Search for information on:<br/>
 +
1. Folders which need specific writing permissions (chmods).<br />
 
2. Previous settings of chmods which were overwritten.<br />
 
2. Previous settings of chmods which were overwritten.<br />
 
3. Either a new cron job added or an old one removed.<br />
 
3. Either a new cron job added or an old one removed.<br />
−
4. The use of the migration tool needed to import the settings from a previous version.<br />
+
4. The use of the migration tool needed to import the settings from the previous version.<br />
 
5. Settings removed during the update.<br />
 
5. Settings removed during the update.<br />
 
6. Integration codes that need to be changed after the update.<br/>
 
6. Integration codes that need to be changed after the update.<br/>
−
7. Additional steps listed in the installation instruction.
+
7. Additional steps listed in the installation instruction.<br/>
 +
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.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|'''In case of failure, return to the previous version of the module and [https://www.modulesgarden.com/customers/support report a problem].'''
+
|style="padding: 0px 0px 30px 15px;"|'''In case of failure, return to the previous version of the module and [https://www.modulesgarden.com/support/ticket/general-support contact us.]'''
 +
|}
 +
-->
 +
 
 +
==Conclusions==
 +
{|
 +
|style="padding: 10px 0px 30px 0px;"|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. <br/>If any issues arise, refer to your module [https://www.docs.modulesgarden.com/Main_Page documentation] or [https://www.modulesgarden.com/support/ticket contact] our support team for assistance.
 
|}
 
|}

Latest revision as of 12:18, 4 March 2025

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] 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.

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