| 1 |
<?php |
| 2 |
/** |
| 3 |
* This file represents an example of the code that themes would use to register |
| 4 |
* the required plugins. |
| 5 |
* |
| 6 |
* It is expected that theme authors would copy and paste this code into their |
| 7 |
* functions.php file, and amend to suit. |
| 8 |
* |
| 9 |
* @package TGM-Plugin-Activation |
| 10 |
* @subpackage Example |
| 11 |
* @version 2.3.3 |
| 12 |
* @author Thomas Griffin <thomas@thomasgriffinmedia.com> |
| 13 |
* @author Gary Jones <gamajo@gamajo.com> |
| 14 |
* @copyright Copyright (c) 2012, Thomas Griffin |
| 15 |
* @license http://opensource.org/licenses/gpl-2.0.php GPL v2 or later |
| 16 |
* @link https://github.com/thomasgriffin/TGM-Plugin-Activation |
| 17 |
*/ |
| 18 |
|
| 19 |
/** |
| 20 |
* Include the TGM_Plugin_Activation class. |
| 21 |
*/ |
| 22 |
require_once dirname( __FILE__ ) . '/class-tgm-plugin-activation.php'; |
| 23 |
|
| 24 |
add_action( 'tgmpa_register', 'my_theme_register_required_plugins' ); |
| 25 |
/** |
| 26 |
* Register the required plugins for this theme. |
| 27 |
* |
| 28 |
* In this example, we register two plugins - one included with the TGMPA library |
| 29 |
* and one from the .org repo. |
| 30 |
* |
| 31 |
* The variable passed to tgmpa_register_plugins() should be an array of plugin |
| 32 |
* arrays. |
| 33 |
* |
| 34 |
* This function is hooked into tgmpa_init, which is fired within the |
| 35 |
* TGM_Plugin_Activation class constructor. |
| 36 |
*/ |
| 37 |
function my_theme_register_required_plugins() { |
| 38 |
|
| 39 |
/** |
| 40 |
* Array of plugin arrays. Required keys are name and slug. |
| 41 |
* If the source is NOT from the .org repo, then source is also required. |
| 42 |
*/ |
| 43 |
$plugins = array( |
| 44 |
|
| 45 |
// This is an example of how to include a plugin pre-packaged with a theme |
| 46 |
array( |
| 47 |
'name' => 'TGM Example Plugin', // The plugin name |
| 48 |
'slug' => 'tgm-example-plugin', // The plugin slug (typically the folder name) |
| 49 |
'source' => get_stylesheet_directory() . '/lib/plugins/tgm-example-plugin.zip', // The plugin source |
| 50 |
'required' => true, // If false, the plugin is only 'recommended' instead of required |
| 51 |
'version' => '', // E.g. 1.0.0. If set, the active plugin must be this version or higher, otherwise a notice is presented |
| 52 |
'force_activation' => false, // If true, plugin is activated upon theme activation and cannot be deactivated until theme switch |
| 53 |
'force_deactivation' => false, // If true, plugin is deactivated upon theme switch, useful for theme-specific plugins |
| 54 |
'external_url' => '', // If set, overrides default API URL and points to an external URL |
| 55 |
), |
| 56 |
|
| 57 |
// This is an example of how to include a plugin from the WordPress Plugin Repository |
| 58 |
array( |
| 59 |
'name' => 'BuddyPress', |
| 60 |
'slug' => 'buddypress', |
| 61 |
'required' => false, |
| 62 |
), |
| 63 |
|
| 64 |
); |
| 65 |
|
| 66 |
// Change this to your theme text domain, used for internationalising strings |
| 67 |
$theme_text_domain = 'tgmpa'; |
| 68 |
|
| 69 |
/** |
| 70 |
* Array of configuration settings. Amend each line as needed. |
| 71 |
* If you want the default strings to be available under your own theme domain, |
| 72 |
* leave the strings uncommented. |
| 73 |
* Some of the strings are added into a sprintf, so see the comments at the |
| 74 |
* end of each line for what each argument will be. |
| 75 |
*/ |
| 76 |
$config = array( |
| 77 |
'domain' => $theme_text_domain, // Text domain - likely want to be the same as your theme. |
| 78 |
'default_path' => '', // Default absolute path to pre-packaged plugins |
| 79 |
'parent_menu_slug' => 'themes.php', // Default parent menu slug |
| 80 |
'parent_url_slug' => 'themes.php', // Default parent URL slug |
| 81 |
'menu' => 'install-required-plugins', // Menu slug |
| 82 |
'has_notices' => true, // Show admin notices or not |
| 83 |
'is_automatic' => false, // Automatically activate plugins after installation or not |
| 84 |
'message' => '', // Message to output right before the plugins table |
| 85 |
'strings' => array( |
| 86 |
'page_title' => __( 'Install Required Plugins', $theme_text_domain ), |
| 87 |
'menu_title' => __( 'Install Plugins', $theme_text_domain ), |
| 88 |
'installing' => __( 'Installing Plugin: %s', $theme_text_domain ), // %1$s = plugin name |
| 89 |
'oops' => __( 'Something went wrong with the plugin API.', $theme_text_domain ), |
| 90 |
'notice_can_install_required' => _n_noop( 'This theme requires the following plugin: %1$s.', 'This theme requires the following plugins: %1$s.' ), // %1$s = plugin name(s) |
| 91 |
'notice_can_install_recommended' => _n_noop( 'This theme recommends the following plugin: %1$s.', 'This theme recommends the following plugins: %1$s.' ), // %1$s = plugin name(s) |
| 92 |
'notice_cannot_install' => _n_noop( 'Sorry, but you do not have the correct permissions to install the %s plugin. Contact the administrator of this site for help on getting the plugin installed.', 'Sorry, but you do not have the correct permissions to install the %s plugins. Contact the administrator of this site for help on getting the plugins installed.' ), // %1$s = plugin name(s) |
| 93 |
'notice_can_activate_required' => _n_noop( 'The following required plugin is currently inactive: %1$s.', 'The following required plugins are currently inactive: %1$s.' ), // %1$s = plugin name(s) |
| 94 |
'notice_can_activate_recommended' => _n_noop( 'The following recommended plugin is currently inactive: %1$s.', 'The following recommended plugins are currently inactive: %1$s.' ), // %1$s = plugin name(s) |
| 95 |
'notice_cannot_activate' => _n_noop( 'Sorry, but you do not have the correct permissions to activate the %s plugin. Contact the administrator of this site for help on getting the plugin activated.', 'Sorry, but you do not have the correct permissions to activate the %s plugins. Contact the administrator of this site for help on getting the plugins activated.' ), // %1$s = plugin name(s) |
| 96 |
'notice_ask_to_update' => _n_noop( 'The following plugin needs to be updated to its latest version to ensure maximum compatibility with this theme: %1$s.', 'The following plugins need to be updated to their latest version to ensure maximum compatibility with this theme: %1$s.' ), // %1$s = plugin name(s) |
| 97 |
'notice_cannot_update' => _n_noop( 'Sorry, but you do not have the correct permissions to update the %s plugin. Contact the administrator of this site for help on getting the plugin updated.', 'Sorry, but you do not have the correct permissions to update the %s plugins. Contact the administrator of this site for help on getting the plugins updated.' ), // %1$s = plugin name(s) |
| 98 |
'install_link' => _n_noop( 'Begin installing plugin', 'Begin installing plugins' ), |
| 99 |
'activate_link' => _n_noop( 'Activate installed plugin', 'Activate installed plugins' ), |
| 100 |
'return' => __( 'Return to Required Plugins Installer', $theme_text_domain ), |
| 101 |
'plugin_activated' => __( 'Plugin activated successfully.', $theme_text_domain ), |
| 102 |
'complete' => __( 'All plugins installed and activated successfully. %s', $theme_text_domain ) // %1$s = dashboard link |
| 103 |
) |
| 104 |
); |
| 105 |
|
| 106 |
tgmpa( $plugins, $config ); |
| 107 |
|
| 108 |
} |
