Ticket #5625: 5625.r8539.diff

wp-admin/includes/plugin.php

@@ -157 +157 @@
         return $wp_plugins;
 }
 
-function is_plugin_active($plugin){
+/**
+ * Check whether the plugin is active by checking the active_plugins list.
+ *
+ * @since 2.5.0
+ *
+ * @param string $plugin Base plugin path from plugins directory.
+ * @return bool True, if in the active plugins list. False, not in the list.
+ */
+function is_plugin_active($plugin) {
         return in_array($plugin, get_option('active_plugins'));
 }
 
@@ -328 +336 @@
         return 0;
 }
 
+/**
+ * Whether the plugin can be uninstalled.
+ *
+ * @since {@internal Version Unknown}}
+ *
+ * @param string $plugin Plugin path to check.
+ * @return bool Whether plugin can be uninstalled.
+ */
+function is_uninstallable_plugin($plugin) {
+        $file = plugin_basename($plugin);
+
+        $uninstallable_plugins = (array) get_option('uninstall_plugins');
+        if ( isset( $uninstallable_plugins[$file] ) || file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) )
+                return true;
+
+        return false;
+}
+
+/**
+ * Uninstall a single plugin.
+ *
+ * Calls the uninstall hook, if it is available.
+ *
+ * @param string $plugin Relative plugin path from Plugin Directory.
+ */
+function uninstall_plugin($plugin) {
+        $file = plugin_basename($plugin);
+
+        if ( is_plugin_active($file) )
+                return false;
+        
+        $uninstallable_plugins = (array) get_option('uninstall_plugins');
+        if ( file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) ) {
+                if ( isset( $uninstallable_plugins[$file] ) ) {
+                        unset($uninstallable_plugins[$file]);
+                        set_option('uninstall_plugins', $uninstallable_plugins);
+                }
+                unset($uninstallable_plugins);
+
+                define('WP_UNINSTALL_PLUGIN', $file);
+                include WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php';
+
+                return true;
+        }
+
+        if ( isset( $uninstallable_plugins[$file] ) ) {
+                $callable = $uninstallable_plugins[$file];
+                unset($uninstallable_plugins[$file]);
+                set_option('uninstall_plugins', $uninstallable_plugins);
+                unset($uninstallable_plugins);
+
+                include WP_PLUGIN_DIR . '/' . $file;
+
+                add_action( 'uninstall_' . $file, $callable );
+                do_action( 'uninstall_' . $file );
+
+                deactivate_plugins($file, true);
+        }
+}
+
+/**
+ * Uninstall multiple plugins.
+ *
+ * @since {@internal Version Unknown}}
+ *
+ * @param array $plugins
+ * @return bool Whether uninstall process is completed.
+ */
+function uninstall_plugins($plugins) {
+        if ( !is_array($plugins) )
+                $plugins = array($plugins);
+
+        foreach ( (array) $plugins as $plugin )
+                uninstall_plugin($plugin);
+
+        return true;
+}
+
 //
 // Menu
 //
@@ -616 +702 @@
         return true;
 }
 
-?>
+?>
+ No newline at end of file

wp-admin/plugins.php

@@ -2 +2 @@
 require_once('admin.php');
 
 $action = '';
