site_iri: comparison web/wp-admin/includes/plugin.php

equal deleted inserted replaced

-:2f6f6f7551ca
+:32102edaa81b
 * Domain Path: Optional. Only useful if the translations are located in a
 *		folder above the plugin's base path. For example, if .mo files are
 *		located in the locale folder then Domain Path will be "/locale/" and
 *		must have the first slash. Defaults to the base folder the plugin is
 *		located in.
+* Network: Optional. Specify "Network: true" to require that a plugin is activated
+*		across all sites in an installation. This will prevent a plugin from being
+*		activated on a single site when Multisite is enabled.
 *  * / # Remove the space to close comment
 * </code>
 *
 * Plugin data returned array contains the following:
 *		'Name' - Name of the plugin, must be unique.
 *		'AuthorURI' - The authors web site address.
 *		'Version' - The plugin version number.
 *		'PluginURI' - Plugin web site address.
 *		'TextDomain' - Plugin's text domain for localization.
 *		'DomainPath' - Plugin's relative directory path to .mo files.
+*		'Network' - Boolean. Whether the plugin can only be activated network wide.
 *
 * Some users have issues with opening large files and manipulating the contents
 * for want is usually the first 1kiB or 2kiB. This function stops pulling in
 * the plugin contents when it has all of the required plugin data.
 *
 * @link http://trac.wordpress.org/ticket/5651 Previous Optimizations.
 * @link http://trac.wordpress.org/ticket/7372 Further and better Optimizations.
 * @since 1.5.0
 *
 * @param string $plugin_file Path to the plugin file
-* @param bool $markup If the returned data should have HTML markup applied
+* @param bool $markup Optional. If the returned data should have HTML markup applied. Defaults to true.
-* @param bool $translate If the returned data should be translated
+* @param bool $translate Optional. If the returned data should be translated. Defaults to true.
 * @return array See above for description.
 */
 function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
 	$default_headers = array(
 		'Name' => 'Plugin Name',
 		'PluginURI' => 'Plugin URI',
 		'Version' => 'Version',
 		'Description' => 'Description',
 		'Author' => 'Author',
 		'AuthorURI' => 'Author URI',
 		'TextDomain' => 'Text Domain',
-		'DomainPath' => 'Domain Path'
+		'DomainPath' => 'Domain Path',
-		);
+		'Network' => 'Network',
+		// Site Wide Only is deprecated in favor of Network.
+		'_sitewide' => 'Site Wide Only',
+	);
 	$plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
-	//For backward compatibility by default Title is the same as Name.
+	// Site Wide Only is the old header for Network
-	$plugin_data['Title'] = $plugin_data['Name'];
+	if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
+		_deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The <code>%1$s</code> plugin header is deprecated. Use <code>%2$s</code> instead.' ), 'Site Wide Only: true', 'Network: true' ) );
-	if ( $markup || $translate )
+		$plugin_data['Network'] = $plugin_data['_sitewide'];
+	}
+	$plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
+	unset( $plugin_data['_sitewide'] );
+	if ( $markup || $translate ) {
 		$plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
+	} else {
+		$plugin_data['Title']      = $plugin_data['Name'];
+		$plugin_data['AuthorName'] = $plugin_data['Author'];
+	}
 	return $plugin_data;
 }
