| 1 |
# TGM Plugin Activation |
| 2 |
[](https://raw.githubusercontent.com/TGMPA/TGM-Plugin-Activation/develop/LICENSE.md](https://raw.githubusercontent.com/TGMPA/TGM-Plugin-Activation/develop/LICENSE.md](https://raw.githubusercontent.com/TGMPA/TGM-Plugin-Activation/develop/LICENSE.md) |
| 3 |
[](https://travis-ci.org/TGMPA/TGM-Plugin-Activation](https://travis-ci.org/TGMPA/TGM-Plugin-Activation](https://travis-ci.org/TGMPA/TGM-Plugin-Activation) |
| 4 |
[](https://scrutinizer-ci.com/g/TGMPA/TGM-Plugin-Activation/?branch=develop](https://scrutinizer-ci.com/g/TGMPA/TGM-Plugin-Activation/?branch=develop](https://scrutinizer-ci.com/g/TGMPA/TGM-Plugin-Activation/?branch=develop) |
| 5 |
|
| 6 |
|
| 7 |
**Lead Developers:** |
| 8 |
[](https://github.com/thomasgriffinThomas Griffin](https://github.com/thomasgriffin](https://github.com/thomasgriffin) ([](https://twitter.com/jthomasgriffin@jthomasgriffin](https://twitter.com/jthomasgriffin](https://twitter.com/jthomasgriffin)), [](https://github.com/GaryJonesGary Jones](https://github.com/GaryJones](https://github.com/GaryJones) ([](https://twitter.com/GaryJ@GaryJ](https://twitter.com/GaryJ](https://twitter.com/GaryJ)), [](https://github.com/jrfnlJuliette Reinders Folmer](https://github.com/jrfnl](https://github.com/jrfnl) ([](https://twitter.com/jrf_nl@jrf_nl](https://twitter.com/jrf_nl](https://twitter.com/jrf_nl)) |
| 9 |
**Version:** 2.6.1 |
| 10 |
**Requires at least:** 3.7.0 |
| 11 |
**Tested up to:** 4.5.2 |
| 12 |
|
| 13 |
## Description |
| 14 |
|
| 15 |
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, update and even automatically activate plugins in singular or bulk fashion using native WordPress classes, functions and interfaces. You can reference bundled plugins, plugins from the WordPress Plugin Repository or even plugins hosted elsewhere on the internet. |
| 16 |
|
| 17 |
## Installation |
| 18 |
|
| 19 |
1. Generate a customized version of the latest version of TGMPA based on your intended use-case using the [](http://tgmpluginactivation.com/download/Custom TGMPA Generator](http://tgmpluginactivation.com/download/](http://tgmpluginactivation.com/download/). |
| 20 |
2. Extract the class file and place it somewhere in your theme hierarchy. |
| 21 |
3. Add a `require_once` call within `functions.php` (or other file) referencing the class file. |
| 22 |
4. Create a function, hooked to `tgmpa_register`, that registers the plugin and configurations. |
| 23 |
|
| 24 |
For steps 3 and 4, it is recommended you view, copy and paste the contents of `example.php` |
| 25 |
and amend to suit. The `example.php` file is a model for how you should include the class in your theme. |
| 26 |
|
| 27 |
Detailed documentation on [](http://tgmpluginactivation.com/configuration/how to configure TGMPA](http://tgmpluginactivation.com/configuration/](http://tgmpluginactivation.com/configuration/) is available on the website. |
| 28 |
|
| 29 |
The generated customized version of TGMPA will comply with the Theme Review guidelines and Theme Check. |
| 30 |
|
| 31 |
### Composer |
| 32 |
|
| 33 |
TGM Plugin Activation is also available as a [](https://packagist.org/packages/tgmpa/tgm-plugin-activationpackage](https://packagist.org/packages/tgmpa/tgm-plugin-activation](https://packagist.org/packages/tgmpa/tgm-plugin-activation) installable via Composer: |
| 34 |
|
| 35 |
~~~sh |
| 36 |
composer create-project tgmpa/tgm-plugin-activation --no-dev |
| 37 |
~~~ |
| 38 |
|
| 39 |
## Frequently Asked Questions |
| 40 |
|
| 41 |
See [](http://tgmpluginactivation.com/faq/the FAQ page](http://tgmpluginactivation.com/faq/](http://tgmpluginactivation.com/faq/). |
| 42 |
|
| 43 |
## Feedback |
| 44 |
|
| 45 |
See https://github.com/TGMPA/TGM-Plugin-Activation/issues for current issues and the [](https://github.com/TGMPA/TGM-Plugin-Activation/wiki/Guidelines-for-reporting-bugsguidelines for reporting bugs and enhancements](https://github.com/TGMPA/TGM-Plugin-Activation/wiki/Guidelines-for-reporting-bugs](https://github.com/TGMPA/TGM-Plugin-Activation/wiki/Guidelines-for-reporting-bugs). |
| 46 |
|
| 47 |
__Note:__ TGM Plugin Activation library authors are not responsible for the *end-user support* for any plugin or theme which uses the library. |
| 48 |
|
| 49 |
## Changelog |
| 50 |
|
| 51 |
See [](CHANGELOG.mdCHANGELOG.md](CHANGELOG.md](CHANGELOG.md). |
| 52 |
|
| 53 |
## Contributing to TGM Plugin Activation |
| 54 |
|
| 55 |
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 [](CONTRIBUTING.mdcontributor guidelines](CONTRIBUTING.md](CONTRIBUTING.md) for more information how you can do this. |
| 56 |
|
| 57 |
|
