wp-kit/tgmpa-integration
This is a wp-kit component that handles TGMPA
configuration via a config file., (*1)
TGMPA
(TGM Plugin Activation) is a PHP library that allows you to easily require or recommend plugins for your WordPress themes (and plugins)., (*2)
This component was built to run within an Illuminate\Container\Container
so is perfect for frameworks such as Themosis
, Assely
and wp-kit/theme
., (*3)
Installation
If you're using Themosis
, install via Composer
in the root of your Themosis
installation, otherwise install in your Composer
driven theme folder:, (*4)
composer require "wp-kit/tgmpa-integration"
Setup
Add Service Provider
Just register the service provider in the providers config:, (*5)
//inside theme/resources/config/providers.config.php
return [
//,
WPKit\Integrations\Tgmpa\TgmpaServiceProvider::class,
//
];
Add Config File
The recommended method of installing config files for wp-kit
components is via wp kit vendor:publish
command., (*6)
First, install WP CLI, and then install this component, wp kit vendor:publish
will automatically be installed with wp-kit/utils
, once installed you can run:, (*7)
wp kit vendor:publish
, (*8)
For more information, please visit wp-kit/utils
., (*9)
Alternatively, you can place the config file(s) in your theme/resources/config
directory manually., (*10)
Usage
Please install and study the default config file as described above to learn how to use this component., (*11)
Get Involved
To learn more about how to use wp-kit
check out the docs:, (*12)
View the Docs, (*13)
Any help is appreciated. The project is open-source and we encourage you to participate. You can contribute to the project in multiple ways by:, (*14)
- Reporting a bug issue
- Suggesting features
- Sending a pull request with code fix or feature
- Following the project on GitHub
- Sharing the project around your community
For details about contributing to the framework, please check the contribution guide., (*15)
Requirements
Wordpress 4+, (*16)
PHP 5.6+, (*17)
License
wp-kit/tgmpa-integration is open-sourced software licensed under the MIT License., (*18)