The 1.6 Documentation is no longer maintained and some information may be outdated.

The MyBB 1.6 series reached end of life on October 1, 2015.

This means there will be no more security or maintenance releases for these series and forums running these versions of MyBB may be at risk of unfixed security issues. All administrators are strongly encouraged to upgrade their forums to the latest release of MyBB as soon as possible.

MyBB has a unique and easy-to-use plugin system that allows you to extend the functionality of your MyBB with ease.

Contents

What are plugins?

Plugins are basically custom PHP functions that are executed at a certain point in the MyBB code called a hook. These hooks are located at various points throughout the script (see MyBB Plugin Hooks).

How do plugins work?

When you activate a plugin, its codename (the first part of its filename before .php) is cached in the plugins cache.

All the active plugins are 'included' at the start of each page. (Thus, if you have many plugins installed, the speed of your forum may decrease slightly, depending on the nature of your plugins). The hooks that each plugin uses is stored in memory.

When a hook is 'run' when a page is being executed, the array mentioned earlier is searched to see if there are functions from the plugins loaded earlier associated with this hook. If there are, each function is executed.

Installing Plugins

Here is how to install and activate a plugin. Please note that different plugins may need you to do additional modifications or procedures. Check the plugin's documentation for those specific information.

  1. Upload the plugin file (which should be in the format: pluginname.php) to the folder: inc/plugins/. It is imperative that you do not change the filename from the one that was distributed by the plugin author.
  2. Login to your Admin CP, and click on "Plugin Manager" in the Settings category of the menu.
  3. Find the plugin that you uploaded, and click "Activate"
  4. If all goes well, you should be redirected back to the plugin manager and the button will now say "Deactivate"

See Also


MyBB Customization
Templates/Themes Authoring - Template Management - Theme Management - User-created
Plugins Authoring - Plugin Hooks - Plugin Management - User-created
Translations Language Management - Download
Links MyBB Mods

Edit this page on GitHub