enmi-conf.org: comparison wp/wp-admin/includes/plugin.php

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 * The metadata of the plugin's data searches for the following in the plugin's
 * header. All plugin data must be on its own line. For plugin description, it
 * must not have any newlines or only parts of the description will be displayed
 * and the same goes for the plugin data. The below is formatted for printing.
 *
-* <code>
+*     /*
-* /*
+*     Plugin Name: Name of Plugin
-* Plugin Name: Name of Plugin
+*     Plugin URI: Link to plugin information
-* Plugin URI: Link to plugin information
+*     Description: Plugin Description
-* Description: Plugin Description
+*     Author: Plugin author's name
-* Author: Plugin author's name
+*     Author URI: Link to the author's web site
-* Author URI: Link to the author's web site
+*     Version: Must be set in the plugin for WordPress 2.3+
-* Version: Must be set in the plugin for WordPress 2.3+
+*     Text Domain: Optional. Unique identifier, should be same as the one used in
-* Text Domain: Optional. Unique identifier, should be same as the one used in
+*    		load_plugin_textdomain()
-*		plugin_text_domain()
+*     Domain Path: Optional. Only useful if the translations are located in a
-* 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
-*		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
-*		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
-*		must have the first slash. Defaults to the base folder the plugin is
+*    		located in.
-*		located in.
+*     Network: Optional. Specify "Network: true" to require that a plugin is activated
-* 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
-*		across all sites in an installation. This will prevent a plugin from being
+*    		activated on a single site when Multisite is enabled.
-*		activated on a single site when Multisite is enabled.
+*      * / # Remove the space to close comment
-*  * / # Remove the space to close comment
-* </code>
 *
 * Plugin data returned array contains the following:
-*		'Name' - Name of the plugin, must be unique.
+*
-*		'Title' - Title of the plugin and the link to the plugin's web site.
+* - 'Name' - Name of the plugin, must be unique.
-*		'Description' - Description of what the plugin does and/or notes
+* - 'Title' - Title of the plugin and the link to the plugin's web site.
-*		from the author.
+* - 'Description' - Description of what the plugin does and/or notes
-*		'Author' - The author's name
+* - from the author.
-*		'AuthorURI' - The authors web site address.
+* - 'Author' - The author's name
-*		'Version' - The plugin version number.
+* - 'AuthorURI' - The authors web site address.
-*		'PluginURI' - Plugin web site address.
+* - 'Version' - The plugin version number.
-*		'TextDomain' - Plugin's text domain for localization.
+* - 'PluginURI' - Plugin web site address.
-*		'DomainPath' - Plugin's relative directory path to .mo files.
+* - 'TextDomain' - Plugin's text domain for localization.
-*		'Network' - Boolean. Whether the plugin can only be activated network wide.
+* - '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.
 *
 *
 * The plugin file is assumed to have permissions to allow for scripts to read
 * the file. This is not checked however and the file is only opened for
 * reading.
 *
-* @link http://trac.wordpress.org/ticket/5651 Previous Optimizations.
+* @link https://core.trac.wordpress.org/ticket/5651 Previous Optimizations.
-* @link http://trac.wordpress.org/ticket/7372 Further and better Optimizations.
+* @link https://core.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 Optional. If the returned data should have HTML markup applied. Defaults to true.
 * @param bool $translate Optional. If the returned data should be translated. Defaults to true.
 	$plugin_data['AuthorName'] = $plugin_data['Author'];
 	// 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'] );
 		if ( $plugin_data['Author'] )
 			$plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s.'), $plugin_data['Author'] ) . '</cite>';
 	$valid = validate_plugin($plugin);
 	if ( is_wp_error($valid) )
 		return $valid;
-	if ( !in_array($plugin, $current) ) {
+	if ( ( $network_wide && ! isset( $current[ $plugin ] ) ) || ( ! $network_wide && ! 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_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 in activate_plugin() when the $silent parameter is false.
+			 * 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 before a plugin is activated in activate_plugin() when the $silent parameter is false.
+			 * Fires as a specific plugin is being activated.
 			 *
-			 * The action concatenates the 'activate_' prefix with the $plugin value passed to
+			 * This hook is the "activation" hook used internally by
-			 * activate_plugin() to create a dynamically-named action.
+			 * {@see register_activation_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.
 			update_option('active_plugins', $current);
 		}
 		if ( ! $silent ) {
 			/**
-			 * Fires after a plugin has been activated in activate_plugin() when the $silent parameter is false.
+			 * 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
 		if ( ! is_plugin_active($plugin) )
 			continue;
 		$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
+			 * Fires before a plugin is deactivated.
-			 * and when the $silent parameter is false.
+			 *
+			 * 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 ) ) {
 				$do_network = true;
 				unset( $network_current[ $plugin ] );
 			}
 		}
 		if ( ! $silent ) {
 			/**
-			 * Fires for each plugin being deactivated in deactivate_plugins(), after deactivation
+			 * Fires as a specific plugin is being deactivated.
-			 * and when the $silent parameter is false.
+			 *
-			 *
+			 * This hook is the "deactivation" hook used internally by
-			 * The action concatenates the 'deactivate_' prefix with the plugin's basename
+			 * {@see register_deactivation_hook()}. The dynamic portion of the
-			 * to create a dynamically-named action.
+			 * 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 for each plugin being deactivated in deactivate_plugins(), after deactivation
+			 * Fires after a plugin is deactivated.
-			 * and when the $silent parameter is false.
+			 *
+			 * 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 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 is false.
+			 *                                     or just the current site. Multisite only. Default false.
 			 */
 			do_action( 'deactivated_plugin', $plugin, $network_deactivating );
 		}
 	}
 *
 * 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|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.
 * @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
 */
 	return true;
 }
 /**
-* Remove directory and files of a plugin for a single or list of plugin(s).
+* Remove directory and files of a plugin for a list of plugins.
-*
-* If the plugins parameter list is empty, false will be returned. True when
-* completed.
 *
 * @since 2.6.0
 *
-* @param array $plugins List of plugin
+* @param array  $plugins    List of plugins to delete.
-* @param string $redirect Redirect to page when complete.
+* @param string $deprecated Deprecated.
-* @return mixed
+* @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) )
 		return false;
 		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);
-	//Get the base plugin folder
+	// Get the base plugin folder.
 	$plugins_dir = $wp_filesystem->wp_plugins_dir();
-	if ( empty($plugins_dir) )
+	if ( empty( $plugins_dir ) ) {
-		return new WP_Error('fs_no_plugins_dir', __('Unable to locate WordPress Plugin directory.'));
+		return new WP_Error( 'fs_no_plugins_dir', __( 'Unable to locate WordPress Plugin directory.' ) );
+	}
 	$plugins_dir = trailingslashit( $plugins_dir );
+	$plugin_translations = wp_get_installed_translations( 'plugins' );
 	$errors = array();
 	foreach( $plugins as $plugin_file ) {
-		// Run Uninstall hook
+		// Run Uninstall hook.
-		if ( is_uninstallable_plugin( $plugin_file ) )
+		if ( is_uninstallable_plugin( $plugin_file ) ) {
 			uninstall_plugin($plugin_file);
+		}
-		$this_plugin_dir = trailingslashit( dirname($plugins_dir . $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 separator AND that it's 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);
+			$deleted = $wp_filesystem->delete( $this_plugin_dir, true );
-		else
+		} else {
-			$deleted = $wp_filesystem->delete($plugins_dir . $plugin_file);
+			$deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file );
+		}
-		if ( ! $deleted )
+		if ( ! $deleted ) {
 			$errors[] = $plugin_file;
+			continue;
+		}
+		// Remove language files, silently.
+		$plugin_slug = dirname( $plugin_file );
+		if ( '.' !== $plugin_slug && ! empty( $plugin_translations[ $plugin_slug ] ) ) {
+			$translations = $plugin_translations[ $plugin_slug ];
+			foreach ( $translations as $translation => $data ) {
+				$wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' );
+				$wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.mo' );
+			}
+		}
+	}
+	// Remove deleted plugins from the plugin updates list.
+	if ( $current = get_site_transient('update_plugins') ) {
+		// 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)) );
-	// Force refresh of plugin update information
-	if ( $current = get_site_transient('update_plugins') ) {
-		unset( $current->response[ $plugin_file ] );
-		set_site_transient('update_plugins', $current);
-	}
 	return true;
 }
 /**
 * Validate active plugins
 * @since 2.5.0
 * @return array invalid plugins, plugin as key, error as value
 */
 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 ) );
 	}
 	if ( empty( $plugins ) )
