Addon Modules

From WHMCS Documentation

Addon modules allow developers to extend the functionality of WHMCS further including new pages in the admin or client areas. You can enable, disable, and manage them in the WHMCS Admin Area.

You can access this feature at Configuration () > System Settings > Addon Modules or, prior to WHMCS 8.0, Setup > Addon Modules.

You can find addons to download and install in the WHMCS Marketplace.

Enable and Configure an Addon

Uploading Addons
Before you can configure an addon, you must upload the addon to your WHMCS installation. To do this, unzip and upload the addon files to your installation's /modules/addons directory. Ensure that the module directory's POSIX permissions are 755 and individual file permissions are 644.

To activate and configure an addon:

  1. Click Activate for the addon you wish to enable.
  2. Click Configure.
  3. If the addon has includes module-specific settings, configure them.
  4. Select the administrator roles to allow to access the addon in the Access Control section.
  5. Click Save Changes.

The addon will now appear in the Addons menu.

Removing An Addon

Disabling an Addon Module may delete data relevant to the addon from the database.

To remove an addon, click Deactivate for that addon.

After you deactivate the addon, you can delete the directory for the addon from the /modules/addons directory.


Oops Error

An Oops Error Message when you view the list of addon modules can be caused by an incompatible module. For help to resolve this error, see Troubleshooting A Blank Page Oops Error Message.

The error will reference the addon module that is causing the failure. Once you know the affected addon, you can remove the addon files from /modules/addons or obtain an updated version of the addon from the developer.

Addon does not appear in menu

Ensure that you have selected the administrator roles during addon configuration.