Personal tools
Namespaces

Variants
Actions

How To Update WHMCS Module

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Additional Guidance)
(→‎Update Instructions)
Line 11: Line 11:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|2. '''Addon Modules Only:''' Log in to your WHMCS system admin area.<br />
+
|style="padding: 0px 0px 15px 15px;"|2. '''Addon Modules Only:''' Log in to your WHMCS admin area.<br />
 
Go to '' 'Settings' '' → '' 'Addon Modules' '' and deactivate the module you wish to update.<br />
 
Go to '' 'Settings' '' → '' 'Addon Modules' '' and deactivate the module you wish to update.<br />
−
'' '''Note:''' This step is recommended but skip it if you want to keep your module's settings.''
+
'' '''Note:''' This step is recommended but skip it if you want to keep your current module's settings.''
 
|}
 
|}
 
{|
 
{|
Line 19: Line 19:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|4. Remove all files of the old module version (except license.php file).
+
|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 20px 15px;"|5. Upload and extract the new files to your WHMCS root directory. They will overwrite the old files.
+
|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;"|6. Proceed to the module location and remove the '' 'license.php' '' file.<br />
+
|style="padding: 0px 0px 15px 15px;"|6. Proceed to the module's location and remove the '' 'license.php' '' file.<br />
−
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module license.<br />
+
Now, rename '' 'license_RENAME.php' '' to '' 'license.php' '' file and edit it by providing your module's license.<br />
 
'' '''Note:''' This step is mandatory only in a few cases, due to the changes in the packaging system.''
 
'' '''Note:''' This step is mandatory only in a few cases, due to the changes in the packaging system.''
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|7. Remove all files from '' '\your_whmcs\template_c\' '' directory.
+
|style="padding: 0px 0px 20px 15px;"|7. Remove all files from the '' '\your_whmcs\template_c\' '' directory.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|8. (Addon Modules Only) Log in to your WHMCS system admin area.<br />
+
|style="padding: 0px 0px 30px 15px;"|8. (Addon Modules Only) Log in to your WHMCS admin area.<br />
 
Go to '' 'Settings' '' → '' 'Addon Modules' '' and activate the recently updated module.
 
Go to '' 'Settings' '' → '' 'Addon Modules' '' and activate the recently updated module.
 
|}
 
|}

Revision as of 14:08, 23 November 2017

This article will help you go through the process of updating any WHMCS module.

Follow the steps presented below to complete a basic module's update.
Additionally, you can view the list of additional actions that might be required to conduct the update mechanism properly.

Update Instructions

1. In the beginning, please make a backup of your WHMCS files and database.
2. Addon Modules Only: Log in to your WHMCS admin area.

Go to 'Settings' → 'Addon Modules' and deactivate the module you wish to update.
Note: This step is recommended but skip it if you want to keep your current module's settings.

3. Download the latest version of the module from our website.
4. Remove all files of the previous module's version (except the license.php file).
5. Upload and extract the new files into your WHMCS root directory. They will overwrite the old files.
6. 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.
Note: This step is mandatory only in a few cases, due to the changes in the packaging system.

7. Remove all files from the '\your_whmcs\template_c\' directory.
8. (Addon Modules Only) Log in to your WHMCS admin area.

Go to 'Settings' → 'Addon Modules' and activate the recently updated module.

Additional Guidance

It may happen, that after the update of a module, additional steps still have to be taken in order to ensure its proper functioning.

If so, we advise you to check the module's documentation and see whether some additional actions are needed.

Especially look for:
1. Folders which need specific write 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 a 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.

In case of failure, return to the previous version of the module and report a problem.


Retrieved from "https://www.docs.modulesgarden.com/index.php?title=How_To_Update_WHMCS_Module&oldid=34565"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community