-		return;
+		return array();
 	$invalid = array();
-	// invalid plugins get deactivated
+	// Invalid plugins get deactivated.
 	foreach ( $plugins as $plugin ) {
 		$result = validate_plugin( $plugin );
 		if ( is_wp_error( $result ) ) {
 			$invalid[$plugin] = $result;
 			deactivate_plugins( $plugin, true );
 			update_option('uninstall_plugins', $uninstallable_plugins);
 		}
 		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;
 	}
 	if ( isset( $uninstallable_plugins[$file] ) ) {
 		$callable = $uninstallable_plugins[$file];
 		unset($uninstallable_plugins[$file]);
 		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.
 * @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. Using 'none' would leave div.wp-menu-image empty
+* @param string $icon_url The url to the icon to be used for this menu.
-*                         so an icon can be added as background with CSS.
+*     * 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
 */
 function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null ) {
 	if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
 		add_action( $hookname, $function );
 	if ( empty($icon_url) ) {
-		$icon_url = 'none';
+		$icon_url = 'dashicons-admin-generic';
 		$icon_class = 'menu-icon-generic ';
 	} else {
 		$icon_url = set_url_scheme( $icon_url );
 		$icon_class = '';
 	}
 * @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.
+* @return false|string 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;
 	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
+	 * If the parent doesn't already have a submenu, add a link to the parent
-	// parent file someone is trying to link back to the parent manually. In
+	 * as the first item in the submenu. If the submenu file is the same as the
-	// this case, don't automatically add a link back to avoid duplication.
+	 * 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 );
 		}
 	}
 	$submenu[$parent_slug][] = array ( $menu_title, $capability, $menu_slug, $page_title );
 	$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
