Add-ons

XenForo includes an extensive framework for add-ons to extend and change XenForo's functionality, generally without you having to make any changes by hand.

Many add-ons can be downloaded from the XenForo community resources.

Support considerations

Although many add-ons focus on adding new areas to XenForo, they always interact with the core of XenForo and thus can introduce unexpected behavior and bugs. Add-ons that change the behavior of or extend existing XenForo functionality are more likely to create bugs and conflicts.

Please be aware that we are unable to provide any support for problems involving or caused by a third-party add-on. You will need to contact the add-on author for guidance.

If you have a problem with XenForo and you are using third-party add-ons, please disable all add-ons and style customizations and see if you can still reproduce the problem. If you cannot, then the problem is likely caused by an add-on or customization. You should re-enable your add-ons one by one until the problem comes back and you've identified the specific cause. If the problem still occurs with add-ons and customizations disabled, it may be a bug or problem within XenForo itself and we can work to resolve this with you through a ticket.

Installing an add-on

The process for installing an add-on should follow these general steps.

Once you have downloaded the add-on you want, you should unzip the file locally. Inside it, you will see an upload directory, just like when XenForo was installed. You'll be uploading the contents of this directory.

Using your FTP client, navigate to the XenForo root directory on the server, and upload the contents of the upload directory into it. Ensure that you "merge" with the existing contents on the server.

Once the files are uploaded, in the XenForo control panel, go to the Add-ons section and click the "+ Install Add-on" button. The add-on will have provided an XML file somewhere within it. Upload that file here and submit the form.

Upgrading an add-on

Upgrading an add-on is similar to installing a new add-on. However, you must use the upgrade option for the add-on you are upgrading. You cannot upgrade an add-on from the "Install add-on" page.

Once you have downloaded the add-on you want, you should unzip the file locally. Inside it, you will see an upload directory, just like when XenForo was installed. You'll be uploading the contents of this directory.

Using your FTP client, navigate to the XenForo root directory on the server, and upload the contents of the upload directory into it. Ensure that you "merge" with the existing contents on the server. This should overwrite some existing files.

Once the files are uploaded, in the XenForo control panel, go to the Add-ons section, locate the add-on you are upgrading, expand the "Controls" menu and select "Upgrade Add-on". Upload the XML file provided with the add-on and submit the form.

Disabling an add-on

Disabling an add-on will effectively turn it off, similar to it not being installed in the first place. Any data created by the add-on will remain in the database and be accessible when you re-enable it. An add-on can be disabled by unticking the checkbox on the Installed Add-ons page.

All add-ons can be quickly disabled using the "Disable All Add-ons" button on the top of the add-on list. This will often be required if you contact support. If you disable all add-ons, an "Enable Add-ons" button will appear at the top of the add-on list, allowing you to quickly re-enable your add-ons.

Uninstalling an add-on

Uninstalling an add-on will remove it from your XenForo installation completely. Any data associated with the add-on will be removed. You will not be able to recover that data after uninstalling the add-on!

To uninstall an add-on, choose "Uninstall" from the "Controls" menu for the add-on you want to uninstall. The add-on files you uploaded will not be removed when uninstalling an add-on. These must be removed manually via FTP.

Regaining control panel access

If you find that an add-on is preventing you from accessing the control panel or from disabling add-ons, you can temporarily add the following line to the end of your library/config.php file:

$config['enableListeners'] = false;

To do this, download this file via your FTP client and open it on your computer in a basic text editor (not a word processor). Save the changes and reupload the file to your server.

This will temporarily disable code being run by all add-ons. Use this to access the control panel and disable the offending add-ons. Once you have done this, remove the line above from your library/config.php file.

Note

This is not equivalent to disabling add-ons via the control panel and is not sufficient for determining if an issue is caused by an add-on.