-function _get_plugin_data_markup_translate($plugin_file, $plugin_data, $markup = true, $translate = true) {
+/**
+* Sanitizes plugin data, optionally adds markup, optionally translates.
-	//Translate fields
+*
-	if( $translate && ! empty($plugin_data['TextDomain']) ) {
+* @since 2.7.0
-		if( ! empty( $plugin_data['DomainPath'] ) )
+* @access private
-			load_plugin_textdomain($plugin_data['TextDomain'], false, dirname($plugin_file). $plugin_data['DomainPath']);
+* @see get_plugin_data()
-		else
+*/
-			load_plugin_textdomain($plugin_data['TextDomain'], false, dirname($plugin_file));
+function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
-		foreach ( array('Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version') as $field )
+	// Translate fields
-			$plugin_data[ $field ] = translate($plugin_data[ $field ], $plugin_data['TextDomain']);
+	if ( $translate ) {
-	}
+		if ( $textdomain = $plugin_data['TextDomain'] ) {
+			if ( $plugin_data['DomainPath'] )
-	//Apply Markup
+				load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] );
+			else
+				load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) );
+		} elseif ( in_array( basename( $plugin_file ), array( 'hello.php', 'akismet.php' ) ) ) {
+			$textdomain = 'default';
+		}
+		if ( $textdomain ) {
+			foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field )
+				$plugin_data[ $field ] = translate( $plugin_data[ $field ], $textdomain );
+		}
+	}
+	// Sanitize fields
+	$allowed_tags = $allowed_tags_in_links = array(
+		'abbr'    => array( 'title' => true ),
+		'acronym' => array( 'title' => true ),
+		'code'    => true,
+		'em'      => true,
+		'strong'  => true,
+	);
+	$allowed_tags['a'] = array( 'href' => true, 'title' => true );
+	// Name is marked up inside <a> tags. Don't allow these.
+	// Author is too, but some plugins have used <a> here (omitting Author URI).
+	$plugin_data['Name']        = wp_kses( $plugin_data['Name'],        $allowed_tags_in_links );
+	$plugin_data['Author']      = wp_kses( $plugin_data['Author'],      $allowed_tags );
+	$plugin_data['Description'] = wp_kses( $plugin_data['Description'], $allowed_tags );
+	$plugin_data['Version']     = wp_kses( $plugin_data['Version'],     $allowed_tags );
+	$plugin_data['PluginURI']   = esc_url( $plugin_data['PluginURI'] );
+	$plugin_data['AuthorURI']   = esc_url( $plugin_data['AuthorURI'] );
+	$plugin_data['Title']      = $plugin_data['Name'];
+	$plugin_data['AuthorName'] = $plugin_data['Author'];
+	// Apply markup
 	if ( $markup ) {
-		if ( ! empty($plugin_data['PluginURI']) && ! empty($plugin_data['Name']) )
+		if ( $plugin_data['PluginURI'] && $plugin_data['Name'] )
-			$plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . __( 'Visit plugin homepage' ) . '">' . $plugin_data['Name'] . '</a>';
+			$plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin homepage' ) . '">' . $plugin_data['Name'] . '</a>';
-		else
-			$plugin_data['Title'] = $plugin_data['Name'];
+		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>';
-		if ( ! empty($plugin_data['AuthorURI']) && ! empty($plugin_data['Author']) )
-			$plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '" title="' . __( 'Visit author homepage' ) . '">' . $plugin_data['Author'] . '</a>';
 		$plugin_data['Description'] = wptexturize( $plugin_data['Description'] );
-		if( ! empty($plugin_data['Author']) )
-			$plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s'), $plugin_data['Author'] ) . '.</cite>';
+		if ( $plugin_data['Author'] )
-	}
+			$plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s.'), $plugin_data['Author'] ) . '</cite>';
+	}
-	$plugins_allowedtags = array('a' => array('href' => array(),'title' => array()),'abbr' => array('title' => array()),'acronym' => array('title' => array()),'code' => array(),'em' => array(),'strong' => array());
-	// Sanitize all displayed data
-	$plugin_data['Title']       = wp_kses($plugin_data['Title'], $plugins_allowedtags);
-	$plugin_data['Version']     = wp_kses($plugin_data['Version'], $plugins_allowedtags);
-	$plugin_data['Description'] = wp_kses($plugin_data['Description'], $plugins_allowedtags);
-	$plugin_data['Author']      = wp_kses($plugin_data['Author'], $plugins_allowedtags);
 	return $plugin_data;
 }
 /**
 * needs to have the main execution for the plugin. This does not mean
 * everything must be contained in the file and it is recommended that the file
 * be split for maintainability. Keep everything in one file for extreme
 * optimization purposes.
 *
-* @since unknown
+* @since 1.5.0
 *
 * @param string $plugin_folder Optional. Relative path to single plugin folder.
 * @return array Key is the plugin file path and the value is an array of the plugin data.
 */
 function get_plugins($plugin_folder = '') {
 	if ( isset($cache_plugins[ $plugin_folder ]) )
 		return $cache_plugins[ $plugin_folder ];
 	$wp_plugins = array ();
 	$plugin_root = WP_PLUGIN_DIR;
-	if( !empty($plugin_folder) )
+	if ( !empty($plugin_folder) )
 		$plugin_root .= $plugin_folder;
 	// Files in wp-content/plugins directory
 	$plugins_dir = @ opendir( $plugin_root);
 	$plugin_files = array();
 						if ( substr($subfile, 0, 1) == '.' )
 							continue;
 						if ( substr($subfile, -4) == '.php' )
 							$plugin_files[] = "$file/$subfile";
 					}
+					closedir( $plugins_subdir );
 				}
 			} else {
 				if ( substr($file, -4) == '.php' )
 					$plugin_files[] = $file;
 			}
 		}
-	}
+		closedir( $plugins_dir );
-	@closedir( $plugins_dir );
+	}
-	@closedir( $plugins_subdir );
+	if ( empty($plugin_files) )
-	if ( !$plugins_dir || empty($plugin_files) )
 		return $wp_plugins;
 	foreach ( $plugin_files as $plugin_file ) {
 		if ( !is_readable( "$plugin_root/$plugin_file" ) )
 			continue;
 			continue;
 		$wp_plugins[plugin_basename( $plugin_file )] = $plugin_data;
 	}
