WordPress 4.0
[autoinstalls/wordpress.git] / wp-admin / includes / plugin.php
index 89ebdea83d4efdfb6525cb5dc650f7624449d60a..209b5c9408950fb366d6749bca123896c45d9bcd 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'] ) {
@@ -157,10 +160,10 @@ function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup
        // Apply markup
        if ( $markup ) {
                if ( $plugin_data['PluginURI'] && $plugin_data['Name'] )
-                       $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin homepage' ) . '">' . $plugin_data['Name'] . '</a>';
+                       $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '">' . $plugin_data['Name'] . '</a>';
 
                if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] )
-                       $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '" title="' . esc_attr__( 'Visit author homepage' ) . '">' . $plugin_data['Author'] . '</a>';
+                       $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '">' . $plugin_data['Author'] . '</a>';
 
                $plugin_data['Description'] = wptexturize( $plugin_data['Description'] );
 
@@ -521,6 +524,7 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
        if ( is_multisite() && ( $network_wide || is_network_only_plugin($plugin) ) ) {
                $network_wide = true;
                $current = get_site_option( 'active_sitewide_plugins', array() );
+               $_GET['networkwide'] = 1; // Back compat for plugins looking for this value.
        } else {
                $current = get_option( 'active_plugins', array() );
        }
@@ -533,10 +537,41 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
                if ( !empty($redirect) )
                        wp_redirect(add_query_arg('_error_nonce', wp_create_nonce('plugin-activation-error_' . $plugin), $redirect)); // we'll override this later if the plugin can be included without fatal error
                ob_start();
-               include_once(WP_PLUGIN_DIR . '/' . $plugin);
+               wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
+               $_wp_plugin_file = $plugin;
+               include_once( WP_PLUGIN_DIR . '/' . $plugin );
+               $plugin = $_wp_plugin_file; // Avoid stomping of the $plugin variable in a plugin.
 
                if ( ! $silent ) {
+                       /**
+                        * Fires before a plugin is activated.
+                        *
+                        * If a plugin is silently activated (such as during an update),
+                        * this hook does not fire.
+                        *
+                        * @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 as a specific plugin is being deactivated.
+                        *
+                        * This hook is the "deactivation" hook used internally by
+                        * register_deactivation_hook(). The dynamic portion of the
+                        * hook name, $plugin. refers to the plugin basename.
+                        *
+                        * If a plugin is silently activated (such as during an update),
+                        * this hook does not fire.
+                        *
+                        * @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 );
                }
 
@@ -550,6 +585,18 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silen
                }
 
                if ( ! $silent ) {
+                       /**
+                        * Fires after a plugin has been activated.
+                        *
+                        * If a plugin is silently activated (such as during an update),
+                        * this hook does not fire.
+                        *
+                        * @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 );
                }
 
@@ -572,9 +619,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() )
@@ -589,8 +636,21 @@ 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 before a plugin is deactivated.
+                        *
+                        * If a plugin is silently deactivated (such as during an update),
+                        * this hook does not fire.
+                        *
+                        * @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 ) ) {
@@ -605,12 +665,40 @@ 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 as a specific plugin is being deactivated.
+                        *
+                        * This hook is the "deactivation" hook used internally by
+                        * register_deactivation_hook(). The dynamic portion of the
+                        * hook name, $plugin. refers to the plugin basename.
+                        *
+                        * If a plugin is silently deactivated (such as during an update),
+                        * this hook does not fire.
+                        *
+                        * @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 after a plugin is deactivated.
+                        *
+                        * If a plugin is silently deactivated (such as during an update),
+                        * this hook does not fire.
+                        *
+                        * @since 2.9.0
+                        *
+                        * @param string $plugin               Plugin basename.
+                        * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
+                        *                                     or just the current site. Multisite only. Default false.
+                        */
                        do_action( 'deactivated_plugin', $plugin, $network_deactivating );
                }
        }
@@ -631,7 +719,7 @@ function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
  *
  * @since 2.6.0
  *
- * @param string|array $plugins
+ * @param string|array $plugins Single plugin or list of plugins to activate.
  * @param string $redirect Redirect to page after successful activation.
  * @param bool $network_wide Whether to enable the plugin for all sites in the network.
  * @param bool $silent Prevent calling activation hooks. Default is false.
@@ -657,18 +745,16 @@ function activate_plugins( $plugins, $redirect = '', $network_wide = false, $sil
 }
 
 /**
- * Remove directory and files of a plugin for a single or list of plugin(s).
- *
- * If the plugins parameter list is empty, false will be returned. True when
- * completed.
+ * Remove directory and files of a plugin for a list of plugins.
  *
  * @since 2.6.0
  *
- * @param array $plugins List of plugin
- * @param string $redirect Redirect to page when complete.
- * @return mixed
+ * @param array  $plugins    List of plugins to delete.
+ * @param string $deprecated Deprecated.
+ * @return bool|null|WP_Error True on success, false is $plugins is empty, WP_Error on failure.
+ *                            Null if filesystem credentials are required to proceed.
  */
