WordPress 3.8
[autoinstalls/wordpress.git] / wp-admin / includes / plugin.php
index 083b5c429dfd2adf8dde292cd5f3a39003c9bfc6..8095cd4330ea4a34544e9e4d2303087290d9977b 100644 (file)
@@ -114,6 +114,9 @@ function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
  */
 function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
 
+       // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path
+       $plugin_file = plugin_basename( $plugin_file );
+
        // Translate fields
        if ( $translate ) {
                if ( $textdomain = $plugin_data['TextDomain'] ) {
@@ -537,7 +540,28 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
                include_once(WP_PLUGIN_DIR . '/' . $plugin);
 
                if ( ! $silent ) {
+                       /**
+                        * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false.
+                        *
+                        * @since 2.9.0
+                        *
+                        * @param string $plugin       Plugin path to main plugin file with plugin data.
+                        * @param bool   $network_wide Whether to enable the plugin for all sites in the network
+                        *                             or just the current site. Multisite only. Default is false.
+                        */
                        do_action( 'activate_plugin', $plugin, $network_wide );
+
+                       /**
+                        * Fires before a plugin is activated in activate_plugin() when the $silent parameter is false.
+                        *
+                        * The action concatenates the 'activate_' prefix with the $plugin value passed to
+                        * activate_plugin() to create a dynamically-named action.
+                        *
+                        * @since 2.0.0
+                        *
+                        * @param bool $network_wide Whether to enable the plugin for all sites in the network
+                        *                           or just the current site. Multisite only. Default is false.
+                        */
                        do_action( 'activate_' . $plugin, $network_wide );
                }
 
@@ -551,6 +575,15 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
                }
 
                if ( ! $silent ) {
+                       /**
+                        * Fires after a plugin has been activated in activate_plugin() when the $silent parameter is false.
+                        *
+                        * @since 2.9.0
+                        *
+                        * @param string $plugin       Plugin path to main plugin file with plugin data.
+                        * @param bool   $network_wide Whether to enable the plugin for all sites in the network
+                        *                             or just the current site. Multisite only. Default is false.
+                        */
                        do_action( 'activated_plugin', $plugin, $network_wide );
                }
 
@@ -573,9 +606,9 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
  * @since 2.5.0
  *
  * @param string|array $plugins Single plugin or list of plugins to deactivate.
+ * @param bool $silent Prevent calling deactivation hooks. Default is false.
  * @param mixed $network_wide Whether to deactivate the plugin for all sites in the network.
  *     A value of null (the default) will deactivate plugins for both the site and the network.
- * @param bool $silent Prevent calling deactivation hooks. Default is false.
  */
 function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
        if ( is_multisite() )
@@ -590,8 +623,19 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
 
                $network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
 
-               if ( ! $silent )
+               if ( ! $silent ) {
+                       /**
+                        * Fires for each plugin being deactivated in deactivate_plugins(), before deactivation
+                        * and when the $silent parameter is false.
+                        *
+                        * @since 2.9.0
+                        *
+                        * @param string $plugin               Plugin path to main plugin file with plugin data.
+                        * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
+                        *                                     or just the current site. Multisite only. Default is false.
+                        */
                        do_action( 'deactivate_plugin', $plugin, $network_deactivating );
+               }
 
                if ( false !== $network_wide ) {
                        if ( is_plugin_active_for_network( $plugin ) ) {
@@ -606,12 +650,35 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
                        $key = array_search( $plugin, $current );
                        if ( false !== $key ) {
                                $do_blog = true;
-                               array_splice( $current, $key, 1 );
+                               unset( $current[ $key ] );
                        }
                }
 
                if ( ! $silent ) {
+                       /**
+                        * Fires for each plugin being deactivated in deactivate_plugins(), after deactivation
+                        * and when the $silent parameter is false.
+                        *
+                        * The action concatenates the 'deactivate_' prefix with the plugin's basename
+                        * to create a dynamically-named action.
+                        *
+                        * @since 2.0.0
+                        *
+                        * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
+                        *                                   or just the current site. Multisite only. Default is false.
+                        */
                        do_action( 'deactivate_' . $plugin, $network_deactivating );
+
+                       /**
+                        * Fires for each plugin being deactivated in deactivate_plugins(), after deactivation
+                        * and when the $silent parameter is false.
+                        *
+                        * @since 2.9.0
+                        *
+                        * @param string $plugin               Plugin path to main plugin file with plugin data.
+                        * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
+                        *                                     or just the current site. Multisite only. Default is false.
+                        */
                        do_action( 'deactivated_plugin', $plugin, $network_deactivating );
                }
        }
@@ -728,7 +795,7 @@ function delete_plugins($plugins, $redirect = '' ) {
 
                $this_plugin_dir = trailingslashit( dirname($plugins_dir . $plugin_file) );
                // If plugin is in its own directory, recursively delete the directory.
-               if ( strpos($plugin_file, '/') && $this_plugin_dir != $plugins_dir ) //base check on if plugin includes directory separator AND that its not the root plugin folder
+               if ( strpos($plugin_file, '/') && $this_plugin_dir != $plugins_dir ) //base check on if plugin includes directory separator AND that it's not the root plugin folder
                        $deleted = $wp_filesystem->delete($this_plugin_dir, true);
                else
                        $deleted = $wp_filesystem->delete($plugins_dir . $plugin_file);
@@ -737,15 +804,21 @@ function delete_plugins($plugins, $redirect = '' ) {
                        $errors[] = $plugin_file;
        }
 
-       if ( ! empty($errors) )
-               return new WP_Error('could_not_remove_plugin', sprintf(__('Could not fully remove the plugin(s) %s.'), implode(', ', $errors)) );
-
-       // Force refresh of plugin update information
+       // Remove deleted plugins from the plugin updates list.
        if ( $current = get_site_transient('update_plugins') ) {
-               unset( $current->response[ $plugin_file ] );
-               set_site_transient('update_plugins', $current);
+               // Don't remove the plugins that weren't deleted.
+               $deleted = array_diff( $plugins, $errors );
+
+               foreach ( $deleted as $plugin_file ) {
+                       unset( $current->response[ $plugin_file ] );
+               }
+
+               set_site_transient( 'update_plugins', $current );
        }
 
+       if ( ! empty($errors) )
+               return new WP_Error('could_not_remove_plugin', sprintf(__('Could not fully remove the plugin(s) %s.'), implode(', ', $errors)) );
+
        return true;
 }
 
@@ -766,7 +839,7 @@ function validate_active_plugins() {
                $plugins = array();
        }
 
-       if ( is_multisite() && is_super_admin() ) {
+       if ( is_multisite() && current_user_can( 'manage_network_plugins' ) ) {
                $network_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
                $plugins = array_merge( $plugins, array_keys( $network_plugins ) );
        }
@@ -862,6 +935,15 @@ function uninstall_plugin($plugin) {
                include WP_PLUGIN_DIR . '/' . $file;
 
                add_action( 'uninstall_' . $file, $callable );
+
+               /**
+                * Fires in uninstall_plugin() once the plugin has been uninstalled.
+                *
+                * The action concatenates the 'uninstall_' prefix with the basename of the
+                * plugin passed to {@see uninstall_plugin()} to create a dynamically-named action.
+                *
+                * @since 2.7.0
+                */
                do_action( 'uninstall_' . $file );
        }
 }
@@ -884,7 +966,11 @@ function uninstall_plugin($plugin) {
  * @param string $capability The capability required for this menu to be displayed to the user.
  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
  * @param callback $function The function to be called to output the content for this page.
- * @param string $icon_url The url to the icon to be used for this menu
+ * @param string $icon_url The url to the icon to be used for this menu.
+ *     * Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme.
+ *       This should begin with 'data:image/svg+xml;base64,'.
+ *     * Pass the name of a Dashicons helper class to use a font icon, e.g. 'dashicons-piechart'.
+ *     * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.
  * @param int $position The position in the menu order this one should appear
  *
  * @return string The resulting page's hook_suffix
@@ -901,12 +987,15 @@ function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $func
        if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
                add_action( $hookname, $function );
 
-       if ( empty($icon_url) )
-               $icon_url = esc_url( admin_url( 'images/generic.png' ) );
-       elseif ( is_ssl() && 0 === strpos($icon_url, 'http://') )
-               $icon_url = 'https://' . substr($icon_url, 7);
+       if ( empty($icon_url) ) {
+               $icon_url = 'none';
+               $icon_class = 'menu-icon-generic ';
+       } else {
+               $icon_url = set_url_scheme( $icon_url );
+               $icon_class = '';
+       }
 
-       $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $hookname, $hookname, $icon_url );
+       $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $icon_class . $hookname, $hookname, $icon_url );
 
        if ( null === $position )
                $menu[] = $new_menu;