-foreach( array('activate-selected', 'deactivate-selected', 'delete-selected', 'clear-recent-list') as $action_key ) {
+foreach( array('uninstall-selected', 'activate-selected', 'deactivate-selected', 'delete-selected', 'clear-recent-list') as $action_key ) {
         if( isset($_POST[$action_key]) ) {
                 $action = $action_key;
                 break;
@@ -44 +44 @@
                         wp_redirect('plugins.php?activate-multi=true');
                         exit;
                         break;
+                case 'uninstall':
+                        check_admin_referer('uninstall-plugin_' . $plugin);
+                        uninstall_plugin($plugin);
+                        wp_redirect('plugins.php?uninstall=true');
+                        exit;
+                        break;
+                case 'uninstall-selected':
+                        check_admin_referer('bulk-manage-plugins');
+                        uninstall_plugins($_POST['checked']);
+                        wp_redirect('plugins.php?uninstall-multi=true');
+                        exit;
+                        break;
                 case 'error_scrape':
                         check_admin_referer('plugin-activation-error_' . $plugin);
                         $valid = validate_plugin($plugin);
@@ -194 +206 @@
         <div id="message" class="updated fade"><p><?php _e('Plugin <strong>deactivated</strong>.') ?></p></div>
 <?php elseif (isset($_GET['deactivate-multi'])) : ?>
         <div id="message" class="updated fade"><p><?php _e('Selected plugins <strong>deactivated</strong>.'); ?></p></div>
+<?php elseif ( isset($_GET['uninstall']) ) : ?>
+        <div id="message" class="updated fade"><p><?php _e('Plugin <strong>uninstalled</strong>.') ?></p></div>
+<?php elseif ( isset($_GET['uninstall-multi']) ) : ?>
+        <div id="message" class="updated fade"><p><?php _e('Selected plugins <strong>uninstalled</strong>.') ?></p></div>
 <?php endif; ?>
 
 <div class="wrap">
@@ -292 +308 @@
                 if ( current_user_can('edit_plugins') && is_writable(WP_PLUGIN_DIR . '/' . $plugin_file) )
                         $action_links[] = '<a href="plugin-editor.php?file=' . $plugin_file . '" title="' . __('Open this file in the Plugin Editor') . '" class="edit">' . __('Edit') . '</a>';
 
+                if( 'active' != $context && is_uninstallable_plugin($plugin_file) )
+                        $action_links[] = '<a href="' . wp_nonce_url('plugins.php?action=uninstall&amp;plugin=' . $plugin_file, 'uninstall-plugin_' . $plugin_file) . '" title="' . __('Uninstall this plugin') . '" class="uninstall">' . __('Uninstall') . '</a>';
+
                 $action_links = apply_filters('plugin_action_links', $action_links, $plugin_file, $plugin_data, $context);
 
                 echo "
@@ -340 +359 @@
 <div class="tablenav">
         <div class="alignleft">
                 <input type="submit" name="activate-selected" value="<?php _e('Activate') ?>" class="button-secondary" />
+                <input type="submit" name="uninstall-selected" value="<?php _e('Uninstall') ?>" class="button-secondary" />
 <?php if( current_user_can('delete_plugins') ) : ?>
                 <input type="submit" name="delete-selected" value="<?php _e('Delete') ?>" class="button-secondary" />
 <?php endif; ?>
@@ -359 +379 @@
 <div class="tablenav">
         <div class="alignleft">
                 <input type="submit" name="activate-selected" value="<?php _e('Activate') ?>" class="button-secondary" />
+                <input type="submit" name="uninstall-selected" value="<?php _e('Uninstall') ?>" class="button-secondary" />
 <?php if( current_user_can('delete_plugins') ) : ?>
                 <input type="submit" name="delete-selected" value="<?php _e('Delete') ?>" class="button-secondary" />
 <?php endif; ?>

wp-includes/plugin.php

@@ -20 +20 @@
  */
 
 /**
- * add_filter() - Hooks a function or method to a specific filter action.
+ * Hooks a function or method to a specific filter action.
  *
  * Filters are the hooks that WordPress launches to modify text of various types
  * before adding it to the database or sending it to the browser screen. Plugins
@@ -69 +69 @@
 }
 
 /**
- * has_filter() - Check if any filter has been registered for a hook.
+ * Check if any filter has been registered for a hook.
  *
  * @package WordPress
  * @subpackage Plugin
@@ -99 +99 @@
 }
 
 /**
- * apply_filters() - Call the functions added to a filter hook.
+ * Call the functions added to a filter hook.
  *
  * The callback functions attached to filter hook <tt>$tag</tt> are invoked by
  * calling this function. This function can be used to create a new filter hook
@@ -171 +171 @@
 }
 
 /**
- * remove_filter() - Removes a function from a specified filter hook.
+ * Removes a function from a specified filter hook.
  *
  * This function removes a function attached to a specified filter hook. This
  * method can be used to remove default functions attached to a specific filter
  * hook and possibly replace them with a substitute.
  *
- * To remove a hook, the <tt>$function_to_remove</tt> and <tt>$priority</tt> arguments
- * must match when the hook was added. This goes for both filters and actions. No warning
+ * To remove a hook, the $function_to_remove and $priority arguments must match
+ * when the hook was added. This goes for both filters and actions. No warning
  * will be given on removal failure.
  *
  * @package WordPress
@@ -208 +208 @@
 
 
 /**
- * current_filter() - Return the name of the current filter or action.
+ * Return the name of the current filter or action.
  *
  * @package WordPress
  * @subpackage Plugin
@@ -223 +223 @@
 
 
 /**
- * add_action() - Hooks a function on to a specific action.
+ * Hooks a function on to a specific action.
  *
  * Actions are the hooks that the WordPress core launches at specific points
  * during execution, or when specific events occur. Plugins can specify that
@@ -247 +247 @@
 
 
 /**
- * do_action() - Execute functions hooked on a specific action hook.
+ * Execute functions hooked on a specific action hook.
  *
  * This function invokes all functions attached to action hook <tt>$tag</tt>.
  * It is possible to create new action hooks by simply calling this function,
@@ -316 +316 @@
 }
 
 /**
- * did_action() - Return the number times an action is fired.
+ * Return the number times an action is fired.
  *
  * @package WordPress
  * @subpackage Plugin
@@ -336 +336 @@
 }
 
 /**
- * do_action_ref_array() - Execute functions hooked on a specific action hook, specifying arguments in an array.
+ * Execute functions hooked on a specific action hook, specifying arguments in an array.
  *
  * @see do_action() This function is identical, but the arguments passed to
  * the functions hooked to <tt>$tag</tt> are supplied using an array.
@@ -391 +391 @@
 }
 
 /**
- * has_action() - Check if any action has been registered for a hook.
+ * Check if any action has been registered for a hook.
  *
  * @package WordPress
  * @subpackage Plugin
@@ -407 +407 @@
 }
 
 /**
- * remove_action() - Removes a function from a specified action hook.
+ * Removes a function from a specified action hook.
  *
  * This function removes a function attached to a specified action hook. This
  * method can be used to remove default functions attached to a specific filter
@@ -432 +432 @@
 //
 
 /**
- * plugin_basename() - Gets the basename of a plugin.
+ * Gets the basename of a plugin.
  *
  * This method extracts the name of a plugin from its filename.
  *
@@ -456 +456 @@
 }
 
 /**
- * register_activation_hook() - Hook a function on a plugin activation action hook.
+ * Set the activation hook for a plugin.
  *
  * When a plugin is activated, the action 'activate_PLUGINNAME' hook is
  * activated. In the name of this hook, PLUGINNAME is replaced with the name of
@@ -474 +474 @@
  * @access private
  *
  * @param string $file The filename of the plugin including the path.
- * @param string $function the function hooked to the 'activate_PLUGIN' action.
+ * @param callback $function the function hooked to the 'activate_PLUGIN' action.
  */
 function register_activation_hook($file, $function) {
         $file = plugin_basename($file);
@@ -482 +482 @@
 }
 
 /**
- * register_deactivation_hook() - Hook a function on a plugin deactivation action hook.
+ * Set the deactivation hook for a plugin.
  *
  * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is
- * deactivated. In the name of this hook, PLUGINNAME is replaced with the name of
- * the plugin, including the optional subdirectory. For example, when the plugin
- * is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then the
- * name of this hook will become 'activate_sampleplugin/sample.php'.
+ * deactivated. In the name of this hook, PLUGINNAME is replaced with the name
+ * of the plugin, including the optional subdirectory. For example, when the
+ * plugin is located in <tt>wp-content/plugin/sampleplugin/sample.php</tt>, then
+ * the name of this hook will become 'activate_sampleplugin/sample.php'.
+ *
  * When the plugin consists of only one file and is (as by default) located at
  * <tt>wp-content/plugin/sample.php</tt> the name of this hook will be
  * 'activate_sample.php'.
@@ -500 +501 @@
  * @access private
  *
  * @param string $file The filename of the plugin including the path.
- * @param string $function the function hooked to the 'activate_PLUGIN' action.
+ * @param callback $function the function hooked to the 'activate_PLUGIN' action.
  */
 function register_deactivation_hook($file, $function) {
         $file = plugin_basename($file);
@@ -508 +509 @@
 }
 
 /**
- * _wp_call_all_hook() - Calls the 'all' hook, which will process the functions hooked into it.
+ * Set the uninstallation hook for a plugin.
  *
- * The 'all' hook passes all of the arguments or parameters that were used for the
- * hook, which this function was called for.
+ * Registers the uninstall hook that will be called when the user clicks on the
+ * uninstall link that calls for the plugin to uninstall itself. The link won't
+ * be active unless the plugin hooks into the action.
  *
- * This function is used internally for apply_filters(), do_action(), and do_action_ref_array()
- * and is not meant to be used from outside those functions. This function does not check for the
- * existence of the all hook, so it will fail unless the all hook exists prior to this function call.
+ * The plugin should not run arbitrary code outside of functions, when
+ * registering the uninstall hook. In order to run using the hook, the plugin
+ * will have to be included, which means that any code laying outside of a
+ * function will be run during the uninstall process. The plugin should not
+ * hinder the uninstall process.
  *
+ * If the plugin can not be written without running code within the plugin, then
+ * the plugin should create a file named 'uninstall.php' in the base plugin
+ * folder. This file will be called, if it exists, during the uninstall process
+ * bypassing the uninstall hook. The plugin, when using the 'uninstall.php'
+ * should always check for the 'WP_UNINSTALLING_PLUGIN' constant, before
+ * executing.
+ *
+ * @param string $file
+ * @param callback $callback The callback to run when the hook is called.
+ */
+function register_uninstall_hook($file, $callback) {
+        // The option should not be autoloaded, because it is not needed in most
+        // cases. Emphasis should be put on using the 'uninstall.php' way of
+        // uninstalling the plugin.
+        $uninstallable_plugins = (array) get_option('uninstall_plugins');
+        $uninstallable_plugins[$file] = $callback;
+        set_option('uninstall_plugins', $uninstallable_plugins);
+}
+
+/**
+ * Calls the 'all' hook, which will process the functions hooked into it.
+ *
+ * The 'all' hook passes all of the arguments or parameters that were used for
+ * the hook, which this function was called for.
+ *
+ * This function is used internally for apply_filters(), do_action(), and
+ * do_action_ref_array() and is not meant to be used from outside those
+ * functions. This function does not check for the existence of the all hook, so
+ * it will fail unless the all hook exists prior to this function call.
+ *
  * @package WordPress
  * @subpackage Plugin
  * @since 2.5
@@ -540 +574 @@
 }
 
 /**
- * _wp_filter_build_unique_id() - Build Unique ID for storage and retrieval
+ * Build Unique ID for storage and retrieval.
  *
  * The old way to serialize the callback caused issues and this function is the
  * solution. It works by checking for objects and creating an a new property in
@@ -549 +583 @@
  *
  * It also allows for the removal of actions and filters for objects after they
  * change class properties. It is possible to include the property $wp_filter_id
- * in your class and set it to "null" or a number to bypass the workaround. However
- * this will prevent you from adding new classes and any new classes will overwrite
- * the previous hook by the same class.
+ * in your class and set it to "null" or a number to bypass the workaround.
+ * However this will prevent you from adding new classes and any new classes
+ * will overwrite the previous hook by the same class.
  *
- * Functions and static method callbacks are just returned as strings and shouldn't
- * have any speed penalty.
+ * Functions and static method callbacks are just returned as strings and
+ * shouldn't have any speed penalty.
  *
  * @package WordPress
  * @subpackage Plugin