-function delete_plugins($plugins, $redirect = '' ) {
+function delete_plugins( $plugins, $deprecated = '' ) {
        global $wp_filesystem;
 
        if ( empty($plugins) )
@@ -727,7 +813,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);
@@ -736,15 +822,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;
 }
 
@@ -759,13 +851,13 @@ function delete_plugins($plugins, $redirect = '' ) {
  */
 function validate_active_plugins() {
        $plugins = get_option( 'active_plugins', array() );
-       // validate vartype: array
+       // Validate vartype: array.
        if ( ! is_array( $plugins ) ) {
                update_option( 'active_plugins', array() );
                $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 ) );
        }
@@ -775,7 +867,7 @@ function validate_active_plugins() {
 
        $invalid = array();
 
-       // invalid plugins get deactivated
+       // Invalid plugins get deactivated.
        foreach ( $plugins as $plugin ) {
                $result = validate_plugin( $plugin );
                if ( is_wp_error( $result ) ) {
@@ -847,7 +939,8 @@ function uninstall_plugin($plugin) {
                unset($uninstallable_plugins);
 
                define('WP_UNINSTALL_PLUGIN', $file);
-               include WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php';
+               wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . dirname( $file ) );
+               include( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' );
 
                return true;
        }
@@ -858,9 +951,19 @@ function uninstall_plugin($plugin) {
                update_option('uninstall_plugins', $uninstallable_plugins);
                unset($uninstallable_plugins);
 
-               include WP_PLUGIN_DIR . '/' . $file;
+               wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );
+               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 );
        }
 }
@@ -883,7 +986,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-chart-pie'.
+ *     * 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
@@ -900,12 +1007,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 = 'dashicons-admin-generic';
+               $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;
@@ -1009,14 +1119,16 @@ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability,
                return false;
        }
 
-       // If the parent doesn't already have a submenu, add a link to the parent
-       // as the first item in the submenu. If the submenu file is the same as the
-       // parent file someone is trying to link back to the parent manually. In
-       // this case, don't automatically add a link back to avoid duplication.
+       /*
+        * If the parent doesn't already have a submenu, add a link to the parent
+        * as the first item in the submenu. If the submenu file is the same as the
+        * parent file someone is trying to link back to the parent manually. In
+        * this case, don't automatically add a link back to avoid duplication.
+        */
        if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug ) {
                foreach ( (array)$menu as $parent_menu ) {
                        if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) )
-                               $submenu[$parent_slug][] = $parent_menu;
+                               $submenu[$parent_slug][] = array_slice( $parent_menu, 0, 4 );
                }
        }
 
@@ -1027,11 +1139,15 @@ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability,
                add_action( $hookname, $function );
 
        $_registered_pages[$hookname] = true;
-       // backwards-compatibility for plugins using add_management page. See wp-admin/admin.php for redirect from edit.php to tools.php
+
+       /*
+        * Backward-compatibility for plugins using add_management page.
+        * See wp-admin/admin.php for redirect from edit.php to tools.php
+        */
        if ( 'tools.php' == $parent_slug )
                $_registered_pages[get_plugin_page_hookname( $menu_slug, 'edit.php')] = true;
 
-       // No parent as top level
+       // No parent as top level.
        $_parent_pages[$menu_slug] = $parent_slug;
 
        return $hookname;
@@ -1322,7 +1438,7 @@ function remove_submenu_page( $menu_slug, $submenu_slug ) {
  *
  * If the slug hasn't been registered properly no url will be returned
  *
- * @since 3.0
+ * @since 3.0.0
  *
  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
  * @param bool $echo Whether or not to echo the url - default is true
@@ -1371,15 +1487,6 @@ function get_admin_page_parent( $parent = '' ) {
                return $parent;
        }
 
-       /*
-       if ( !empty ( $parent_file ) ) {
-               if ( isset( $_wp_real_parent_file[$parent_file] ) )
-                       $parent_file = $_wp_real_parent_file[$parent_file];
-
-               return $parent_file;
-       }
-       */
-
        if ( $pagenow == 'admin.php' && isset( $plugin_page ) ) {
                foreach ( (array)$menu as $parent_menu ) {
                        if ( $parent_menu[2] == $plugin_page ) {
@@ -1623,10 +1730,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 );
@@ -1646,10 +1758,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 ] );
@@ -1746,3 +1863,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' );
+}