@@ -1624,10 +1713,15 @@ function register_setting( $option_group, $option_name, $sanitize_callback = ''
        global $new_whitelist_options;
 
        if ( 'misc' == $option_group ) {
-               _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
+               _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
                $option_group = 'general';
        }
 
+       if ( 'privacy' == $option_group ) {
+               _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
+               $option_group = 'reading';
+       }
+
        $new_whitelist_options[ $option_group ][] = $option_name;
        if ( $sanitize_callback != '' )
                add_filter( "sanitize_option_{$option_name}", $sanitize_callback );
@@ -1647,10 +1741,15 @@ function unregister_setting( $option_group, $option_name, $sanitize_callback = '
        global $new_whitelist_options;
 
        if ( 'misc' == $option_group ) {
-               _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
+               _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
                $option_group = 'general';
        }
 
+       if ( 'privacy' == $option_group ) {
+               _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
+               $option_group = 'reading';
+       }
+
        $pos = array_search( $option_name, (array) $new_whitelist_options );
        if ( $pos !== false )
                unset( $new_whitelist_options[ $option_group ][ $pos ] );
@@ -1747,3 +1846,16 @@ function settings_fields($option_group) {
        echo '<input type="hidden" name="action" value="update" />';
        wp_nonce_field("$option_group-options");
 }
+
+/**
+ * Clears the Plugins cache used by get_plugins() and by default, the Plugin Update cache.
+ *
+ * @since 3.7.0
+ *
+ * @param bool $clear_update_cache Whether to clear the Plugin updates cache
+ */
+function wp_clean_plugins_cache( $clear_update_cache = true ) {
+       if ( $clear_update_cache )
+               delete_site_transient( 'update_plugins' );
+       wp_cache_delete( 'plugins', 'plugins' );
+}