-	uasort( $wp_plugins, create_function( '$a, $b', 'return strnatcasecmp( $a["Name"], $b["Name"] );' ));
+	uasort( $wp_plugins, '_sort_uname_callback' );
 	$cache_plugins[ $plugin_folder ] = $wp_plugins;
 	wp_cache_set('plugins', $cache_plugins, 'plugins');
 	return $wp_plugins;
 }
 /**
+* Check the mu-plugins directory and retrieve all mu-plugin files with any plugin data.
+*
+* WordPress only includes mu-plugin files in the base mu-plugins directory (wp-content/mu-plugins).
+*
+* @since 3.0.0
+* @return array Key is the mu-plugin file path and the value is an array of the mu-plugin data.
+*/
+function get_mu_plugins() {
+	$wp_plugins = array();
+	// Files in wp-content/mu-plugins directory
+	$plugin_files = array();
+	if ( ! is_dir( WPMU_PLUGIN_DIR ) )
+		return $wp_plugins;
+	if ( $plugins_dir = @ opendir( WPMU_PLUGIN_DIR ) ) {
+		while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
+			if ( substr( $file, -4 ) == '.php' )
+				$plugin_files[] = $file;
+		}
+	} else {
+		return $wp_plugins;
+	}
+	@closedir( $plugins_dir );
+	if ( empty($plugin_files) )
+		return $wp_plugins;
+	foreach ( $plugin_files as $plugin_file ) {
+		if ( !is_readable( WPMU_PLUGIN_DIR . "/$plugin_file" ) )
+			continue;
+		$plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
+		if ( empty ( $plugin_data['Name'] ) )
+			$plugin_data['Name'] = $plugin_file;
+		$wp_plugins[ $plugin_file ] = $plugin_data;
+	}
+	if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php') <= 30 ) // silence is golden
+		unset( $wp_plugins['index.php'] );
+	uasort( $wp_plugins, '_sort_uname_callback' );
+	return $wp_plugins;
+}
+/**
+* Callback to sort array by a 'Name' key.
+*
+* @since 3.1.0
+* @access private
+*/
+function _sort_uname_callback( $a, $b ) {
+	return strnatcasecmp( $a['Name'], $b['Name'] );
+}
+/**
+* Check the wp-content directory and retrieve all drop-ins with any plugin data.
+*
+* @since 3.0.0
+* @return array Key is the file path and the value is an array of the plugin data.
+*/
+function get_dropins() {
+	$dropins = array();
+	$plugin_files = array();
+	$_dropins = _get_dropins();
+	// These exist in the wp-content directory
+	if ( $plugins_dir = @ opendir( WP_CONTENT_DIR ) ) {
+		while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
+			if ( isset( $_dropins[ $file ] ) )
+				$plugin_files[] = $file;
+		}
+	} else {
+		return $dropins;
+	}
+	@closedir( $plugins_dir );
+	if ( empty($plugin_files) )
+		return $dropins;
+	foreach ( $plugin_files as $plugin_file ) {
+		if ( !is_readable( WP_CONTENT_DIR . "/$plugin_file" ) )
+			continue;
+		$plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
+		if ( empty( $plugin_data['Name'] ) )
+			$plugin_data['Name'] = $plugin_file;
+		$dropins[ $plugin_file ] = $plugin_data;
+	}
+	uksort( $dropins, 'strnatcasecmp' );
+	return $dropins;
+}
+/**
+* Returns drop-ins that WordPress uses.
+*
+* Includes Multisite drop-ins only when is_multisite()
+*
+* @since 3.0.0
+* @return array Key is file name. The value is an array, with the first value the
+*	purpose of the drop-in and the second value the name of the constant that must be
+*	true for the drop-in to be used, or true if no constant is required.
+*/
+function _get_dropins() {
+	$dropins = array(
+		'advanced-cache.php' => array( __( 'Advanced caching plugin.'       ), 'WP_CACHE' ), // WP_CACHE
+		'db.php'             => array( __( 'Custom database class.'         ), true ), // auto on load
+		'db-error.php'       => array( __( 'Custom database error message.' ), true ), // auto on error
+		'install.php'        => array( __( 'Custom install script.'         ), true ), // auto on install
+		'maintenance.php'    => array( __( 'Custom maintenance message.'    ), true ), // auto on maintenance
+		'object-cache.php'   => array( __( 'External object cache.'         ), true ), // auto on load
+	);
+	if ( is_multisite() ) {
+		$dropins['sunrise.php'       ] = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE
+		$dropins['blog-deleted.php'  ] = array( __( 'Custom site deleted message.'   ), true ); // auto on deleted blog
+		$dropins['blog-inactive.php' ] = array( __( 'Custom site inactive message.'  ), true ); // auto on inactive blog
+		$dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // auto on archived or spammed blog
+	}
+	return $dropins;
+}
+/**
 * 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) {
+function is_plugin_active( $plugin ) {
-	return in_array( $plugin, apply_filters( 'active_plugins', get_option( 'active_plugins' ) ) );
+	return in_array( $plugin, (array) get_option( 'active_plugins', array() ) ) || is_plugin_active_for_network( $plugin );
+}
+/**
+* Check whether the plugin is inactive.
+*
+* Reverse of is_plugin_active(). Used as a callback.
+*
+* @since 3.1.0
+* @see is_plugin_active()
+*
+* @param string $plugin Base plugin path from plugins directory.
+* @return bool True if inactive. False if active.
+*/
+function is_plugin_inactive( $plugin ) {
+	return ! is_plugin_active( $plugin );
+}
+/**
+* Check whether the plugin is active for the entire network.
+*
+* @since 3.0.0
+*
+* @param string $plugin Base plugin path from plugins directory.
+* @return bool True, if active for the network, otherwise false.
+*/
+function is_plugin_active_for_network( $plugin ) {
+	if ( !is_multisite() )
+		return false;
+	$plugins = get_site_option( 'active_sitewide_plugins');
+	if ( isset($plugins[$plugin]) )
+		return true;
+	return false;
+}
+/**
+* Checks for "Network: true" in the plugin header to see if this should
+* be activated only as a network wide plugin. The plugin would also work
+* when Multisite is not enabled.
+*
+* Checks for "Site Wide Only: true" for backwards compatibility.
+*
+* @since 3.0.0
+*
+* @param string $plugin Plugin to check
+* @return bool True if plugin is network only, false otherwise.
+*/
+function is_network_only_plugin( $plugin ) {
+	$plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
+	if ( $plugin_data )
+		return $plugin_data['Network'];
+	return false;
 }
 /**
 * Attempts activation of plugin in a "sandbox" and redirects on success.
 *
 * {@source 13 1}
 *
 * If any errors are found or text is outputted, then it will be captured to
 * ensure that the success redirection will update the error redirection.
 *
-* @since unknown
+* @since 2.5.0
 *
 * @param string $plugin Plugin path to main plugin file with plugin data.
 * @param string $redirect Optional. URL to redirect to.
+* @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.
+* @param bool $silent Prevent calling activation hooks. Optional, default is false.
 * @return WP_Error|null WP_Error on invalid file or null on success.
 */
-function activate_plugin($plugin, $redirect = '') {
+function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {
-	$current = get_option('active_plugins');
+	$plugin = plugin_basename( trim( $plugin ) );
-	$plugin = plugin_basename(trim($plugin));
+	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() );
+	}
 	$valid = validate_plugin($plugin);
 	if ( is_wp_error($valid) )
 		return $valid;
 	if ( !in_array($plugin, $current) ) {
 		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(WP_PLUGIN_DIR . '/' . $plugin);
+		include_once(WP_PLUGIN_DIR . '/' . $plugin);
-		$current[] = $plugin;
-		sort($current);
+		if ( ! $silent ) {
-		do_action( 'activate_plugin', trim( $plugin) );
+			do_action( 'activate_plugin', $plugin, $network_wide );
-		update_option('active_plugins', $current);
+			do_action( 'activate_' . $plugin, $network_wide );
-		do_action( 'activate_' . trim( $plugin ) );
+		}
-		do_action( 'activated_plugin', trim( $plugin) );
+		if ( $network_wide ) {
+			$current[$plugin] = time();
+			update_site_option( 'active_sitewide_plugins', $current );
+		} else {
+			$current[] = $plugin;
+			sort($current);
+			update_option('active_plugins', $current);
+		}
+		if ( ! $silent ) {
+			do_action( 'activated_plugin', $plugin, $network_wide );
+		}
+		if ( ob_get_length() > 0 ) {
+			$output = ob_get_clean();
+			return new WP_Error('unexpected_output', __('The plugin generated unexpected output.'), $output);
+		}
 		ob_end_clean();
 	}
 	return null;
 }
 * Deactivate a single plugin or multiple plugins.
 *
 * The deactivation hook is disabled by the plugin upgrader by using the $silent
 * parameter.
 *
