TGM Plugin Activation
TGM Plugin Activation is a PHP library that allows you to easily require or recommend plugins for your WordPress themes (and plugins). It allows your users to install and even automatically activate plugins in singular or bulk fashion using native WordPress classes, functions and interfaces. You can reference pre-packaged plugins, plugins from the WordPress Plugin Repository or even plugins hosted elsewhere on the internet.
- Head to the Releases page and download the latest release zip.
- Extract the class file and place it somewhere in your theme hierarchy.
- Add a
functions.php(or other theme file) referencing the class file.
- Create a function, hooked to
tgmpa_register, that registers the plugin and configurations.
For steps 3 and 4, it is recommended you view, copy and paste the contents of
and amend to suit. The
example.php file is a model for how you should include the class in your theme.
Some important things to note:
- With the
require_oncecall, make sure to amend the path to the correct location within your theme.
- For plugins pulled from the .org repo, the source argument is optional. Otherwise it is required and should point to the absolute path for the plugin zips within your theme, or to a URL for zips elsewhere online.
$configvariable holds an array of arguments that can be used to customize aspects of the class. If you define an absolute default path for packaged plugins, you do not need to specify the directory path for your pre-packaged plugin within the
'source'argument. You will only need to specify the zip file name.
TGM Plugin Activation is also available as a package installable via Composer:
composer create-project tgmpa/tgm-plugin-activation --no-dev
See https://github.com/thomasgriffin/TGM-Plugin-Activation/issues for current issues and for reporting bugs and enhancements.
Note: TGM Plugin Activation library authors are not responsible for the end-user support for any plugin or theme which uses the library.
Contributing to TGM Plugin Activation
If you have a patch, or stumbled upon an issue with TGM Plugin Activation core, you can contribute this back to the code. Please read our contributor guidelines for more information how you can do this.