+	/*
+	 * 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;
 }
 * @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.
+* @return false|string 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 = '' ) {
 	return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $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)
 * @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.
+* @return false|string 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 );
 }
 * @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.
+* @return false|string 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 );
 }
 * @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.
+* @return false|string 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 );
 }
 * @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.
+* @return false|string 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
 * @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.
+* @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
 */
 function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
 	return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $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)
 * @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.
+* @return false|string 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 );
 }
 * @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.
+* @return false|string 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 );
 }
 * @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.
+* @return false|string 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 );
 }
 * @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.
+* @return false|string 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 );
 }
 * @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.
+* @return false|string 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 );
 }
 /**
 * 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
+* @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
 * @return string the url
 */
 		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;
 				if ( isset( $_wp_real_parent_file[$parent_file] ) )
 				$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
+			} elseif ( isset( $plugin_page ) && ($plugin_page == $submenu_array[2] ) ) {
-				if ( isset( $plugin_page ) && ($plugin_page == $submenu_array[2] ) ) {
+				$parent_file = $parent;
-					$parent_file = $parent;
+				return $parent;
-					return $parent;
+			}
-				}
 		}
 	}
 	if ( empty($parent_file) )
 		$parent_file = '';
 		foreach ( (array)$menu as $menu_array ) {
 			if ( isset( $menu_array[3] ) ) {
 				if ( $menu_array[2] == $pagenow ) {
 					$title = $menu_array[3];
 					return $menu_array[3];
-				} else
+				} elseif ( isset( $plugin_page ) && ($plugin_page == $menu_array[2] ) && ($hook == $menu_array[3] ) ) {
-					if ( isset( $plugin_page ) && ($plugin_page == $menu_array[2] ) && ($hook == $menu_array[3] ) ) {
+					$title = $menu_array[3];
-						$title = $menu_array[3];
+					return $menu_array[3];
-						return $menu_array[3];
+				}
-					}
 			} else {
 				$title = $menu_array[0];
 				return $title;
 			}
 		}
 	$parent = get_admin_page_parent( $parent_page );
 	$page_type = 'admin';
 	if ( empty ( $parent_page ) || 'admin.php' == $parent_page || isset( $admin_page_hooks[$plugin_page] ) ) {
-		if ( isset( $admin_page_hooks[$plugin_page] ) )
+		if ( isset( $admin_page_hooks[$plugin_page] ) ) {
 			$page_type = 'toplevel';
-		else
+		} elseif ( isset( $admin_page_hooks[$parent] )) {
-			if ( isset( $admin_page_hooks[$parent] ))
+			$page_type = $admin_page_hooks[$parent];
-				$page_type = $admin_page_hooks[$parent];
+		}
-	} else if ( isset( $admin_page_hooks[$parent] ) ) {
+	} elseif ( isset( $admin_page_hooks[$parent] ) ) {
 		$page_type = $admin_page_hooks[$parent];
 	}
 	$plugin_name = preg_replace( '!\.php!', '', $plugin_page );
 			if ( isset( $plugin_page ) && ( $submenu_array[2] == $plugin_page ) ) {
 				if ( current_user_can( $submenu_array[1] ))
 					return true;
 				else
 					return false;
-			} else if ( $submenu_array[2] == $pagenow ) {
+			} elseif ( $submenu_array[2] == $pagenow ) {
 				if ( current_user_can( $submenu_array[1] ))
 					return true;
 				else
 					return false;
 			}
 * @since 2.7.0
 *
 * @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.
