X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/d954c87a1e3f0e671855614661da9e5825279134..d3947bc013df7edd54b46deed8230d2eeafc5ecb:/wp-admin/includes/plugin.php
diff --git a/wp-admin/includes/plugin.php b/wp-admin/includes/plugin.php
index 98ee2a1b..25f68287 100644
--- a/wp-admin/includes/plugin.php
+++ b/wp-admin/includes/plugin.php
@@ -7,46 +7,31 @@
*/
/**
- * Parse the plugin contents to retrieve plugin's metadata.
+ * Parses the plugin contents to retrieve plugin's metadata.
*
* 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.
*
- *
- * /*
- * Plugin Name: Name of Plugin
- * Plugin URI: Link to plugin information
- * Description: Plugin Description
- * Author: Plugin author's name
- * Author URI: Link to the author's web site
- * Version: Must be set in the plugin for WordPress 2.3+
- * Text Domain: Optional. Unique identifier, should be same as the one used in
- * plugin_text_domain()
- * 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
- *
- *
- * 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.
- * 'Description' - Description of what the plugin does and/or notes
- * from the author.
- * 'Author' - The author's name
- * '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.
+ * /*
+ * Plugin Name: Name of Plugin
+ * Plugin URI: Link to plugin information
+ * Description: Plugin Description
+ * Author: Plugin author's name
+ * Author URI: Link to the author's web site
+ * Version: Must be set in the plugin for WordPress 2.3+
+ * Text Domain: Optional. Unique identifier, should be same as the one used in
+ * load_plugin_textdomain()
+ * 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
*
* 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
@@ -60,14 +45,25 @@
* 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 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 $translate If the returned data should be translated
- * @return array See above for description.
+ * @param bool $markup Optional. If the returned data should have HTML markup applied.
+ * Default true.
+ * @param bool $translate Optional. If the returned data should be translated. Default true.
+ * @return array {
+ * Plugin data. Values will be empty if not supplied by the plugin.
+ *
+ * @type string $Name Name of the plugin. Should be unique.
+ * @type string $Title Title of the plugin and link to the plugin's site (if set).
+ * @type string $Description Plugin description.
+ * @type string $Author Author's name.
+ * @type string $AuthorURI Author's website address (if set).
+ * @type string $Version Plugin version.
+ * @type string $TextDomain Plugin textdomain.
+ * @type string $DomainPath Plugins relative directory path to .mo files.
+ * @type bool $Network Whether the plugin can only be activated network-wide.
+ * }
*/
function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
@@ -88,57 +84,92 @@ function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
$plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
// Site Wide Only is the old header for Network
- if ( empty( $plugin_data['Network'] ) && ! empty( $plugin_data['_sitewide'] ) ) {
- _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), 'Site Wide Only: true', 'Network: true' ) );
+ if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
+ /* translators: 1: Site Wide Only: true, 2: Network: true */
+ _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), 'Site Wide Only: true', 'Network: true' ) );
$plugin_data['Network'] = $plugin_data['_sitewide'];
}
$plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
unset( $plugin_data['_sitewide'] );
- //For backward compatibility by default Title is the same as Name.
- $plugin_data['Title'] = $plugin_data['Name'];
-
- if ( $markup || $translate )
+ 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.
+ *
+ * @since 2.7.0
+ * @access private
+ * @see get_plugin_data()
+ */
+function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
- //Translate fields30
- if ( $translate && ! empty($plugin_data['TextDomain']) ) {
- if ( ! empty( $plugin_data['DomainPath'] ) )
- load_plugin_textdomain($plugin_data['TextDomain'], false, dirname($plugin_file). $plugin_data['DomainPath']);
- else
- load_plugin_textdomain($plugin_data['TextDomain'], false, dirname($plugin_file));
+ // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path
+ $plugin_file = plugin_basename( $plugin_file );
- foreach ( array('Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version') as $field )
- $plugin_data[ $field ] = translate($plugin_data[ $field ], $plugin_data['TextDomain']);
+ // Translate fields
+ if ( $translate ) {
+ if ( $textdomain = $plugin_data['TextDomain'] ) {
+ if ( ! is_textdomain_loaded( $textdomain ) ) {
+ if ( $plugin_data['DomainPath'] ) {
+ load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] );
+ } else {
+ load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) );
+ }
+ }
+ } elseif ( 'hello.php' == basename( $plugin_file ) ) {
+ $textdomain = 'default';
+ }
+ if ( $textdomain ) {
+ foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field )
+ $plugin_data[ $field ] = translate( $plugin_data[ $field ], $textdomain );
+ }
}
- //Apply Markup
+ // 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 tags. Don't allow these.
+ // Author is too, but some plugins have used 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']) )
- $plugin_data['Title'] = '' . $plugin_data['Name'] . '';
- else
- $plugin_data['Title'] = $plugin_data['Name'];
+ if ( $plugin_data['PluginURI'] && $plugin_data['Name'] )
+ $plugin_data['Title'] = '' . $plugin_data['Name'] . '';
- if ( ! empty($plugin_data['AuthorURI']) && ! empty($plugin_data['Author']) )
- $plugin_data['Author'] = '' . $plugin_data['Author'] . '';
+ if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] )
+ $plugin_data['Author'] = '' . $plugin_data['Author'] . '';
$plugin_data['Description'] = wptexturize( $plugin_data['Description'] );
- if ( ! empty($plugin_data['Author']) )
- $plugin_data['Description'] .= ' ' . sprintf( __('By %s'), $plugin_data['Author'] ) . '.';
- }
-
- $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);
+ if ( $plugin_data['Author'] )
+ $plugin_data['Description'] .= ' ' . sprintf( __('By %s.'), $plugin_data['Author'] ) . '';
+ }
return $plugin_data;
}
@@ -188,9 +219,9 @@ function get_plugin_files($plugin) {
*
* WordPress only supports plugin files in the base plugins directory
* (wp-content/plugins) and in one directory above the plugins directory
- * (wp-content/plugins/my-plugin). The file it looks for has the plugin data and
- * must be found in those two locations. It is recommended that do keep your
- * plugin files in directories.
+ * (wp-content/plugins/my-plugin). The file it looks for has the plugin data
+ * and must be found in those two locations. It is recommended to keep your
+ * plugin files in their own directories.
*
* The file with the plugin data is the file that will be included and therefore
* needs to have the main execution for the plugin. This does not mean
@@ -198,7 +229,7 @@ function get_plugin_files($plugin) {
* 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.
@@ -232,19 +263,16 @@ function get_plugins($plugin_folder = '') {
if ( substr($subfile, -4) == '.php' )
$plugin_files[] = "$file/$subfile";
}
+ closedir( $plugins_subdir );
}
} else {
if ( substr($file, -4) == '.php' )
$plugin_files[] = $file;
}
}
- } else {
- return $wp_plugins;
+ closedir( $plugins_dir );
}
- @closedir( $plugins_dir );
- @closedir( $plugins_subdir );
-
if ( empty($plugin_files) )
return $wp_plugins;
@@ -260,7 +288,7 @@ function get_plugins($plugin_folder = '') {
$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');
@@ -312,11 +340,21 @@ function get_mu_plugins() {
if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php') <= 30 ) // silence is golden
unset( $wp_plugins['index.php'] );
- uasort( $wp_plugins, create_function( '$a, $b', 'return strnatcasecmp( $a["Name"], $b["Name"] );' ));
+ 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.
*
@@ -353,7 +391,7 @@ function get_dropins() {
$dropins[ $plugin_file ] = $plugin_data;
}
- uksort( $dropins, create_function( '$a, $b', 'return strnatcasecmp( $a, $b );' ));
+ uksort( $dropins, 'strnatcasecmp' );
return $dropins;
}
@@ -389,7 +427,12 @@ function _get_dropins() {
}
/**
- * Check whether the plugin is active by checking the active_plugins list.
+ * Check whether a plugin is active.
+ *
+ * Only plugins installed in the plugins/ folder can be active.
+ *
+ * Plugins in the mu-plugins/ folder can't be "activated," so this function will
+ * return false for those plugins.
*
* @since 2.5.0
*
@@ -400,9 +443,29 @@ function is_plugin_active( $plugin ) {
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.
*
+ * Only plugins installed in the plugins/ folder can be active.
+ *
+ * Plugins in the mu-plugins/ folder can't be "activated," so this function will
+ * return false for those plugins.
+ *
* @since 3.0.0
*
* @param string $plugin Base plugin path from plugins directory.
@@ -428,8 +491,8 @@ function is_plugin_active_for_network( $plugin ) {
*
* @since 3.0.0
*
- * @param $file Plugin to check
- * $return bool True if plugin is network only, false otherwise.
+ * @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 );
@@ -456,19 +519,22 @@ function is_network_only_plugin( $plugin ) {
* 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 string $plugin Plugin path to main plugin file with plugin data.
+ * @param string $redirect Optional. URL to redirect to.
+ * @param bool $network_wide Optional. Whether to enable the plugin for all sites in the network
+ * or just the current site. Multisite only. Default false.
+ * @param bool $silent Optional. Whether to prevent calling activation hooks. Default false.
* @return WP_Error|null WP_Error on invalid file or null on success.
*/
-function activate_plugin( $plugin, $redirect = '', $network_wide = false) {
- $plugin = plugin_basename( trim( $plugin ) );
+function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {
+ $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() );
}
@@ -477,22 +543,75 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false) {
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(WP_PLUGIN_DIR . '/' . $plugin);
- do_action( 'activate_plugin', trim( $plugin) );
- do_action( 'activate_' . trim( $plugin ) );
+ wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
+ $_wp_plugin_file = $plugin;
+ include_once( WP_PLUGIN_DIR . '/' . $plugin );
+ $plugin = $_wp_plugin_file; // Avoid stomping of the $plugin variable in a plugin.
+
+ if ( ! $silent ) {
+ /**
+ * Fires before a plugin is activated.
+ *
+ * If a plugin is silently activated (such as during an update),
+ * this hook does not fire.
+ *
+ * @since 2.9.0
+ *
+ * @param string $plugin Plugin path to main plugin file with plugin data.
+ * @param bool $network_wide Whether to enable the plugin for all sites in the network
+ * or just the current site. Multisite only. Default is false.
+ */
+ do_action( 'activate_plugin', $plugin, $network_wide );
+
+ /**
+ * Fires as a specific plugin is being activated.
+ *
+ * This hook is the "activation" hook used internally by
+ * {@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.
+ */
+ do_action( 'activate_' . $plugin, $network_wide );
+ }
+
if ( $network_wide ) {
+ $current = get_site_option( 'active_sitewide_plugins', array() );
$current[$plugin] = time();
update_site_option( 'active_sitewide_plugins', $current );
} else {
+ $current = get_option( 'active_plugins', array() );
$current[] = $plugin;
sort($current);
update_option('active_plugins', $current);
}
- do_action( 'activated_plugin', trim( $plugin) );
+
+ if ( ! $silent ) {
+ /**
+ * Fires after a plugin has been activated.
+ *
+ * If a plugin is silently activated (such as during an update),
+ * this hook does not fire.
+ *
+ * @since 2.9.0
+ *
+ * @param string $plugin Plugin path to main plugin file with plugin data.
+ * @param bool $network_wide Whether to enable the plugin for all sites in the network
+ * or just the current site. Multisite only. Default is false.
+ */
+ do_action( 'activated_plugin', $plugin, $network_wide );
+ }
+
if ( ob_get_length() > 0 ) {
$output = ob_get_clean();
return new WP_Error('unexpected_output', __('The plugin generated unexpected output.'), $output);
@@ -509,40 +628,90 @@ function activate_plugin( $plugin, $redirect = '', $network_wide = false) {
* 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 bool $silent Prevent calling deactivation hooks. Default is false.
+ * @param mixed $network_wide Whether to deactivate the plugin for all sites in the network.
+ * A value of null (the default) will deactivate plugins for both the site and the network.
*/
-function deactivate_plugins( $plugins, $silent = false ) {
- $network_current = get_site_option( 'active_sitewide_plugins', array() );
+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($plugin);
+ $plugin = plugin_basename( trim( $plugin ) );
if ( ! is_plugin_active($plugin) )
continue;
- if ( ! $silent )
- do_action( 'deactivate_plugin', trim( $plugin ) );
- if ( is_plugin_active_for_network($plugin) ) {
- // Deactivate network wide
- $do_network = true;
- unset( $network_current[ $plugin ] );
- } else {
- // Deactivate for this blog only
- $key = array_search( $plugin, (array) $current );
+ $network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
+
+ if ( ! $silent ) {
+ /**
+ * Fires before a plugin is deactivated.
+ *
+ * If a plugin is silently deactivated (such as during an update),
+ * this hook does not fire.
+ *
+ * @since 2.9.0
+ *
+ * @param string $plugin Plugin path to main plugin file with plugin data.
+ * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
+ * or just the current site. Multisite only. Default is false.
+ */
+ do_action( 'deactivate_plugin', $plugin, $network_deactivating );
+ }
+
+ if ( false !== $network_wide ) {
+ if ( is_plugin_active_for_network( $plugin ) ) {
+ $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 );
+ unset( $current[ $key ] );
}
}
- //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 ) );
+ /**
+ * Fires as a specific plugin is being deactivated.
+ *
+ * This hook is the "deactivation" hook used internally by
+ * {@see register_deactivation_hook()}. The dynamic portion of the
+ * hook name, `$plugin`, refers to the plugin basename.
+ *
+ * If a plugin is silently deactivated (such as during an update),
+ * this hook does not fire.
+ *
+ * @since 2.0.0
+ *
+ * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
+ * or just the current site. Multisite only. Default is false.
+ */
+ do_action( 'deactivate_' . $plugin, $network_deactivating );
+
+ /**
+ * Fires after a plugin is deactivated.
+ *
+ * If a plugin is silently deactivated (such as during an update),
+ * this hook does not fire.
+ *
+ * @since 2.9.0
+ *
+ * @param string $plugin Plugin basename.
+ * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
+ * or just the current site. Multisite only. Default false.
+ */
+ do_action( 'deactivated_plugin', $plugin, $network_deactivating );
}
}
@@ -560,22 +729,23 @@ function deactivate_plugins( $plugins, $silent = false ) {
*
* The execution will be halted as soon as one of the plugins has an error.
*
- * @since unknown
+ * @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.
*/
-function activate_plugins($plugins, $redirect = '', $network_wide) {
+function activate_plugins( $plugins, $redirect = '', $network_wide = false, $silent = false ) {
if ( !is_array($plugins) )
$plugins = array($plugins);
$errors = array();
- foreach ( (array) $plugins as $plugin ) {
+ foreach ( $plugins as $plugin ) {
if ( !empty($redirect) )
$redirect = add_query_arg('plugin', $plugin, $redirect);
- $result = activate_plugin($plugin, $redirect, $network_wide);
+ $result = activate_plugin($plugin, $redirect, $network_wide, $silent);
if ( is_wp_error($result) )
$errors[$plugin] = $result;
}
@@ -587,32 +757,32 @@ function activate_plugins($plugins, $redirect = '', $network_wide) {
}
/**
- * 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
*
- * @since unknown
+ * @global WP_Filesystem_Base $wp_filesystem
*
- * @param array $plugins List of plugin
- * @param string $redirect Redirect to page when complete.
- * @return mixed
+ * @param array $plugins List of plugins to delete.
+ * @param string $deprecated Deprecated.
+ * @return bool|null|WP_Error True on success, false is $plugins is empty, WP_Error on failure.
+ * Null if filesystem credentials are required to proceed.
*/
-function delete_plugins($plugins, $redirect = '' ) {
+function delete_plugins( $plugins, $deprecated = '' ) {
global $wp_filesystem;
if ( empty($plugins) )
return false;
$checked = array();
- foreach( $plugins as $plugin )
+ 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();
+ $data = ob_get_clean();
+
if ( ! empty($data) ){
include_once( ABSPATH . 'wp-admin/admin-header.php');
echo $data;
@@ -624,8 +794,8 @@ function delete_plugins($plugins, $redirect = '' ) {
if ( ! WP_Filesystem($credentials) ) {
request_filesystem_credentials($url, '', true); //Failed to connect, Error and request again
- $data = ob_get_contents();
- ob_end_clean();
+ $data = ob_get_clean();
+
if ( ! empty($data) ){
include_once( ABSPATH . 'wp-admin/admin-header.php');
echo $data;
@@ -641,40 +811,84 @@ function delete_plugins($plugins, $redirect = '' ) {
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) )
- return new WP_Error('fs_no_plugins_dir', __('Unable to locate WordPress Plugin directory.'));
+ if ( empty( $plugins_dir ) ) {
+ 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
- if ( is_uninstallable_plugin( $plugin_file ) )
+ foreach ( $plugins as $plugin_file ) {
+ // Run Uninstall hook.
+ if ( is_uninstallable_plugin( $plugin_file ) ) {
uninstall_plugin($plugin_file);
+ }
+
+ /**
+ * Fires immediately before a plugin deletion attempt.
+ *
+ * @since 4.4.0
+ *
+ * @param string $plugin_file Plugin file name.
+ */
+ do_action( 'delete_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 seperator 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 ( strpos( $plugin_file, '/' ) && $this_plugin_dir != $plugins_dir ) { //base check on if plugin includes directory separator AND that it's not the root plugin folder
+ $deleted = $wp_filesystem->delete( $this_plugin_dir, true );
+ } else {
+ $deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file );
+ }
- if ( ! $deleted )
+ /**
+ * Fires immediately after a plugin deletion attempt.
+ *
+ * @since 4.4.0
+ *
+ * @param string $plugin_file Plugin file name.
+ * @param bool $deleted Whether the plugin deletion was successful.
+ */
+ do_action( 'deleted_plugin', $plugin_file, $deleted );
+
+ if ( ! $deleted ) {
$errors[] = $plugin_file;
- }
+ continue;
+ }
- if ( ! empty($errors) )
- return new WP_Error('could_not_remove_plugin', sprintf(__('Could not fully remove the plugin(s) %s.'), implode(', ', $errors)) );
+ // 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' );
+ }
+ }
+ }
- // Force refresh of plugin update information
+ // Remove deleted plugins from the plugin updates list.
if ( $current = get_site_transient('update_plugins') ) {
- unset( $current->response[ $plugin_file ] );
- set_site_transient('update_plugins', $current);
+ // Don't remove the plugins that weren't deleted.
+ $deleted = array_diff( $plugins, $errors );
+
+ foreach ( $deleted as $plugin_file ) {
+ unset( $current->response[ $plugin_file ] );
+ }
+
+ set_site_transient( 'update_plugins', $current );
}
+ if ( ! empty($errors) )
+ return new WP_Error('could_not_remove_plugin', sprintf(__('Could not fully remove the plugin(s) %s.'), implode(', ', $errors)) );
+
return true;
}
@@ -684,28 +898,28 @@ function delete_plugins($plugins, $redirect = '' ) {
* Validate all active plugins, deactivates invalid and
* returns an array of deactivated ones.
*
- * @since unknown
+ * @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 ) ) {
@@ -721,7 +935,7 @@ function validate_active_plugins() {
*
* 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.
@@ -764,11 +978,23 @@ function is_uninstallable_plugin($plugin) {
* @since 2.7.0
*
* @param string $plugin Relative plugin path from Plugin Directory.
+ * @return true True if a plugin's uninstall.php file has been found and included.
*/
function uninstall_plugin($plugin) {
$file = plugin_basename($plugin);
$uninstallable_plugins = (array) get_option('uninstall_plugins');
+
+ /**
+ * Fires in uninstall_plugin() immediately before the plugin is uninstalled.
+ *
+ * @since 4.5.0
+ *
+ * @param string $plugin Relative plugin path from plugin directory.
+ * @param array $uninstallable_plugins Uninstallable plugins.
+ */
+ do_action( 'pre_uninstall_plugin', $plugin, $uninstallable_plugins );
+
if ( file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) ) {
if ( isset( $uninstallable_plugins[$file] ) ) {
unset($uninstallable_plugins[$file]);
@@ -777,7 +1003,8 @@ function uninstall_plugin($plugin) {
unset($uninstallable_plugins);
define('WP_UNINSTALL_PLUGIN', $file);
- include WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php';
+ wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . dirname( $file ) );
+ include( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' );
return true;
}
@@ -788,9 +1015,19 @@ function uninstall_plugin($plugin) {
update_option('uninstall_plugins', $uninstallable_plugins);
unset($uninstallable_plugins);
- include WP_PLUGIN_DIR . '/' . $file;
+ wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );
+ include( WP_PLUGIN_DIR . '/' . $file );
add_action( 'uninstall_' . $file, $callable );
+
+ /**
+ * Fires in uninstall_plugin() once the plugin has been uninstalled.
+ *
+ * The action concatenates the 'uninstall_' prefix with the basename of the
+ * plugin passed to {@see uninstall_plugin()} to create a dynamically-named action.
+ *
+ * @since 2.7.0
+ */
do_action( 'uninstall_' . $file );
}
}
@@ -800,7 +1037,7 @@ function uninstall_plugin($plugin) {
//
/**
- * Add a top level menu page
+ * Add a top-level menu page.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -808,15 +1045,26 @@ function uninstall_plugin($plugin) {
* 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
- * @param int $position The position in the menu order this one should appear
+ * @global array $menu
+ * @global array $admin_page_hooks
+ * @global array $_registered_pages
+ * @global array $_parent_pages
+ *
+ * @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 callable $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.
+ * * 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 ) {
+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 );
@@ -828,17 +1076,24 @@ function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $func
if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
add_action( $hookname, $function );
- if ( empty($icon_url) )
- $icon_url = esc_url( admin_url( 'images/generic.png' ) );
- elseif ( is_ssl() && 0 === strpos($icon_url, 'http://') )
- $icon_url = 'https://' . substr($icon_url, 7);
+ if ( empty($icon_url) ) {
+ $icon_url = 'dashicons-admin-generic';
+ $icon_class = 'menu-icon-generic ';
+ } else {
+ $icon_url = set_url_scheme( $icon_url );
+ $icon_class = '';
+ }
- $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $hookname, $hookname, $icon_url );
+ $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $icon_class . $hookname, $hookname, $icon_url );
- if ( null === $position )
+ if ( null === $position ) {
$menu[] = $new_menu;
- else
- $menu[$position] = $new_menu;
+ } elseif ( isset( $menu[ "$position" ] ) ) {
+ $position = $position + substr( base_convert( md5( $menu_slug . $menu_title ), 16, 10 ) , -5 ) * 0.00001;
+ $menu[ "$position" ] = $new_menu;
+ } else {
+ $menu[ $position ] = $new_menu;
+ }
$_registered_pages[$hookname] = true;
@@ -849,7 +1104,7 @@ function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $func
}
/**
- * Add a top level menu page in the 'objects' section
+ * Add a submenu page.
*
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu.
@@ -857,68 +1112,24 @@ function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $func
* 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
- */
-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, $capability, $menu_slug, $function, $icon_url, $_wp_last_object_menu);
-}
-
-/**
- * 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
- */
-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, $capability, $menu_slug, $function, $icon_url, $_wp_last_utility_menu);
-}
-
-/**
- * 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.
+ * @global array $submenu
+ * @global array $menu
+ * @global array $_wp_real_parent_file
+ * @global bool $_wp_submenu_nopriv
+ * @global array $_registered_pages
+ * @global array $_parent_pages
+ *
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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;
- global $_wp_submenu_nopriv;
- global $_registered_pages;
- global $_parent_pages;
+ global $submenu, $menu, $_wp_real_parent_file, $_wp_submenu_nopriv,
+ $_registered_pages, $_parent_pages;
$menu_slug = plugin_basename( $menu_slug );
$parent_slug = plugin_basename( $parent_slug);
@@ -931,14 +1142,16 @@ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability,
return false;
}
- // If the parent doesn't already have a submenu, add a link to the parent
- // as the first item in the submenu. If the submenu file is the same as the
- // parent file someone is trying to link back to the parent manually. In
- // this case, don't automatically add a link back to avoid duplication.
- if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug ) {
+ /*
+ * If the parent doesn't already have a submenu, add a link to the parent
+ * as the first item in the submenu. If the submenu file is the same as the
+ * parent file someone is trying to link back to the parent manually. In
+ * this case, don't automatically add a link back to avoid duplication.
+ */
+ if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug ) {
foreach ( (array)$menu as $parent_menu ) {
if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) )
- $submenu[$parent_slug][] = $parent_menu;
+ $submenu[$parent_slug][] = array_slice( $parent_menu, 0, 4 );
}
}
@@ -949,106 +1162,115 @@ function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability,
add_action( $hookname, $function );
$_registered_pages[$hookname] = true;
- // backwards-compatibility for plugins using add_management page. See wp-admin/admin.php for redirect from edit.php to tools.php
+
+ /*
+ * Backward-compatibility for plugins using add_management page.
+ * See wp-admin/admin.php for redirect from edit.php to tools.php
+ */
if ( 'tools.php' == $parent_slug )
$_registered_pages[get_plugin_page_hookname( $menu_slug, 'edit.php')] = true;
- // No parent as top level
+ // No parent as top level.
$_parent_pages[$menu_slug] = $parent_slug;
return $hookname;
}
/**
- * Add sub menu page to the tools main menu.
-*
+ * Add submenu page to the Tools 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the options main menu.
-*
+ * Add submenu page to the Settings 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the themes main menu.
-*
+ * Add submenu page to the Appearance 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the plugins main menu.
-*
+ * Add submenu 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the Users/Profile main menu.
-*
+ * Add submenu 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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') )
@@ -1058,125 +1280,183 @@ function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $fun
return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function );
}
/**
- * Add sub menu page to the Dashboard main menu.
-*
+ * Add submenu page to the Dashboard 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the posts main menu.
-*
+ * Add submenu 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the media main menu.
-*
+ * Add submenu 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the links main menu.
-*
+ * Add submenu 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the pages main menu.
-*
+ * Add submenu 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
/**
- * Add sub menu page to the comments main menu.
-*
+ * Add submenu 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.
+ * @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 callable $function The function to be called to output the content for this page.
+ * @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 );
}
+/**
+ * Remove a top-level admin menu.
+ *
+ * @since 3.1.0
+ *
+ * @global array $menu
+ *
+ * @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
+ *
+ * @global array $submenu
+ *
+ * @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
+ * @since 3.0.0
+ *
+ * @global array $_parent_pages
*
* @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
@@ -1186,10 +1466,11 @@ function menu_page_url($menu_slug, $echo = true) {
global $_parent_pages;
if ( isset( $_parent_pages[$menu_slug] ) ) {
- if ( $_parent_pages[$menu_slug] ) {
- $url = admin_url( add_query_arg( 'page', $menu_slug, $_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);
+ $url = admin_url( 'admin.php?page=' . $menu_slug );
}
} else {
$url = '';
@@ -1206,17 +1487,21 @@ function menu_page_url($menu_slug, $echo = true) {
//
// Pluggable Menu Support -- Private
//
-
+/**
+ *
+ * @global string $parent_file
+ * @global array $menu
+ * @global array $submenu
+ * @global string $pagenow
+ * @global string $typenow
+ * @global string $plugin_page
+ * @global array $_wp_real_parent_file
+ * @global array $_wp_menu_nopriv
+ * @global array $_wp_submenu_nopriv
+ */
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;
+ global $parent_file, $menu, $submenu, $pagenow, $typenow,
+ $plugin_page, $_wp_real_parent_file, $_wp_menu_nopriv, $_wp_submenu_nopriv;
if ( !empty ( $parent ) && 'admin.php' != $parent ) {
if ( isset( $_wp_real_parent_file[$parent] ) )
@@ -1224,15 +1509,6 @@ function get_admin_page_parent( $parent = '' ) {
return $parent;
}
- /*
- if ( !empty ( $parent_file ) ) {
- if ( isset( $_wp_real_parent_file[$parent_file] ) )
- $parent_file = $_wp_real_parent_file[$parent_file];
-
- return $parent_file;
- }
- */
-
if ( $pagenow == 'admin.php' && isset( $plugin_page ) ) {
foreach ( (array)$menu as $parent_menu ) {
if ( $parent_menu[2] == $plugin_page ) {
@@ -1267,11 +1543,10 @@ function get_admin_page_parent( $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;
- return $parent;
- }
+ } elseif ( isset( $plugin_page ) && ($plugin_page == $submenu_array[2] ) ) {
+ $parent_file = $parent;
+ return $parent;
+ }
}
}
@@ -1280,13 +1555,17 @@ function get_admin_page_parent( $parent = '' ) {
return '';
}
+/**
+ *
+ * @global string $title
+ * @global array $menu
+ * @global array $submenu
+ * @global string $pagenow
+ * @global string $plugin_page
+ * @global string $typenow
+ */
function get_admin_page_title() {
- global $title;
- global $menu;
- global $submenu;
- global $pagenow;
- global $plugin_page;
- global $typenow;
+ global $title, $menu, $submenu, $pagenow, $plugin_page, $typenow;
if ( ! empty ( $title ) )
return $title;
@@ -1301,11 +1580,10 @@ function get_admin_page_title() {
if ( $menu_array[2] == $pagenow ) {
$title = $menu_array[3];
return $menu_array[3];
- } else
- if ( isset( $plugin_page ) && ($plugin_page == $menu_array[2] ) && ($hook == $menu_array[3] ) ) {
- $title = $menu_array[3];
- return $menu_array[3];
- }
+ } elseif ( isset( $plugin_page ) && ($plugin_page == $menu_array[2] ) && ($hook == $menu_array[3] ) ) {
+ $title = $menu_array[3];
+ return $menu_array[3];
+ }
} else {
$title = $menu_array[0];
return $title;
@@ -1357,6 +1635,13 @@ function get_admin_page_title() {
return $title;
}
+/**
+ * @since 2.3.0
+ *
+ * @param string $plugin_page
+ * @param string $parent_page
+ * @return string|null
+ */
function get_plugin_page_hook( $plugin_page, $parent_page ) {
$hook = get_plugin_page_hookname( $plugin_page, $parent_page );
if ( has_action($hook) )
@@ -1365,6 +1650,12 @@ function get_plugin_page_hook( $plugin_page, $parent_page ) {
return null;
}
+/**
+ *
+ * @global array $admin_page_hooks
+ * @param string $plugin_page
+ * @param string $parent_page
+ */
function get_plugin_page_hookname( $plugin_page, $parent_page ) {
global $admin_page_hooks;
@@ -1372,12 +1663,12 @@ function get_plugin_page_hookname( $plugin_page, $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
- if ( isset( $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];
+ }
+ } elseif ( isset( $admin_page_hooks[$parent] ) ) {
$page_type = $admin_page_hooks[$parent];
}
@@ -1386,14 +1677,19 @@ function get_plugin_page_hookname( $plugin_page, $parent_page ) {
return $page_type . '_page_' . $plugin_name;
}
+/**
+ *
+ * @global string $pagenow
+ * @global array $menu
+ * @global array $submenu
+ * @global array $_wp_menu_nopriv
+ * @global array $_wp_submenu_nopriv
+ * @global string $plugin_page
+ * @global array $_registered_pages
+ */
function user_can_access_admin_page() {
- global $pagenow;
- global $menu;
- global $submenu;
- global $_wp_menu_nopriv;
- global $_wp_submenu_nopriv;
- global $plugin_page;
- global $_registered_pages;
+ global $pagenow, $menu, $submenu, $_wp_menu_nopriv, $_wp_submenu_nopriv,
+ $plugin_page, $_registered_pages;
$parent = get_admin_page_parent();
@@ -1438,7 +1734,7 @@ function user_can_access_admin_page() {
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
@@ -1466,20 +1762,26 @@ function user_can_access_admin_page() {
*
* @since 2.7.0
*
- * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
+ * @global array $new_whitelist_options
+ *
+ * @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
+ * @param callable $sanitize_callback A callback function that sanitizes the option's value.
*/
function register_setting( $option_group, $option_name, $sanitize_callback = '' ) {
global $new_whitelist_options;
if ( 'misc' == $option_group ) {
- _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
+ _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
$option_group = 'general';
}
+ if ( 'privacy' == $option_group ) {
+ _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
+ $option_group = 'reading';
+ }
+
$new_whitelist_options[ $option_group ][] = $option_name;
if ( $sanitize_callback != '' )
add_filter( "sanitize_option_{$option_name}", $sanitize_callback );
@@ -1490,20 +1792,26 @@ function register_setting( $option_group, $option_name, $sanitize_callback = ''
*
* @since 2.7.0
*
- * @param unknown_type $option_group
- * @param unknown_type $option_name
- * @param unknown_type $sanitize_callback
- * @return unknown
+ * @global array $new_whitelist_options
+ *
+ * @param string $option_group
+ * @param string $option_name
+ * @param callable $sanitize_callback
*/
function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) {
global $new_whitelist_options;
if ( 'misc' == $option_group ) {
- _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
+ _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
$option_group = 'general';
}
- $pos = array_search( $option_name, (array) $new_whitelist_options );
+ if ( 'privacy' == $option_group ) {
+ _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
+ $option_group = 'reading';
+ }
+
+ $pos = array_search( $option_name, (array) $new_whitelist_options[ $option_group ] );
if ( $pos !== false )
unset( $new_whitelist_options[ $option_group ][ $pos ] );
if ( $sanitize_callback != '' )
@@ -1511,12 +1819,14 @@ function unregister_setting( $option_group, $option_name, $sanitize_callback = '
}
/**
- * {@internal Missing Short Description}}
+ * Refreshes the value of the options whitelist available via the 'whitelist_options' filter.
*
- * @since unknown
+ * @since 2.7.0
+ *
+ * @global array $new_whitelist_options
*
- * @param unknown_type $options
- * @return unknown
+ * @param array $options
+ * @return array
*/
function option_update_filter( $options ) {
global $new_whitelist_options;
@@ -1526,16 +1836,17 @@ function option_update_filter( $options ) {
return $options;
}
-add_filter( 'whitelist_options', 'option_update_filter' );
/**
- * {@internal Missing Short Description}}
+ * Adds an array of options to the options whitelist.
+ *
+ * @since 2.7.0
*
- * @since unknown
+ * @global array $whitelist_options
*
- * @param unknown_type $new_options
- * @param unknown_type $options
- * @return unknown
+ * @param array $new_options
+ * @param string|array $options
+ * @return array
*/
function add_option_whitelist( $new_options, $options = '' ) {
if ( $options == '' )
@@ -1560,13 +1871,15 @@ function add_option_whitelist( $new_options, $options = '' ) {
}
/**
- * {@internal Missing Short Description}}
+ * Removes a list of options from the options whitelist.
*
- * @since unknown
+ * @since 2.7.0
+ *
+ * @global array $whitelist_options
*
- * @param unknown_type $del_options
- * @param unknown_type $options
- * @return unknown
+ * @param array $del_options
+ * @param string|array $options
+ * @return array
*/
function remove_option_whitelist( $del_options, $options = '' ) {
if ( $options == '' )
@@ -1592,7 +1905,7 @@ function remove_option_whitelist( $del_options, $options = '' ) {
*
* @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 "";
@@ -1600,4 +1913,23 @@ function settings_fields($option_group) {
wp_nonce_field("$option_group-options");
}
-?>
+/**
+ * Clears the Plugins cache used by get_plugins() and by default, the Plugin Update cache.
+ *
+ * @since 3.7.0
+ *
+ * @param bool $clear_update_cache Whether to clear the Plugin updates cache
+ */
+function wp_clean_plugins_cache( $clear_update_cache = true ) {
+ if ( $clear_update_cache )
+ delete_site_transient( 'update_plugins' );
+ wp_cache_delete( 'plugins', 'plugins' );
+}
+
+/**
+ * @param string $plugin
+ */
+function plugin_sandbox_scrape( $plugin ) {
+ wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
+ include( WP_PLUGIN_DIR . '/' . $plugin );
+}