How To Update WHMCS Module

• WHMCS Module Update Process
  • Updating Major Versions
  • Update Process
  • Module Cron Commands
  • Conclusions

WHMCS Module Update Process

This guide provides essential instructions for updating any ModulesGarden module for WHMCS (opens new window).
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.

⚠️ Important: Check Module-Specific Update Instructions

Before updating any ModulesGarden module, always review the Update Instructions section in its dedicated documentation.

Some modules require additional steps, database migrations, or a specific upgrade sequence. Skipping these requirements, especially when upgrading from significantly older versions, may result in database inconsistencies, missing data, or module errors.

Do not upgrade directly to the latest version without first verifying the recommended update procedure for your module.

If the required upgrade path is unclear or an intermediate version is unavailable, contact our Support Team before proceeding.

Updating Major Versions

Important notes on updating across major versions

When updating a module across multiple versions (for example, from 1.2.x to 1.4.x), a step-by-step upgrade may be required to ensure that all database migrations and configuration changes are applied correctly.

Always check the module-specific Update Instructions before proceeding.

If intermediate updates are required, the upgrade sequence may look as follows:

• First update to the latest required 1.3.x version.
• Then update to the latest available 1.4.x version.

Note: x refers to a patch release within the given version (e.g., 1.3.4, 1.4.2, etc.).

Skipping required intermediate versions may lead to issues such as incomplete database migrations, 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, make sure all requirements are met before proceeding.

If you are upgrading from a significantly older module version, do not assume that a direct update to the latest release is supported. Verify the recommended upgrade path first.

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 required version of the module from our client area (opens new window).

   • Before downloading, review the module-specific Update Instructions to confirm whether a direct update to the latest version is supported.

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 license configuration.
   • If you have custom attachments or additional files uploaded to the module, ensure you do not delete them.
   • Follow any additional file removal or preservation instructions provided in the module's documentation.

4. Upload and extract the new files:

   • Upload the required 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. Follow module-specific update instructions:

   • Open the documentation for your module and locate the Update Instructions section.
   • Complete any required database migrations, configuration changes, or additional update steps.
   • If upgrading across multiple versions, verify whether intermediate updates are required before installing the latest release.
   • Check for any additional requirements related to file permissions, cron jobs, integration codes, or PHP compatibility.
   • If any required steps or versions are unclear, contact our Support Team (opens new window) before continuing.

8. Deactivate and reactivate the updated module (if required):

   • Some modules may require reactivation as part of their update procedure. Perform this step only when explicitly instructed in the module's documentation.
   • 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 (if required):

   • Log in to the client area where your license is managed.
   • Navigate to Products and find the relevant license.
   • Click Reissue License if required by the module's update instructions.

10. Verify the update:

    • Confirm that the module is running the expected version.
    • Check that its configuration, existing data, and key functionalities are working correctly.
    • Review any module logs or error messages after the update.

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 the 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

Warning: The --remove-database-tables option permanently removes module-related database tables and should never be used as part of a standard update procedure.

Conclusions

Following the recommended update procedure helps ensure proper module management in WHMCS and reduces the risk of compatibility issues or data loss.

Always back up your installation, review the module-specific Update Instructions, and verify the module's functionality after updating.

When upgrading from an older version, never assume that skipping intermediate releases is safe. Check the supported upgrade path before proceeding.

If any issues arise, refer to your module's documentation or contact (opens new window) our support team for assistance.