-* @since unknown
+* @since 2.5.0
 *
 * @param string|array $plugins Single plugin or list of plugins to deactivate.
-* @param bool $silent Optional, default is false. Prevent calling deactivate hook.
+* @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.
-function deactivate_plugins($plugins, $silent= false) {
+* @param bool $silent Prevent calling deactivation hooks. Default is false.
-	$current = get_option('active_plugins');
+*/
+function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
+	if ( is_multisite() )
+		$network_current = get_site_option( 'active_sitewide_plugins', array() );
+	$current = get_option( 'active_plugins', array() );
+	$do_blog = $do_network = false;
+	foreach ( (array) $plugins as $plugin ) {
+		$plugin = plugin_basename( trim( $plugin ) );
+		if ( ! is_plugin_active($plugin) )
+			continue;
+		$network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
+		if ( ! $silent )
+			do_action( 'deactivate_plugin', $plugin, $network_deactivating );
+		if ( false !== $network_wide ) {
+			if ( is_plugin_active_for_network( $plugin ) ) {
+				$do_network = true;
+				unset( $network_current[ $plugin ] );
+			} elseif ( $network_wide ) {
+				continue;
+			}
+		}
+		if ( true !== $network_wide ) {
+			$key = array_search( $plugin, $current );
+			if ( false !== $key ) {
+				$do_blog = true;
+				array_splice( $current, $key, 1 );
+			}
+		}
+		if ( ! $silent ) {
+			do_action( 'deactivate_' . $plugin, $network_deactivating );
+			do_action( 'deactivated_plugin', $plugin, $network_deactivating );
+		}
+	}
+	if ( $do_blog )
+		update_option('active_plugins', $current);
+	if ( $do_network )
+		update_site_option( 'active_sitewide_plugins', $network_current );
+}
+/**
+* Activate multiple plugins.
+*
+* When WP_Error is returned, it does not mean that one of the plugins had
+* errors. It means that one or more of the plugins file path was invalid.
+*
+* The execution will be halted as soon as one of the plugins has an error.
+*
+* @since 2.6.0
+*
+* @param string|array $plugins
+* @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.
+* @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
+*/
+function activate_plugins( $plugins, $redirect = '', $network_wide = false, $silent = false ) {
 	if ( !is_array($plugins) )
 		$plugins = array($plugins);
+	$errors = array();
 	foreach ( $plugins as $plugin ) {
-		$plugin = plugin_basename($plugin);
-		if( ! is_plugin_active($plugin) )
-			continue;
-		if ( ! $silent )
-			do_action( 'deactivate_plugin', trim( $plugin ) );
-		$key = array_search( $plugin, (array) $current );
-		if ( false !== $key )
-			array_splice( $current, $key, 1 );
-		//Used by Plugin updater to internally deactivate plugin, however, not to notify plugins of the fact to prevent plugin output.
-		if ( ! $silent ) {
-			do_action( 'deactivate_' . trim( $plugin ) );
-			do_action( 'deactivated_plugin', trim( $plugin ) );
-		}
-	}
-	update_option('active_plugins', $current);
-}
-/**
-* Activate multiple plugins.
-*
-* When WP_Error is returned, it does not mean that one of the plugins had
-* errors. It means that one or more of the plugins file path was invalid.
-*
-* The execution will be halted as soon as one of the plugins has an error.
-*
-* @since unknown
-*
-* @param string|array $plugins
-* @param string $redirect Redirect to page after successful activation.
-* @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
-*/
-function activate_plugins($plugins, $redirect = '') {
-	if ( !is_array($plugins) )
-		$plugins = array($plugins);
-	$errors = array();
-	foreach ( (array) $plugins as $plugin ) {
 		if ( !empty($redirect) )
 			$redirect = add_query_arg('plugin', $plugin, $redirect);
-		$result = activate_plugin($plugin, $redirect);
+		$result = activate_plugin($plugin, $redirect, $network_wide, $silent);
 		if ( is_wp_error($result) )
 			$errors[$plugin] = $result;
 	}
 	if ( !empty($errors) )
 * 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.
 *
-* @since unknown
+* @since 2.6.0
 *
 * @param array $plugins List of plugin
 * @param string $redirect Redirect to page when complete.
 * @return mixed
 */
 function delete_plugins($plugins, $redirect = '' ) {
 	global $wp_filesystem;
-	if( empty($plugins) )
+	if ( empty($plugins) )
 		return false;
 	$checked = array();
 	foreach( $plugins as $plugin )
 		$checked[] = 'checked[]=' . $plugin;
 	ob_start();
-	$url = wp_nonce_url('plugins.php?action=delete-selected&verify-delete=1&' . implode('&', $checked), 'bulk-manage-plugins');
+	$url = wp_nonce_url('plugins.php?action=delete-selected&verify-delete=1&' . implode('&', $checked), 'bulk-plugins');
 	if ( false === ($credentials = request_filesystem_credentials($url)) ) {
 		$data = ob_get_contents();
 		ob_end_clean();
-		if( ! empty($data) ){
+		if ( ! empty($data) ){
 			include_once( ABSPATH . 'wp-admin/admin-header.php');
 			echo $data;
 			include( ABSPATH . 'wp-admin/admin-footer.php');
 			exit;
 		}
 	if ( ! WP_Filesystem($credentials) ) {
 		request_filesystem_credentials($url, '', true); //Failed to connect, Error and request again
 		$data = ob_get_contents();
 		ob_end_clean();
-		if( ! empty($data) ){
+		if ( ! empty($data) ){
 			include_once( ABSPATH . 'wp-admin/admin-header.php');
 			echo $data;
 			include( ABSPATH . 'wp-admin/admin-footer.php');
 			exit;
 		}
 	if ( ! is_object($wp_filesystem) )
 		return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
 	if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
-		return new WP_Error('fs_error', __('Filesystem error'), $wp_filesystem->errors);
+		return new WP_Error('fs_error', __('Filesystem error.'), $wp_filesystem->errors);
 	//Get the base plugin folder
 	$plugins_dir = $wp_filesystem->wp_plugins_dir();
 	if ( empty($plugins_dir) )
 		return new WP_Error('fs_no_plugins_dir', __('Unable to locate WordPress Plugin directory.'));
 		if ( is_uninstallable_plugin( $plugin_file ) )
 			uninstall_plugin($plugin_file);
 		$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 seperator 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 its not the root plugin folder
 			$deleted = $wp_filesystem->delete($this_plugin_dir, true);
 		else
 			$deleted = $wp_filesystem->delete($plugins_dir . $plugin_file);
 		if ( ! $deleted )
 			$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)) );
+		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
-	if ( $current = get_transient('update_plugins') ) {
+	if ( $current = get_site_transient('update_plugins') ) {
 		unset( $current->response[ $plugin_file ] );
-		set_transient('update_plugins', $current);
+		set_site_transient('update_plugins', $current);
 	}
 	return true;
 }
+/**
+* Validate active plugins
+*
+* Validate all active plugins, deactivates invalid and
+* returns an array of deactivated ones.
+*
+* @since 2.5.0
+* @return array invalid plugins, plugin as key, error as value
+*/
 function validate_active_plugins() {
-	$check_plugins = apply_filters( 'active_plugins', get_option('active_plugins') );
+	$plugins = get_option( 'active_plugins', array() );
+	// validate vartype: array
-	// Sanity check.  If the active plugin list is not an array, make it an
+	if ( ! is_array( $plugins ) ) {
-	// empty array.
+		update_option( 'active_plugins', array() );
-	if ( !is_array($check_plugins) ) {
+		$plugins = array();
-		update_option('active_plugins', array());
+	}
+	if ( is_multisite() && is_super_admin() ) {
+		$network_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
+		$plugins = array_merge( $plugins, array_keys( $network_plugins ) );
+	}
+	if ( empty( $plugins ) )
 		return;
-	}
-	//Invalid is any plugin that is deactivated due to error.
 	$invalid = array();
-	// If a plugin file does not exist, remove it from the list of active
+	// invalid plugins get deactivated
-	// plugins.
+	foreach ( $plugins as $plugin ) {
-	foreach ( $check_plugins as $check_plugin ) {
+		$result = validate_plugin( $plugin );
-		$result = validate_plugin($check_plugin);
 		if ( is_wp_error( $result ) ) {
-			$invalid[$check_plugin] = $result;
+			$invalid[$plugin] = $result;
-			deactivate_plugins( $check_plugin, true);
+			deactivate_plugins( $plugin, true );
 		}
 	}
 	return $invalid;
 }
 /**
 * Validate the plugin path.
 *
 * Checks that the file exists and {@link validate_file() is valid file}.
 *
-* @since unknown
+* @since 2.5.0
 *
 * @param string $plugin Plugin Path
 * @return WP_Error|int 0 on success, WP_Error on failure.
 */
 function validate_plugin($plugin) {
 //
 // Menu
 //
-function add_menu_page( $page_title, $menu_title, $access_level, $file, $function = '', $icon_url = '', $position = NULL ) {
+/**
-	global $menu, $admin_page_hooks, $_registered_pages;
+* Add a top level menu page
+*
-	$file = plugin_basename( $file );
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
-	$admin_page_hooks[$file] = sanitize_title( $menu_title );
+*
+* The function which is hooked in to handle the output of the page must check
-	$hookname = get_plugin_page_hookname( $file, '' );
+* that the user has the required capability as well.
-	if (!empty ( $function ) && !empty ( $hookname ))
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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 int $position The position in the menu order this one should appear
+*
+* @return string The resulting page's hook_suffix
+*/
+function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null ) {
+	global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;
+	$menu_slug = plugin_basename( $menu_slug );
+	$admin_page_hooks[$menu_slug] = sanitize_title( $menu_title );
+	$hookname = get_plugin_page_hookname( $menu_slug, '' );
+	if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
 		add_action( $hookname, $function );
-	if ( empty($icon_url) ) {
+	if ( empty($icon_url) )
-		$icon_url = 'images/generic.png';
+		$icon_url = esc_url( admin_url( 'images/generic.png' ) );
-	} elseif ( is_ssl() && 0 === strpos($icon_url, 'http://') ) {
+	elseif ( is_ssl() && 0 === strpos($icon_url, 'http://') )
 		$icon_url = 'https://' . substr($icon_url, 7);
-	}
+	$new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $hookname, $hookname, $icon_url );
-	$new_menu = array ( $menu_title, $access_level, $file, $page_title, 'menu-top ' . $hookname, $hookname, $icon_url );
+	if ( null === $position )
-	if ( NULL === $position  ) {
 		$menu[] = $new_menu;
-	} else {
+	else
 		$menu[$position] = $new_menu;
-	}
 	$_registered_pages[$hookname] = true;
+	// No parent as top level
+	$_parent_pages[$menu_slug] = false;
 	return $hookname;
 }
-function add_object_page( $page_title, $menu_title, $access_level, $file, $function = '', $icon_url = '') {
+/**
+* Add a top level menu page in the 'objects' section
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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
+*
+* @return string The resulting page's hook_suffix
+*/
+function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
 	global $_wp_last_object_menu;
 	$_wp_last_object_menu++;
-	return add_menu_page($page_title, $menu_title, $access_level, $file, $function, $icon_url, $_wp_last_object_menu);
+	return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_object_menu);
 }
-function add_utility_page( $page_title, $menu_title, $access_level, $file, $function = '', $icon_url = '') {
+/**
+* Add a top level menu page in the 'utility' section
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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
+*
+* @return string The resulting page's hook_suffix
+*/
+function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
 	global $_wp_last_utility_menu;
 	$_wp_last_utility_menu++;
-	return add_menu_page($page_title, $menu_title, $access_level, $file, $function, $icon_url, $_wp_last_utility_menu);
+	return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_utility_menu);
 }
-function add_submenu_page( $parent, $page_title, $menu_title, $access_level, $file, $function = '' ) {
+/**
+* Add a sub menu page
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $parent_slug The slug name for the parent menu (or the file name of a standard WordPress admin page)
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
 	global $submenu;
 	global $menu;
 	global $_wp_real_parent_file;
 	global $_wp_submenu_nopriv;
 	global $_registered_pages;
+	global $_parent_pages;
-	$file = plugin_basename( $file );
+	$menu_slug = plugin_basename( $menu_slug );
-	$parent = plugin_basename( $parent);
+	$parent_slug = plugin_basename( $parent_slug);
-	if ( isset( $_wp_real_parent_file[$parent] ) )
-		$parent = $_wp_real_parent_file[$parent];
+	if ( isset( $_wp_real_parent_file[$parent_slug] ) )
+		$parent_slug = $_wp_real_parent_file[$parent_slug];
-	if ( !current_user_can( $access_level ) ) {
-		$_wp_submenu_nopriv[$parent][$file] = true;
+	if ( !current_user_can( $capability ) ) {
+		$_wp_submenu_nopriv[$parent_slug][$menu_slug] = true;
 		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
+	// 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
+	// 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] ) && $file != $parent  ) {
+	if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug ) {
 		foreach ( (array)$menu as $parent_menu ) {
-			if ( $parent_menu[2] == $parent && current_user_can( $parent_menu[1] ) )
+			if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) )
-				$submenu[$parent][] = $parent_menu;
+				$submenu[$parent_slug][] = $parent_menu;
 		}
 	}
-	$submenu[$parent][] = array ( $menu_title, $access_level, $file, $page_title );
+	$submenu[$parent_slug][] = array ( $menu_title, $capability, $menu_slug, $page_title );
-	$hookname = get_plugin_page_hookname( $file, $parent);
+	$hookname = get_plugin_page_hookname( $menu_slug, $parent_slug);
 	if (!empty ( $function ) && !empty ( $hookname ))
 		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
+	// backwards-compatibility for plugins using add_management page. See wp-admin/admin.php for redirect from edit.php to tools.php
-	if ( 'tools.php' == $parent )
+	if ( 'tools.php' == $parent_slug )
-		$_registered_pages[get_plugin_page_hookname( $file, 'edit.php')] = true;
+		$_registered_pages[get_plugin_page_hookname( $menu_slug, 'edit.php')] = true;
+	// No parent as top level
+	$_parent_pages[$menu_slug] = $parent_slug;
 	return $hookname;
 }
 /**
 * Add sub menu page to the tools main menu.
 *
-* @param string $page_title
+* This function takes a capability which will be used to determine whether
-* @param unknown_type $menu_title
+* or not a page is included in the menu.
-* @param unknown_type $access_level
+*
-* @param unknown_type $file
+* The function which is hooked in to handle the output of the page must check
-* @param unknown_type $function
+* that the user has the required capability as well.
-* @return unknown
+*
-*/
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
-function add_management_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+* @param string $menu_title The text to be used for the menu
-	return add_submenu_page( 'tools.php', $page_title, $menu_title, $access_level, $file, $function );
+* @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.
-function add_options_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+*
-	return add_submenu_page( 'options-general.php', $page_title, $menu_title, $access_level, $file, $function );
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
-}
+*/
+function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-function add_theme_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+	return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
-	return add_submenu_page( 'themes.php', $page_title, $menu_title, $access_level, $file, $function );
+}
-}
+/**
-function add_users_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+* Add sub menu page to the options main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Add sub menu page to the themes main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Add sub menu page to the plugins main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Add sub menu page to the Users/Profile main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
 	if ( current_user_can('edit_users') )
 		$parent = 'users.php';
 	else
 		$parent = 'profile.php';
-	return add_submenu_page( $parent, $page_title, $menu_title, $access_level, $file, $function );
+	return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function );
 }
+/**
-function add_dashboard_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+* Add sub menu page to the Dashboard main menu.
-	return add_submenu_page( 'index.php', $page_title, $menu_title, $access_level, $file, $function );
+*
-}
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
-function add_posts_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+*
-	return add_submenu_page( 'edit.php', $page_title, $menu_title, $access_level, $file, $function );
+* The function which is hooked in to handle the output of the page must check
-}
+* that the user has the required capability as well.
+*
-function add_media_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
-	return add_submenu_page( 'upload.php', $page_title, $menu_title, $access_level, $file, $function );
+* @param string $menu_title The text to be used for the menu
-}
+* @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)
-function add_links_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+* @param callback $function The function to be called to output the content for this page.
-	return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $access_level, $file, $function );
+*
-}
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
-function add_pages_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
-	return add_submenu_page( 'edit-pages.php', $page_title, $menu_title, $access_level, $file, $function );
+	return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
 }
-function add_comments_page( $page_title, $menu_title, $access_level, $file, $function = '' ) {
+/**
-	return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $access_level, $file, $function );
+* Add sub menu page to the posts main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Add sub menu page to the media main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Add sub menu page to the links main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Add sub menu page to the pages main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Add sub menu page to the comments main menu.
+*
+* This function takes a capability which will be used to determine whether
+* or not a page is included in the menu.
+*
+* The function which is hooked in to handle the output of the page must check
+* that the user has the required capability as well.
+*
+* @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
+* @param string $menu_title The text to be used for the menu
+* @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.
+*
+* @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
+*/
+function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
+	return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
+}
+/**
+* Remove a top level admin menu
+*
+* @since 3.1.0
+*
+* @param string $menu_slug The slug of the menu
+* @return array|bool The removed menu on success, False if not found
+*/
+function remove_menu_page( $menu_slug ) {
+	global $menu;
+	foreach ( $menu as $i => $item ) {
+		if ( $menu_slug == $item[2] ) {
+			unset( $menu[$i] );
+			return $item;
+		}
+	}
+	return false;
+}
+/**
+* Remove an admin submenu
+*
+* @since 3.1.0
+*
+* @param string $menu_slug The slug for the parent menu
+* @param string $submenu_slug The slug of the submenu
+* @return array|bool The removed submenu on success, False if not found
+*/
+function remove_submenu_page( $menu_slug, $submenu_slug ) {
+	global $submenu;
+	if ( !isset( $submenu[$menu_slug] ) )
+		return false;
+	foreach ( $submenu[$menu_slug] as $i => $item ) {
+		if ( $submenu_slug == $item[2] ) {
+			unset( $submenu[$menu_slug][$i] );
+			return $item;
+		}
+	}
+	return false;
+}
+/**
+* Get the url to access a particular menu page based on the slug it was registered with.
+*
+* If the slug hasn't been registered properly no url will be returned
+*
+* @since 3.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
+* @return string the url
+*/
+function menu_page_url($menu_slug, $echo = true) {
+	global $_parent_pages;
+	if ( isset( $_parent_pages[$menu_slug] ) ) {
+		$parent_slug = $_parent_pages[$menu_slug];
+		if ( $parent_slug && ! isset( $_parent_pages[$parent_slug] ) ) {
+			$url = admin_url( add_query_arg( 'page', $menu_slug, $parent_slug ) );
+		} else {
+			$url = admin_url( 'admin.php?page=' . $menu_slug );
+		}
+	} else {
+		$url = '';
+	}
+	$url = esc_url($url);
+	if ( $echo )
+		echo $url;
+	return $url;
 }
 //
 // Pluggable Menu Support -- Private
 //
 function get_admin_page_parent( $parent = '' ) {
 	global $parent_file;
 	global $menu;
 	global $submenu;
 	global $pagenow;
+	global $typenow;
 	global $plugin_page;
 	global $_wp_real_parent_file;
 	global $_wp_menu_nopriv;
 	global $_wp_submenu_nopriv;
 	if ( !empty ( $parent ) && 'admin.php' != $parent ) {
 		if ( isset( $_wp_real_parent_file[$parent] ) )
 			$parent = $_wp_real_parent_file[$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 ) {
 				$parent_file = $plugin_page;
 	foreach (array_keys( (array)$submenu ) as $parent) {
 		foreach ( $submenu[$parent] as $submenu_array ) {
 			if ( isset( $_wp_real_parent_file[$parent] ) )
 				$parent = $_wp_real_parent_file[$parent];
-			if ( $submenu_array[2] == $pagenow ) {
+			if ( !empty($typenow) && ($submenu_array[2] == "$pagenow?post_type=$typenow") ) {
+				$parent_file = $parent;
+				return $parent;
+			} elseif ( $submenu_array[2] == $pagenow && empty($typenow) && ( empty($parent_file) || false === strpos($parent_file, '?') ) ) {
 				$parent_file = $parent;
 				return $parent;
 			} else
 				if ( isset( $plugin_page ) && ($plugin_page == $submenu_array[2] ) ) {
 					$parent_file = $parent;
 	global $title;
 	global $menu;
 	global $submenu;
 	global $pagenow;
 	global $plugin_page;
+	global $typenow;
-	if ( isset( $title ) && !empty ( $title ) ) {
+	if ( ! empty ( $title ) )
 		return $title;
-	}
 	$hook = get_plugin_page_hook( $plugin_page, $pagenow );
 	$parent = $parent1 = get_admin_page_parent();
 				$title = $menu_array[0];
 				return $title;
 			}
 		}
 	} else {
-		foreach (array_keys( $submenu ) as $parent) {
+		foreach ( array_keys( $submenu ) as $parent ) {
 			foreach ( $submenu[$parent] as $submenu_array ) {
 				if ( isset( $plugin_page ) &&
-					($plugin_page == $submenu_array[2] ) &&
+					( $plugin_page == $submenu_array[2] ) &&
-					(($parent == $pagenow ) || ($parent == $plugin_page ) || ($plugin_page == $hook ) || (($pagenow == 'admin.php' ) && ($parent1 != $submenu_array[2] ) ) )
+					(
+						( $parent == $pagenow ) ||
+						( $parent == $plugin_page ) ||
+						( $plugin_page == $hook ) ||
+						( $pagenow == 'admin.php' && $parent1 != $submenu_array[2] ) ||
+						( !empty($typenow) && $parent == $pagenow . '?post_type=' . $typenow)
+					)
 					) {
 						$title = $submenu_array[3];
 						return $submenu_array[3];
 					}
 					$title = $submenu_array[0];
 					return $title;
 				}
 			}
 		}
-		if ( !isset($title) || empty ( $title ) ) {
+		if ( empty ( $title ) ) {
 			foreach ( $menu as $menu_array ) {
 				if ( isset( $plugin_page ) &&
-					($plugin_page == $menu_array[2] ) &&
+					( $plugin_page == $menu_array[2] ) &&
-					($pagenow == 'admin.php' ) &&
+					( $pagenow == 'admin.php' ) &&
-					($parent1 == $menu_array[2] ) )
+					( $parent1 == $menu_array[2] ) )
 					{
 						$title = $menu_array[3];
 						return $menu_array[3];
 					}
 			}
 		$page_type = $admin_page_hooks[$parent];
 	}
 	$plugin_name = preg_replace( '!\.php!', '', $plugin_page );
-	return $page_type.'_page_'.$plugin_name;
+	return $page_type . '_page_' . $plugin_name;
 }
 function user_can_access_admin_page() {
 	global $pagenow;
 	global $menu;
 	if ( isset( $plugin_page ) ) {
 		if ( isset( $_wp_submenu_nopriv[$parent][$plugin_page] ) )
 			return false;
 		$hookname = get_plugin_page_hookname($plugin_page, $parent);
 		if ( !isset($_registered_pages[$hookname]) )
 			return false;
 	}
 	if ( empty( $parent) ) {
 /**
 * Register a setting and its sanitization callback
 *
 * @since 2.7.0
 *
-* @param string $option_group A settings group name.  Should correspond to a whitelisted option key name.
+* @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
 * 	Default whitelisted option key names include "general," "discussion," and "reading," among others.
 * @param string $option_name The name of an option to sanitize and save.
 * @param unknown_type $sanitize_callback A callback function that sanitizes the option's value.
 * @return unknown
 */
-function register_setting($option_group, $option_name, $sanitize_callback = '') {
+function register_setting( $option_group, $option_name, $sanitize_callback = '' ) {
-	return add_option_update_handler($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.' ) );
+		$option_group = 'general';
+	}
+	$new_whitelist_options[ $option_group ][] = $option_name;
+	if ( $sanitize_callback != '' )
+		add_filter( "sanitize_option_{$option_name}", $sanitize_callback );
 }
 /**
 * Unregister a setting
 *
 * @param unknown_type $option_group
 * @param unknown_type $option_name
 * @param unknown_type $sanitize_callback
 * @return unknown
 */
-function unregister_setting($option_group, $option_name, $sanitize_callback = '') {
+function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) {
-	return remove_option_update_handler($option_group, $option_name, $sanitize_callback);
-}
-/**
-* {@internal Missing Short Description}}
-*
-* @since unknown
-*
-* @param unknown_type $option_group
-* @param unknown_type $option_name
-* @param unknown_type $sanitize_callback
-*/
-function add_option_update_handler($option_group, $option_name, $sanitize_callback = '') {
 	global $new_whitelist_options;
-	$new_whitelist_options[ $option_group ][] = $option_name;
-	if ( $sanitize_callback != '' )
+	if ( 'misc' == $option_group ) {
-		add_filter( "sanitize_option_{$option_name}", $sanitize_callback );
+		_deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
-}
+		$option_group = 'general';
+	}
-/**
-* {@internal Missing Short Description}}
-*
-* @since unknown
-*
-* @param unknown_type $option_group
-* @param unknown_type $option_name
-* @param unknown_type $sanitize_callback
-*/
-function remove_option_update_handler($option_group, $option_name, $sanitize_callback = '') {
-	global $new_whitelist_options;
 	$pos = array_search( $option_name, (array) $new_whitelist_options );
 	if ( $pos !== false )
 		unset( $new_whitelist_options[ $option_group ][ $pos ] );
 	if ( $sanitize_callback != '' )
 		remove_filter( "sanitize_option_{$option_name}", $sanitize_callback );
 }
 /**
 * {@internal Missing Short Description}}
 *
-* @since unknown
+* @since 2.7.0
 *
 * @param unknown_type $options
 * @return unknown
 */
 function option_update_filter( $options ) {
 add_filter( 'whitelist_options', 'option_update_filter' );
 /**
 * {@internal Missing Short Description}}
 *
-* @since unknown
+* @since 2.7.0
 *
 * @param unknown_type $new_options
 * @param unknown_type $options
 * @return unknown
 */
 function add_option_whitelist( $new_options, $options = '' ) {
-	if( $options == '' ) {
+	if ( $options == '' )
 		global $whitelist_options;
-	} else {
+	else
 		$whitelist_options = $options;
-	}
-	foreach( $new_options as $page => $keys ) {
+	foreach ( $new_options as $page => $keys ) {
-		foreach( $keys as $key ) {
+		foreach ( $keys as $key ) {
 			if ( !isset($whitelist_options[ $page ]) || !is_array($whitelist_options[ $page ]) ) {
 				$whitelist_options[ $page ] = array();
 				$whitelist_options[ $page ][] = $key;
 			} else {
 				$pos = array_search( $key, $whitelist_options[ $page ] );
 				if ( $pos === false )
 					$whitelist_options[ $page ][] = $key;
 			}
 		}
 	}
 	return $whitelist_options;
 }
 /**
 * {@internal Missing Short Description}}
 *
-* @since unknown
+* @since 2.7.0
 *
 * @param unknown_type $del_options
 * @param unknown_type $options
 * @return unknown
 */
 function remove_option_whitelist( $del_options, $options = '' ) {
-	if( $options == '' ) {
+	if ( $options == '' )
 		global $whitelist_options;
-	} else {
+	else
 		$whitelist_options = $options;
-	}
-	foreach( $del_options as $page => $keys ) {
+	foreach ( $del_options as $page => $keys ) {
-		foreach( $keys as $key ) {
+		foreach ( $keys as $key ) {
 			if ( isset($whitelist_options[ $page ]) && is_array($whitelist_options[ $page ]) ) {
 				$pos = array_search( $key, $whitelist_options[ $page ] );
-				if( $pos !== false )
+				if ( $pos !== false )
 					unset( $whitelist_options[ $page ][ $pos ] );
 			}
 		}
 	}
 	return $whitelist_options;
 }
 /**
 * Output nonce, action, and option_page fields for a settings page.
 *
 * @since 2.7.0
 *
-* @param string $option_group A settings group name.  This should match the group name used in register_setting().
+* @param string $option_group A settings group name. This should match the group name used in register_setting().
 */
 function settings_fields($option_group) {
 	echo "<input type='hidden' name='option_page' value='" . esc_attr($option_group) . "' />";
 	echo '<input type="hidden" name="action" value="update" />';
 	wp_nonce_field("$option_group-options");
 }
-?>

changeset 194	32102edaa81b
parent 136	bde1974c263b
child 204	09a1c134465b