Personal tools
Namespaces

Variants
Actions

How To Update WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Update Instructions)
(→‎Module Cron Commands)
 
(9 intermediate revisions by one user not shown)
Line 1: Line 1:
 
<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="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="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>
 +
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Read the below article carefully as it contains crucial information on how to update any of [https://www.modulesgarden.com/products/whmcs ModuelsGarden modules for WHMCS]. <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 one by one to complete successfully the module update and avoid losing data or any other unexpected issues.<br />You will also find here a current list of additional actions that might be required to perform the update properly.<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/>
  
−
Please read the whole article first and then go on with a safe update.
+
Carefully review the entire guide before proceeding to avoid potential complications.
 
|}
 
|}
−
==Update Instructions==
+
==Update Process==
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''1. Start with making a backup copy of your WHMCS files and database.'''<br/>
+
|style="padding: 10px 0px 20px 15px;"|To successfully update a module, follow these steps:<br/>
−
This step is crucial as it will let you avoid losing any data in case of unexpected update failure or other issues.
+
 
|}
 
|}
−
<!-- TEN KROK JEST JUŻ NIEKATUALNY I W ZASADZIE NIE ZALECAMY DEAKTYWACJI ADDONÓW PRZED WGRANIEM STARYCH
 
 
{|
 
{|
−
|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 are going 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 you may skip it if you want to keep the settings of the module.''
+
 
|}
 
|}
−
-->
 
 
{|
 
{|
−
|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;"|2. '''Download the latest version of the module''' from our [https://www.modulesgarden.com/client-area/products client area].
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|3. Remove all the files of the previous module's version from the WHMCS root directory '''(except the license.php file)'''.<br/>
+
|style="padding: 0px 0px 15px 15px;"|3. '''Remove the old module files:'''
−
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.<br/>
+
* Navigate to your WHMCS root directory.
−
'''''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.''
+
* 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;"|4. Upload and extract the new files into your WHMCS root directory.
+
|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;"|5. '''This step is mandatory only in a few cases due to the changes in the packaging system.'''
+
|style="padding: 0px 0px 15px 15px;"|5. '''Adjust the license file (if required):'''
−
Proceed to the module's location and remove the '' 'license.php' '' file.<br />
+
* In some cases, you may need to navigate to the module's folder and delete the existing <code>license.php</code> file.
−
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module's license.
+
* 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. Next, move to '' '/your_whmcs/template_c/' '' directory and delete all the files that are inside it except the '' index.php'' file.<br/>
+
|style="padding: 0px 0px 15px 15px;"|6. '''Clear cache:'''
−
'' '''Note:''' This action will remove cache, which will prevent WHMCS from storing obsolete parts of the module and read the new version correctly.''
+
* 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 20px 15px;"|7. It is adviced to move to the module's [https://www.docs.modulesgarden.com documentation] and confirm that there are no additional steps required in the '' '''Update Instruction''' '' section.
+
|style="padding: 0px 0px 15px 15px;"|7. '''Check for additional update steps:'''
 +
* 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. '''Addon Modules Only:''' Log in to your WHMCS admin area and proceed to the updated module addon.<br />
+
|style="padding: 0px 0px 15px 15px;"|8. '''Activate the updated module:'''
−
<!-- to już nieaktualne
+
* Log in to the WHMCS admin area.
−
Go to '' "Settings" '' → '' "Addon Modules" '' and activate the just updated module.
+
* Navigate to '' 'System Settings' → 'Addon Modules' '' and locate the updated module.
−
-->
+
* Click the '''Activate''' button to enable the module.
−
'' '''Important:''' We do '''not''' recommend deactivating the old version of the module addon before updating the new one.<br/>Such action is '''not''' longer required for the module addon to be successfully updated.''
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|Once the instructions are carried out, the module update is ready and correct.<br />
+
|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.
 
|}
 
|}
  
 +
==Module Cron Commands==
 +
{|
 +
|style="padding: 10px 0px 0px 0px;"|The following cron commands are available for managing modules based on the new framework:
 +
|}
 +
{|
 +
|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==
 
==Additional Instructions==
 
{|
 
{|
Line 72: Line 109:
 
{|
 
{|
 
|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.]'''
 
|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