Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge branch 'dev'

  • Loading branch information...
commit d32e5769437daa7bfa0fa387f08a0c6a97ae8680 2 parents fc0843e + b16d552
@thomasgriffin thomasgriffin authored
View
34 README
@@ -1,22 +1,13 @@
=== TGM Plugin Activation ===
Contributors: Thomas Griffin (@jthomasgriffin / thomasgriffinmedia.com)
Gary Jones (Github: @GaryJones / Twitter: GaryJ)
-Version: 2.1.1
+Version: 2.2.0
Requires at least: 3.0.0
-Tested up to: 3.3-beta1
+Tested up to: 3.3
== Description ==
-This class will revolutionize how plugins can be handled for WordPress themes. By using classes that are
-utilized within WordPress, the TGM_Plugin_Activation class can automatically install and activate multiple
-plugins that are either packaged with a theme or downloaded from the WordPress Plugin Repository.
-
-This class uses the WP_Filesystem Abstraction class to find the best way to install the plugin. WP_Filesystem
-searches through a number of methods (Direct, FTP, FTP Sockets, SSH) and determines the best one for use based
-on the user's server setup. If FTP is needed, a form will be displayed to prompt users to input their FTP
-credentials. To do the installing, this class uses the Plugin_Upgrader and Plugin_Skin_Installer classes to
-download, install and activate the plugins. This class also uses WP_Error to display any errors to users
-during the plugin installation and activation process.
+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.
== Installation ==
@@ -24,7 +15,7 @@ during the plugin installation and activation process.
2. Add a require_once call within functions.php (or other theme file) referencing the class file.
3. Create a function, hooked to `tgmpa_register`, that registers the plugin and configurations.
-For steps 2 and 3, it is recommended your view, copy and paste the contents of example.php
+For steps 2 and 3, it is recommended you view, copy and paste the contents of example.php
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:
@@ -44,6 +35,23 @@ You can also follow project progress and updates on Twitter. Follow us here at h
== Changelog ==
+= 2.2.0 =
+
+* Fixed erroneous links for plugins linked to the WordPress Repo
+* Improved UI of plugins by listing them in WordPress' default table layout
+* Improved support for installing plugins if security credentials require FTP information
+* Improved support for MultiSite
+* Added 3 new classes (all extensions of existing WordPress classes): TGMPA_List_Table for outputting required/recommended plugins in a familiar table format, TGM_Bulk_Installer for bulk installing plugins and TGM_Bulk_Installer_Skin for skinning the bulk install process
+* Added extra defensive measures to prevent duplication of classes
+* Added ability to bulk install and bulk activate plugins
+* Added new config options: 'parent_menu_slug', 'parent_menu_url', 'is_automatic', and 'message'
+* Added new string: 'complete' (displayed when all plugins have been successfully installed and activated)
+* Added support for singular/plural strings throughout the library
+* Added permission checks to action links
+* Added new filter tgmpa_default_screen_icon to set the default icon for the plugin table page
+* Added new optional plugin parameters: 'version', 'force_activation', 'force_deactivation' and 'external_url'
+* Removed 'button' string (deprecated with use of plugins table)
+
= 2.1.1 =
* Fixed nag not re-appearing if user switched themes and then re-activated the previous theme (UX improvement)
View
2,454 tgm-plugin-activation/class-tgm-plugin-activation.php 100644 → 100755
1,848 additions, 606 deletions not shown
View
80 tgm-plugin-activation/example.php
@@ -8,7 +8,7 @@
*
* @package TGM-Plugin-Activation
* @subpackage Example
- * @version 2.1.1
+ * @version 2.2.0
* @author Thomas Griffin <thomas@thomasgriffinmedia.com>
* @author Gary Jones <gamajo@gamajo.com>
* @copyright Copyright (c) 2011, Thomas Griffin
@@ -41,53 +41,63 @@ function my_theme_register_required_plugins() {
* If the source is NOT from the .org repo, then source is also required.
*/
$plugins = array(
- /** This is an example of how to include a plugin pre-packaged with a theme */
+
+ // This is an example of how to include a plugin pre-packaged with a theme
array(
- 'name' => 'TGM Example Plugin', // The plugin name
- 'slug' => 'tgm-example-plugin', // The plugin slug (typically the folder name)
- 'source' => get_stylesheet_directory() . '/lib/plugins/tgm-example-plugin.zip', // The plugin source
- 'required' => true // If false, the plugin is only 'recommended' instead of required
+ 'name' => 'TGM Example Plugin', // The plugin name
+ 'slug' => 'tgm-example-plugin', // The plugin slug (typically the folder name)
+ 'source' => get_stylesheet_directory() . '/lib/plugins/tgm-example-plugin.zip', // The plugin source
+ 'required' => true, // If false, the plugin is only 'recommended' instead of required
+ 'version' => '', // E.g. 1.0.0. If set, the active plugin must be this version or higher, otherwise a notice is presented
+ 'force_activation' => false, // If true, plugin is activated upon theme activation and cannot be deactivated until theme switch
+ 'force_deactivation' => false, // If true, plugin is deactivated upon theme switch, useful for theme-specific plugins
+ 'external_url' => '', // If set, overrides default API URL and points to an external URL
),
- /** This is an example of how to include a plugin from the WordPress Plugin Repository */
+
+ // This is an example of how to include a plugin from the WordPress Plugin Repository
array(
- 'name' => 'BuddyPress',
- 'slug' => 'buddypress',
- 'required' => false
- )
+ 'name' => 'BuddyPress',
+ 'slug' => 'buddypress',
+ 'required' => false,
+ ),
+
);
- /** Change this to your theme text domain, used for internationalising strings */
+ // Change this to your theme text domain, used for internationalising strings
$theme_text_domain = 'tgmpa';
/**
- * Array of configuration settings. Uncomment and amend each line as needed.
+ * Array of configuration settings. Amend each line as needed.
* If you want the default strings to be available under your own theme domain,
- * uncomment the strings and domain.
+ * leave the strings uncommented.
* Some of the strings are added into a sprintf, so see the comments at the
* end of each line for what each argument will be.
*/
$config = array(
- /*'domain' => $theme_text_domain, // Text domain - likely want to be the same as your theme. */
- /*'default_path' => '', // Default absolute path to pre-packaged plugins */
- /*'menu' => 'install-required-plugins', // Menu slug */
- /*'notices' => true, // Show admin notices or not */
- 'strings' => array(
- /*'page_title' => __( 'Install Required Plugins', $theme_text_domain ), // */
- /*'menu_title' => __( 'Install Plugins', $theme_text_domain ), // */
- /*'instructions_install' => __( 'The %1$s plugin is required for this theme. Click on the big blue button below to install and activate %1$s.', $theme_text_domain ), // %1$s = plugin name */
- /*'instructions_install_recommended' => __( 'The %1$s plugin is recommended for this theme. Click on the big blue button below to install and activate %1$s.', $theme_text_domain ), // %1$s = plugin name, %2$s = plugins page URL */
- /*'instructions_activate' => __( 'The %1$s plugin is installed but currently inactive. Please go to the <a href="%2$s">plugin administration page</a> page to activate it.', $theme_text_domain ), // %1$s = plugin name, %2$s = plugins page URL */
- /*'button' => __( 'Install %s Now', $theme_text_domain ), // %1$s = plugin name */
- /*'installing' => __( 'Installing Plugin: %s', $theme_text_domain ), // %1$s = plugin name */
- /*'oops' => __( 'Something went wrong with the plugin API.', $theme_text_domain ), // */
- /*'notice_can_install_required' => __( 'This theme requires the following plugins: %1$s.', $theme_text_domain ), // %1$s = plugin names */
- /*'notice_can_install_recommended' => __( 'This theme recommends the following plugins: %1$s.', $theme_text_domain ), // %1$s = plugin names */
- /*'notice_cannot_install' => __( '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.', $theme_text_domain ), // %1$s = plugin name */
- /*'notice_can_activate_required' => __( 'The following required plugins are currently inactive: %1$s.', $theme_text_domain ), // %1$s = plugin names */
- /*'notice_can_activate_recommended' => __( 'The following recommended plugins are currently inactive: %1$s.', $theme_text_domain ), // %1$s = plugin names */
- /*'notice_cannot_activate' => __( '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.', $theme_text_domain ), // %1$s = plugin name */
- /*'return' => __( 'Return to Required Plugins Installer', $theme_text_domain ), // */
- /*'plugin_activated' => __( 'Plugin activated successfully.', $theme_text_domain ) // */
+ 'domain' => $theme_text_domain, // Text domain - likely want to be the same as your theme.
+ 'default_path' => '', // Default absolute path to pre-packaged plugins
+ 'parent_menu_slug' => 'themes.php', // Default parent menu slug
+ 'parent_url_slug' => 'themes.php', // Default parent URL slug
+ 'menu' => 'install-required-plugins', // Menu slug
+ 'has_notices' => true, // Show admin notices or not
+ 'is_automatic' => false, // Automatically activate plugins after installation or not
+ 'message' => '', // Message to output right before the plugins table
+ 'strings' => array(
+ 'page_title' => __( 'Install Required Plugins', $theme_text_domain ),
+ 'menu_title' => __( 'Install Plugins', $theme_text_domain ),
+ 'installing' => __( 'Installing Plugin: %s', $theme_text_domain ), // %1$s = plugin name
+ 'oops' => __( 'Something went wrong with the plugin API.', $theme_text_domain ),
+ '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)
+ '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)
+ '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)
+ '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)
+ '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)
+ '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)
+ '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)
+ '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)
+ 'return' => __( 'Return to Required Plugins Installer', $theme_text_domain ),
+ 'plugin_activated' => __( 'Plugin activated successfully.', $theme_text_domain ),
+ 'complete' => __( 'All plugins installed and activated successfully. %s', $theme_text_domain ) // %1$s = dashboard link
)
);
Please sign in to comment.
Something went wrong with that request. Please try again.