+* @param callable $sanitize_callback A callback function that sanitizes the option's value.
-* @return unknown
 */
 function register_setting( $option_group, $option_name, $sanitize_callback = '' ) {
 	global $new_whitelist_options;
 	if ( 'misc' == $option_group ) {
 /**
 * Unregister a setting
 *
 * @since 2.7.0
 *
-* @param unknown_type $option_group
+* @param string   $option_group
-* @param unknown_type $option_name
+* @param string   $option_name
-* @param unknown_type $sanitize_callback
+* @param callable $sanitize_callback
-* @return unknown
 */
 function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) {
 	global $new_whitelist_options;
 	if ( 'misc' == $option_group ) {
 /**
 * {@internal Missing Short Description}}
 *
 * @since 2.7.0
 *
-* @param unknown_type $options
+* @param array $options
-* @return unknown
+* @return array
 */
 function option_update_filter( $options ) {
 	global $new_whitelist_options;
 	if ( is_array( $new_whitelist_options ) )
 /**
 * {@internal Missing Short Description}}
 *
 * @since 2.7.0
 *
-* @param unknown_type $new_options
+* @param array        $new_options
-* @param unknown_type $options
+* @param string|array $options
-* @return unknown
+* @return array
 */
 function add_option_whitelist( $new_options, $options = '' ) {
 	if ( $options == '' )
 		global $whitelist_options;
 	else
 /**
 * {@internal Missing Short Description}}
 *
 * @since 2.7.0
 *
-* @param unknown_type $del_options
+* @param array        $del_options
-* @param unknown_type $options
+* @param string|array $options
-* @return unknown
+* @return array
 */
 function remove_option_whitelist( $del_options, $options = '' ) {
 	if ( $options == '' )
 		global $whitelist_options;
 	else

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001