2007-05-25 03:16:21 -04:00
< ? php
2008-07-17 18:51:26 -04:00
/**
* WordPress Plugin Administration API
*
* @ package WordPress
* @ subpackage Administration
*/
2007-05-25 03:16:21 -04:00
2008-07-17 18:51:26 -04:00
/**
2008-07-22 15:18:07 -04:00
* Parse the plugin contents to retrieve plugin ' s metadata .
2008-07-17 18:51:26 -04:00
*
* The metadata of the plugin 's data searches for the following in the plugin' s
2008-07-22 15:18:07 -04:00
* 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 .
2008-07-17 18:51:26 -04:00
*
* < code >
* /*
* 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 ()
2008-07-22 15:18:07 -04:00
* 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 .
2010-02-05 16:33:53 -05:00
* 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 .
2008-07-17 18:51:26 -04:00
* * / # 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 .
* 'Description' - Description of what the plugin does and / or notes
* from the author .
2008-07-22 15:18:07 -04:00
* 'Author' - The author ' s name
* 'AuthorURI' - The authors web site address .
2008-07-17 18:51:26 -04:00
* 'Version' - The plugin version number .
2008-07-22 15:18:07 -04:00
* 'PluginURI' - Plugin web site address .
* 'TextDomain' - Plugin ' s text domain for localization .
* 'DomainPath' - Plugin ' s relative directory path to . mo files .
2010-02-05 16:33:53 -05:00
* 'Network' - Boolean . Whether the plugin can only be activated network wide .
2008-07-22 15:18:07 -04:00
*
* Some users have issues with opening large files and manipulating the contents
* for want is usually the first 1 kiB or 2 kiB . This function stops pulling in
* the plugin contents when it has all of the required plugin data .
*
* The first 8 kiB of the file will be pulled in and if the plugin data is not
* within that first 8 kiB , then the plugin author should correct their plugin
* and move the plugin data headers to the top .
*
* 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 http :// trac . wordpress . org / ticket / 7372 Further and better Optimizations .
* @ since 1.5 . 0
2008-07-17 18:51:26 -04:00
*
* @ param string $plugin_file Path to the plugin file
2012-03-20 19:04:59 -04:00
* @ 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 .
2008-07-17 18:51:26 -04:00
* @ return array See above for description .
*/
2008-10-21 20:08:22 -04:00
function get_plugin_data ( $plugin_file , $markup = true , $translate = true ) {
2008-07-22 15:18:07 -04:00
2010-01-15 17:11:12 -05:00
$default_headers = array (
'Name' => 'Plugin Name' ,
'PluginURI' => 'Plugin URI' ,
'Version' => 'Version' ,
'Description' => 'Description' ,
'Author' => 'Author' ,
'AuthorURI' => 'Author URI' ,
'TextDomain' => 'Text Domain' ,
2010-02-05 16:33:53 -05:00
'DomainPath' => 'Domain Path' ,
'Network' => 'Network' ,
// Site Wide Only is deprecated in favor of Network.
'_sitewide' => 'Site Wide Only' ,
);
2008-07-22 15:18:07 -04:00
2009-10-15 17:07:00 -04:00
$plugin_data = get_file_data ( $plugin_file , $default_headers , 'plugin' );
2008-07-22 15:18:07 -04:00
2010-02-05 16:33:53 -05:00
// Site Wide Only is the old header for Network
2012-03-20 19:04:59 -04:00
if ( ! $plugin_data [ 'Network' ] && $plugin_data [ '_sitewide' ] ) {
2010-02-05 16:33:53 -05:00
_deprecated_argument ( __FUNCTION__ , '3.0' , sprintf ( __ ( 'The <code>%1$s</code> plugin header is deprecated. Use <code>%2$s</code> instead.' ), 'Site Wide Only: true' , 'Network: true' ) );
$plugin_data [ 'Network' ] = $plugin_data [ '_sitewide' ];
}
2010-03-19 17:15:00 -04:00
$plugin_data [ 'Network' ] = ( 'true' == strtolower ( $plugin_data [ 'Network' ] ) );
2010-02-05 16:33:53 -05:00
unset ( $plugin_data [ '_sitewide' ] );
2012-03-20 19:04:59 -04:00
if ( $markup || $translate ) {
2009-10-15 17:07:00 -04:00
$plugin_data = _get_plugin_data_markup_translate ( $plugin_file , $plugin_data , $markup , $translate );
2012-03-20 19:04:59 -04:00
} else {
$plugin_data [ 'Title' ] = $plugin_data [ 'Name' ];
2010-12-06 16:18:18 -05:00
$plugin_data [ 'AuthorName' ] = $plugin_data [ 'Author' ];
2012-03-20 19:04:59 -04:00
}
2009-02-22 15:05:11 -05:00
2008-10-21 20:08:22 -04:00
return $plugin_data ;
}
2012-03-20 19:04:59 -04:00
/**
* 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 ) {
2008-10-21 20:08:22 -04:00
2013-08-22 00:03:09 -04:00
// Sanitize the plugin filename to a WP_PLUGIN_DIR relative path
$plugin_file = plugin_basename ( $plugin_file );
2012-03-20 19:04:59 -04:00
// Translate fields
2012-02-21 10:26:08 -05:00
if ( $translate ) {
if ( $textdomain = $plugin_data [ 'TextDomain' ] ) {
2012-03-20 19:04:59 -04:00
if ( $plugin_data [ 'DomainPath' ] )
2012-02-21 10:26:08 -05:00
load_plugin_textdomain ( $textdomain , false , dirname ( $plugin_file ) . $plugin_data [ 'DomainPath' ] );
else
load_plugin_textdomain ( $textdomain , false , dirname ( $plugin_file ) );
} elseif ( in_array ( basename ( $plugin_file ), array ( 'hello.php' , 'akismet.php' ) ) ) {
$textdomain = 'default' ;
}
if ( $textdomain ) {
foreach ( array ( 'Name' , 'PluginURI' , 'Description' , 'Author' , 'AuthorURI' , 'Version' ) as $field )
$plugin_data [ $field ] = translate ( $plugin_data [ $field ], $textdomain );
}
2008-10-21 20:08:22 -04:00
}
2012-03-20 19:04:59 -04:00
// Sanitize fields
$allowed_tags = $allowed_tags_in_links = array (
'abbr' => array ( 'title' => true ),
'acronym' => array ( 'title' => true ),
'code' => true ,
'em' => true ,
'strong' => true ,
2010-12-06 15:49:54 -05:00
);
2012-03-20 19:04:59 -04:00
$allowed_tags [ 'a' ] = array ( 'href' => true , 'title' => true );
2010-12-06 15:49:54 -05:00
2012-03-20 19:04:59 -04:00
// Name is marked up inside <a> tags. Don't allow these.
// Author is too, but some plugins have used <a> here (omitting Author URI).
$plugin_data [ 'Name' ] = wp_kses ( $plugin_data [ 'Name' ], $allowed_tags_in_links );
$plugin_data [ 'Author' ] = wp_kses ( $plugin_data [ 'Author' ], $allowed_tags );
2010-12-06 15:49:54 -05:00
2012-03-20 19:04:59 -04:00
$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
2008-10-21 20:08:22 -04:00
if ( $markup ) {
2012-03-20 19:04:59 -04:00
if ( $plugin_data [ 'PluginURI' ] && $plugin_data [ 'Name' ] )
2013-07-08 09:04:07 -04:00
$plugin_data [ 'Title' ] = '<a href="' . $plugin_data [ 'PluginURI' ] . '" title="' . esc_attr__ ( 'Visit plugin homepage' ) . '">' . $plugin_data [ 'Name' ] . '</a>' ;
2008-10-21 20:08:22 -04:00
2012-03-20 19:04:59 -04:00
if ( $plugin_data [ 'AuthorURI' ] && $plugin_data [ 'Author' ] )
2013-07-08 09:04:07 -04:00
$plugin_data [ 'Author' ] = '<a href="' . $plugin_data [ 'AuthorURI' ] . '" title="' . esc_attr__ ( 'Visit author homepage' ) . '">' . $plugin_data [ 'Author' ] . '</a>' ;
2008-10-21 20:08:22 -04:00
$plugin_data [ 'Description' ] = wptexturize ( $plugin_data [ 'Description' ] );
2012-03-20 19:04:59 -04:00
if ( $plugin_data [ 'Author' ] )
$plugin_data [ 'Description' ] .= ' <cite>' . sprintf ( __ ( 'By %s.' ), $plugin_data [ 'Author' ] ) . '</cite>' ;
}
2008-10-21 20:08:22 -04:00
return $plugin_data ;
2007-05-25 03:16:21 -04:00
}
2009-02-22 15:05:11 -05:00
/**
* Get a list of a plugin ' s files .
*
* @ since 2.8 . 0
*
* @ param string $plugin Plugin ID
* @ return array List of files relative to the plugin root .
*/
function get_plugin_files ( $plugin ) {
$plugin_file = WP_PLUGIN_DIR . '/' . $plugin ;
$dir = dirname ( $plugin_file );
$plugin_files = array ( $plugin );
if ( is_dir ( $dir ) && $dir != WP_PLUGIN_DIR ) {
$plugins_dir = @ opendir ( $dir );
if ( $plugins_dir ) {
while (( $file = readdir ( $plugins_dir ) ) !== false ) {
if ( substr ( $file , 0 , 1 ) == '.' )
continue ;
if ( is_dir ( $dir . '/' . $file ) ) {
$plugins_subdir = @ opendir ( $dir . '/' . $file );
if ( $plugins_subdir ) {
while (( $subfile = readdir ( $plugins_subdir ) ) !== false ) {
if ( substr ( $subfile , 0 , 1 ) == '.' )
continue ;
$plugin_files [] = plugin_basename ( " $dir / $file / $subfile " );
}
@ closedir ( $plugins_subdir );
}
} else {
if ( plugin_basename ( " $dir / $file " ) != $plugin )
$plugin_files [] = plugin_basename ( " $dir / $file " );
}
}
@ closedir ( $plugins_dir );
}
}
return $plugin_files ;
}
2008-09-16 20:40:10 -04:00
/**
* Check the plugins directory and retrieve all plugin files with plugin data .
*
* 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 .
*
* 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
* everything must be contained in the file and it is recommended that the file
* be split for maintainability . Keep everything in one file for extreme
* optimization purposes .
*
2010-12-01 14:24:38 -05:00
* @ since 1.5 . 0
2008-09-16 20:40:10 -04:00
*
* @ 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 .
*/
2008-03-21 19:02:00 -04:00
function get_plugins ( $plugin_folder = '' ) {
2008-08-09 01:36:14 -04:00
2008-06-10 12:57:33 -04:00
if ( ! $cache_plugins = wp_cache_get ( 'plugins' , 'plugins' ) )
2008-08-01 00:26:32 -04:00
$cache_plugins = array ();
2008-08-09 01:36:14 -04:00
2008-06-10 12:57:33 -04:00
if ( isset ( $cache_plugins [ $plugin_folder ]) )
return $cache_plugins [ $plugin_folder ];
2008-08-09 01:36:14 -04:00
2007-05-25 03:16:21 -04:00
$wp_plugins = array ();
2008-05-27 13:55:24 -04:00
$plugin_root = WP_PLUGIN_DIR ;
2010-01-18 15:34:48 -05:00
if ( ! empty ( $plugin_folder ) )
2008-03-21 19:02:00 -04:00
$plugin_root .= $plugin_folder ;
2007-05-25 03:16:21 -04:00
// Files in wp-content/plugins directory
2007-08-13 22:58:33 -04:00
$plugins_dir = @ opendir ( $plugin_root );
2009-04-19 15:36:28 -04:00
$plugin_files = array ();
2007-05-25 03:16:21 -04:00
if ( $plugins_dir ) {
2007-08-13 22:58:33 -04:00
while (( $file = readdir ( $plugins_dir ) ) !== false ) {
2007-05-25 03:16:21 -04:00
if ( substr ( $file , 0 , 1 ) == '.' )
continue ;
if ( is_dir ( $plugin_root . '/' . $file ) ) {
2007-08-13 22:58:33 -04:00
$plugins_subdir = @ opendir ( $plugin_root . '/' . $file );
2007-05-25 03:16:21 -04:00
if ( $plugins_subdir ) {
2007-08-13 22:58:33 -04:00
while (( $subfile = readdir ( $plugins_subdir ) ) !== false ) {
2007-05-25 03:16:21 -04:00
if ( substr ( $subfile , 0 , 1 ) == '.' )
continue ;
if ( substr ( $subfile , - 4 ) == '.php' )
$plugin_files [] = " $file / $subfile " ;
}
2011-04-07 05:07:56 -04:00
closedir ( $plugins_subdir );
2007-05-25 03:16:21 -04:00
}
} else {
if ( substr ( $file , - 4 ) == '.php' )
$plugin_files [] = $file ;
}
}
2011-04-07 05:07:56 -04:00
closedir ( $plugins_dir );
2007-05-25 03:16:21 -04:00
}
2010-05-10 12:06:46 -04:00
if ( empty ( $plugin_files ) )
2007-05-25 03:16:21 -04:00
return $wp_plugins ;
foreach ( $plugin_files as $plugin_file ) {
if ( ! is_readable ( " $plugin_root / $plugin_file " ) )
continue ;
2008-10-21 20:08:22 -04:00
$plugin_data = get_plugin_data ( " $plugin_root / $plugin_file " , false , false ); //Do not apply markup/translate as it'll be cached.
2007-05-25 03:16:21 -04:00
if ( empty ( $plugin_data [ 'Name' ] ) )
continue ;
$wp_plugins [ plugin_basename ( $plugin_file )] = $plugin_data ;
}
2010-11-11 17:50:36 -05:00
uasort ( $wp_plugins , '_sort_uname_callback' );
2007-05-25 03:16:21 -04:00
2008-08-09 01:36:14 -04:00
$cache_plugins [ $plugin_folder ] = $wp_plugins ;
wp_cache_set ( 'plugins' , $cache_plugins , 'plugins' );
2008-06-10 12:57:33 -04:00
2007-05-25 03:16:21 -04:00
return $wp_plugins ;
}
2010-02-19 16:16:14 -05:00
/**
* Check the mu - plugins directory and retrieve all mu - plugin files with any plugin data .
*
* WordPress only includes mu - plugin files in the base mu - plugins directory ( wp - content / mu - plugins ) .
*
* @ since 3.0 . 0
* @ return array Key is the mu - plugin file path and the value is an array of the mu - plugin data .
*/
function get_mu_plugins () {
$wp_plugins = array ();
// Files in wp-content/mu-plugins directory
$plugin_files = array ();
if ( ! is_dir ( WPMU_PLUGIN_DIR ) )
return $wp_plugins ;
if ( $plugins_dir = @ opendir ( WPMU_PLUGIN_DIR ) ) {
while ( ( $file = readdir ( $plugins_dir ) ) !== false ) {
if ( substr ( $file , - 4 ) == '.php' )
$plugin_files [] = $file ;
}
2010-05-10 16:40:15 -04:00
} else {
return $wp_plugins ;
2010-02-19 16:16:14 -05:00
}
@ closedir ( $plugins_dir );
2010-05-10 16:40:15 -04:00
if ( empty ( $plugin_files ) )
2010-02-19 16:16:14 -05:00
return $wp_plugins ;
foreach ( $plugin_files as $plugin_file ) {
if ( ! is_readable ( WPMU_PLUGIN_DIR . " / $plugin_file " ) )
continue ;
$plugin_data = get_plugin_data ( WPMU_PLUGIN_DIR . " / $plugin_file " , false , false ); //Do not apply markup/translate as it'll be cached.
if ( empty ( $plugin_data [ 'Name' ] ) )
$plugin_data [ 'Name' ] = $plugin_file ;
$wp_plugins [ $plugin_file ] = $plugin_data ;
}
if ( isset ( $wp_plugins [ 'index.php' ] ) && filesize ( WPMU_PLUGIN_DIR . '/index.php' ) <= 30 ) // silence is golden
unset ( $wp_plugins [ 'index.php' ] );
2010-11-11 17:50:36 -05:00
uasort ( $wp_plugins , '_sort_uname_callback' );
2010-02-19 16:16:14 -05:00
return $wp_plugins ;
}
2010-11-11 17:50:36 -05:00
/**
* 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' ] );
}
2010-02-19 16:16:14 -05:00
/**
* Check the wp - content directory and retrieve all drop - ins with any plugin data .
*
* @ since 3.0 . 0
* @ return array Key is the file path and the value is an array of the plugin data .
*/
function get_dropins () {
$dropins = array ();
$plugin_files = array ();
$_dropins = _get_dropins ();
// These exist in the wp-content directory
if ( $plugins_dir = @ opendir ( WP_CONTENT_DIR ) ) {
while ( ( $file = readdir ( $plugins_dir ) ) !== false ) {
if ( isset ( $_dropins [ $file ] ) )
$plugin_files [] = $file ;
2010-05-10 16:41:14 -04:00
}
2010-05-10 16:40:15 -04:00
} else {
return $dropins ;
2010-02-19 16:16:14 -05:00
}
@ closedir ( $plugins_dir );
2010-05-10 16:40:15 -04:00
if ( empty ( $plugin_files ) )
return $dropins ;
2010-02-19 16:16:14 -05:00
foreach ( $plugin_files as $plugin_file ) {
2010-05-10 16:41:14 -04:00
if ( ! is_readable ( WP_CONTENT_DIR . " / $plugin_file " ) )
continue ;
$plugin_data = get_plugin_data ( WP_CONTENT_DIR . " / $plugin_file " , false , false ); //Do not apply markup/translate as it'll be cached.
if ( empty ( $plugin_data [ 'Name' ] ) )
$plugin_data [ 'Name' ] = $plugin_file ;
$dropins [ $plugin_file ] = $plugin_data ;
2010-02-19 16:16:14 -05:00
}
2010-11-11 17:50:36 -05:00
uksort ( $dropins , 'strnatcasecmp' );
2010-02-19 16:16:14 -05:00
return $dropins ;
}
/**
* Returns drop - ins that WordPress uses .
*
* Includes Multisite drop - ins only when is_multisite ()
*
* @ since 3.0 . 0
* @ return array Key is file name . The value is an array , with the first value the
* purpose of the drop - in and the second value the name of the constant that must be
* true for the drop - in to be used , or true if no constant is required .
*/
function _get_dropins () {
$dropins = array (
'advanced-cache.php' => array ( __ ( 'Advanced caching plugin.' ), 'WP_CACHE' ), // WP_CACHE
'db.php' => array ( __ ( 'Custom database class.' ), true ), // auto on load
'db-error.php' => array ( __ ( 'Custom database error message.' ), true ), // auto on error
'install.php' => array ( __ ( 'Custom install script.' ), true ), // auto on install
'maintenance.php' => array ( __ ( 'Custom maintenance message.' ), true ), // auto on maintenance
'object-cache.php' => array ( __ ( 'External object cache.' ), true ), // auto on load
);
if ( is_multisite () ) {
$dropins [ 'sunrise.php' ] = array ( __ ( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE
2010-04-29 23:17:49 -04:00
$dropins [ 'blog-deleted.php' ] = array ( __ ( 'Custom site deleted message.' ), true ); // auto on deleted blog
$dropins [ 'blog-inactive.php' ] = array ( __ ( 'Custom site inactive message.' ), true ); // auto on inactive blog
$dropins [ 'blog-suspended.php' ] = array ( __ ( 'Custom site suspended message.' ), true ); // auto on archived or spammed blog
2010-02-19 16:16:14 -05:00
}
return $dropins ;
}
2008-08-07 19:39:27 -04:00
/**
* Check whether the plugin is active by checking the active_plugins list .
*
* @ since 2.5 . 0
*
* @ param string $plugin Base plugin path from plugins directory .
* @ return bool True , if in the active plugins list . False , not in the list .
*/
2010-01-26 13:39:12 -05:00
function is_plugin_active ( $plugin ) {
2010-02-04 13:50:36 -05:00
return in_array ( $plugin , ( array ) get_option ( 'active_plugins' , array () ) ) || is_plugin_active_for_network ( $plugin );
2008-03-21 19:02:00 -04:00
}
2010-11-11 17:21:04 -05:00
/**
* 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 );
}
2010-01-29 16:45:32 -05:00
/**
* Check whether the plugin is active for the entire network .
*
* @ since 3.0 . 0
*
* @ param string $plugin Base plugin path from plugins directory .
* @ return bool True , if active for the network , otherwise false .
*/
2010-02-04 13:50:36 -05:00
function is_plugin_active_for_network ( $plugin ) {
2010-01-29 16:45:32 -05:00
if ( ! is_multisite () )
return false ;
$plugins = get_site_option ( 'active_sitewide_plugins' );
if ( isset ( $plugins [ $plugin ]) )
return true ;
return false ;
}
/**
2010-02-05 16:33:53 -05:00
* Checks for " Network: true " in the plugin header to see if this should
* be activated only as a network wide plugin . The plugin would also work
* when Multisite is not enabled .
2010-01-29 16:45:32 -05:00
*
2010-02-05 16:33:53 -05:00
* Checks for " Site Wide Only: true " for backwards compatibility .
2010-01-29 16:45:32 -05:00
*
2010-02-05 16:33:53 -05:00
* @ since 3.0 . 0
2010-01-29 16:45:32 -05:00
*
2010-09-07 07:21:11 -04:00
* @ param string $plugin Plugin to check
* @ return bool True if plugin is network only , false otherwise .
2010-01-29 16:45:32 -05:00
*/
2010-02-05 16:33:53 -05:00
function is_network_only_plugin ( $plugin ) {
$plugin_data = get_plugin_data ( WP_PLUGIN_DIR . '/' . $plugin );
if ( $plugin_data )
return $plugin_data [ 'Network' ];
2010-01-29 16:45:32 -05:00
return false ;
}
2008-09-16 20:40:10 -04:00
/**
* Attempts activation of plugin in a " sandbox " and redirects on success .
*
* A plugin that is already activated will not attempt to be activated again .
*
* The way it works is by setting the redirection to the error before trying to
* include the plugin file . If the plugin fails , then the redirection will not
* be overwritten with the success message . Also , the options will not be
* updated and the activation hook will not be called on plugin error .
*
* It should be noted that in no way the below code will actually prevent errors
* within the file . The code should not be used elsewhere to replicate the
* " sandbox " , which uses redirection to work .
* { @ source 13 1 }
*
* If any errors are found or text is outputted , then it will be captured to
* ensure that the success redirection will update the error redirection .
*
2010-12-01 14:24:38 -05:00
* @ since 2.5 . 0
2008-09-16 20:40:10 -04:00
*
* @ param string $plugin Plugin path to main plugin file with plugin data .
* @ param string $redirect Optional . URL to redirect to .
2010-11-17 13:47:34 -05:00
* @ param bool $network_wide Whether to enable the plugin for all sites in the
2010-10-27 09:40:14 -04:00
* network or just the current site . Multisite only . Default is false .
* @ param bool $silent Prevent calling activation hooks . Optional , default is false .
2008-09-16 20:40:10 -04:00
* @ return WP_Error | null WP_Error on invalid file or null on success .
*/
2010-10-27 09:40:14 -04:00
function activate_plugin ( $plugin , $redirect = '' , $network_wide = false , $silent = false ) {
2010-10-27 09:20:53 -04:00
$plugin = plugin_basename ( trim ( $plugin ) );
2008-09-16 20:40:10 -04:00
2010-01-29 16:45:32 -05:00
if ( is_multisite () && ( $network_wide || is_network_only_plugin ( $plugin ) ) ) {
$network_wide = true ;
$current = get_site_option ( 'active_sitewide_plugins' , array () );
2012-06-25 15:32:34 -04:00
$_GET [ 'networkwide' ] = 1 ; // Back compat for plugins looking for this value.
2010-01-29 16:45:32 -05:00
} else {
$current = get_option ( 'active_plugins' , array () );
}
2008-09-16 20:40:10 -04:00
$valid = validate_plugin ( $plugin );
if ( is_wp_error ( $valid ) )
return $valid ;
2007-10-17 13:14:58 -04:00
2008-09-16 20:40:10 -04:00
if ( ! in_array ( $plugin , $current ) ) {
if ( ! empty ( $redirect ) )
wp_redirect ( add_query_arg ( '_error_nonce' , wp_create_nonce ( 'plugin-activation-error_' . $plugin ), $redirect )); // we'll override this later if the plugin can be included without fatal error
ob_start ();
2014-02-10 18:00:15 -05:00
wp_register_plugin_realpath ( WP_PLUGIN_DIR . '/' . $plugin );
include_once ( WP_PLUGIN_DIR . '/' . $plugin );
2010-10-27 09:40:14 -04:00
if ( ! $silent ) {
2013-09-18 03:38:12 -04:00
/**
2014-03-26 22:02:14 -04:00
* Fires before a plugin is activated .
*
* If a plugin is silently activated ( such as during an update ),
* this hook does not fire .
2013-10-24 22:29:52 -04:00
*
2013-09-18 07:58:10 -04:00
* @ since 2.9 . 0
2013-09-18 03:38:12 -04:00
*
2013-09-18 15:36:09 -04:00
* @ 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 .
2013-09-18 03:38:12 -04:00
*/
2010-10-27 09:40:14 -04:00
do_action ( 'activate_plugin' , $plugin , $network_wide );
2013-09-18 03:38:12 -04:00
/**
2014-03-26 22:02:14 -04:00
* Fires as a specific plugin is being deactivated .
*
* This hook is the " deactivation " hook used internally by
* register_deactivation_hook () . The dynamic portion of the
* hook name , $plugin . refers to the plugin basename .
2013-10-24 22:29:52 -04:00
*
2014-03-26 22:02:14 -04:00
* If a plugin is silently activated ( such as during an update ),
* this hook does not fire .
2013-10-24 22:29:52 -04:00
*
2013-09-18 07:58:10 -04:00
* @ since 2.0 . 0
2013-09-18 03:38:12 -04:00
*
2013-09-18 15:36:09 -04:00
* @ 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 .
2013-09-18 03:38:12 -04:00
*/
2010-10-27 09:40:14 -04:00
do_action ( 'activate_' . $plugin , $network_wide );
}
2010-01-29 16:45:32 -05:00
if ( $network_wide ) {
$current [ $plugin ] = time ();
update_site_option ( 'active_sitewide_plugins' , $current );
} else {
$current [] = $plugin ;
sort ( $current );
update_option ( 'active_plugins' , $current );
}
2010-10-27 09:40:14 -04:00
if ( ! $silent ) {
2013-09-18 03:38:12 -04:00
/**
2014-03-26 22:02:14 -04:00
* Fires after a plugin has been activated .
*
* If a plugin is silently activated ( such as during an update ),
* this hook does not fire .
2013-10-24 22:29:52 -04:00
*
2013-09-18 07:58:10 -04:00
* @ since 2.9 . 0
2013-09-18 03:38:12 -04:00
*
2013-09-18 15:36:09 -04:00
* @ 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 .
2013-09-18 03:38:12 -04:00
*/
2010-10-27 09:40:14 -04:00
do_action ( 'activated_plugin' , $plugin , $network_wide );
}
2010-05-27 20:18:00 -04:00
if ( ob_get_length () > 0 ) {
$output = ob_get_clean ();
return new WP_Error ( 'unexpected_output' , __ ( 'The plugin generated unexpected output.' ), $output );
}
2008-09-16 20:40:10 -04:00
ob_end_clean ();
}
return null ;
2007-10-17 13:14:58 -04:00
}
2008-09-16 20:40:10 -04:00
/**
* Deactivate a single plugin or multiple plugins .
*
* The deactivation hook is disabled by the plugin upgrader by using the $silent
* parameter .
*
2010-12-01 14:24:38 -05:00
* @ since 2.5 . 0
2008-09-16 20:40:10 -04:00
*
* @ param string | array $plugins Single plugin or list of plugins to deactivate .
2012-07-20 11:09:40 -04:00
* @ param bool $silent Prevent calling deactivation hooks . Default is false .
2012-04-18 23:41:29 -04:00
* @ 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 .
2008-09-16 20:40:10 -04:00
*/
2012-04-18 23:41:29 -04:00
function deactivate_plugins ( $plugins , $silent = false , $network_wide = null ) {
2010-07-07 16:35:51 -04:00
if ( is_multisite () )
$network_current = get_site_option ( 'active_sitewide_plugins' , array () );
2010-01-26 13:39:12 -05:00
$current = get_option ( 'active_plugins' , array () );
2010-01-29 16:45:32 -05:00
$do_blog = $do_network = false ;
2007-10-17 13:14:58 -04:00
2010-01-26 13:39:12 -05:00
foreach ( ( array ) $plugins as $plugin ) {
2010-10-27 09:20:53 -04:00
$plugin = plugin_basename ( trim ( $plugin ) );
2010-01-18 15:34:48 -05:00
if ( ! is_plugin_active ( $plugin ) )
2008-03-20 13:24:44 -04:00
continue ;
2010-10-27 09:20:53 -04:00
2012-04-18 23:41:29 -04:00
$network_deactivating = false !== $network_wide && is_plugin_active_for_network ( $plugin );
2010-10-27 09:20:53 -04:00
2013-12-01 18:13:09 -05:00
if ( ! $silent ) {
2013-09-18 03:38:12 -04:00
/**
2014-03-26 22:02:14 -04:00
* Fires before a plugin is deactivated .
*
* If a plugin is silently deactivated ( such as during an update ),
* this hook does not fire .
2013-10-24 22:29:52 -04:00
*
2013-09-18 07:58:10 -04:00
* @ since 2.9 . 0
2013-09-18 03:38:12 -04:00
*
2013-09-18 15:36:09 -04:00
* @ param string $plugin Plugin path to main plugin file with plugin data .
2013-10-24 22:29:52 -04:00
* @ param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
2013-09-18 15:36:09 -04:00
* or just the current site . Multisite only . Default is false .
2013-09-18 03:38:12 -04:00
*/
2012-04-18 23:41:29 -04:00
do_action ( 'deactivate_plugin' , $plugin , $network_deactivating );
2013-12-01 18:13:09 -05:00
}
2009-09-24 13:19:13 -04:00
2012-04-18 23:41:29 -04:00
if ( false !== $network_wide ) {
2012-04-20 20:45:53 -04:00
if ( is_plugin_active_for_network ( $plugin ) ) {
$do_network = true ;
unset ( $network_current [ $plugin ] );
} elseif ( $network_wide ) {
2012-04-18 23:41:29 -04:00
continue ;
2012-04-20 20:45:53 -04:00
}
2012-04-18 23:41:29 -04:00
}
if ( true !== $network_wide ) {
2010-10-27 09:20:53 -04:00
$key = array_search ( $plugin , $current );
2010-02-05 13:10:30 -05:00
if ( false !== $key ) {
$do_blog = true ;
2012-09-10 22:12:34 -04:00
unset ( $current [ $key ] );
2010-02-05 13:10:30 -05:00
}
2010-01-29 16:45:32 -05:00
}
2009-09-24 13:19:13 -04:00
2009-09-10 10:43:45 -04:00
if ( ! $silent ) {
2013-09-18 03:38:12 -04:00
/**
2014-03-26 22:02:14 -04:00
* Fires as a specific plugin is being deactivated .
2014-03-10 17:34:17 -04:00
*
2014-03-26 22:02:14 -04:00
* This hook is the " deactivation " hook used internally by
* register_deactivation_hook () . The dynamic portion of the
* hook name , $plugin . refers to the plugin basename .
2013-10-24 22:29:52 -04:00
*
2014-03-26 22:02:14 -04:00
* If a plugin is silently deactivated ( such as during an update ),
* this hook does not fire .
2013-10-24 22:29:52 -04:00
*
2013-09-18 07:58:10 -04:00
* @ since 2.0 . 0
2013-09-18 03:38:12 -04:00
*
2013-10-24 22:29:52 -04:00
* @ param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
2013-09-18 15:36:09 -04:00
* or just the current site . Multisite only . Default is false .
2013-09-18 03:38:12 -04:00
*/
2012-04-18 23:41:29 -04:00
do_action ( 'deactivate_' . $plugin , $network_deactivating );
2013-09-18 03:38:12 -04:00
/**
2014-03-26 22:02:14 -04:00
* Fires after a plugin is deactivated .
2014-03-10 17:34:17 -04:00
*
2014-03-26 22:02:14 -04:00
* If a plugin is silently deactivated ( such as during an update ),
* this hook does not fire .
2013-10-24 22:29:52 -04:00
*
2013-09-18 07:58:10 -04:00
* @ since 2.9 . 0
2013-09-18 03:38:12 -04:00
*
2014-03-10 17:34:17 -04:00
* @ param string $plugin Plugin basename .
2013-10-24 22:29:52 -04:00
* @ param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
2014-03-10 17:34:17 -04:00
* or just the current site . Multisite only . Default false .
2013-09-18 03:38:12 -04:00
*/
2012-04-18 23:41:29 -04:00
do_action ( 'deactivated_plugin' , $plugin , $network_deactivating );
2009-09-10 10:43:45 -04:00
}
2007-10-17 13:14:58 -04:00
}
2010-01-29 16:45:32 -05:00
if ( $do_blog )
update_option ( 'active_plugins' , $current );
if ( $do_network )
update_site_option ( 'active_sitewide_plugins' , $network_current );
2007-10-17 13:14:58 -04:00
}
2008-09-16 20:40:10 -04:00
/**
* Activate multiple plugins .
*
* When WP_Error is returned , it does not mean that one of the plugins had
* errors . It means that one or more of the plugins file path was invalid .
*
* The execution will be halted as soon as one of the plugins has an error .
*
2010-12-01 14:24:38 -05:00
* @ since 2.6 . 0
2008-09-16 20:40:10 -04:00
*
* @ param string | array $plugins
* @ param string $redirect Redirect to page after successful activation .
2010-03-17 12:27:25 -04:00
* @ param bool $network_wide Whether to enable the plugin for all sites in the network .
2010-10-27 09:40:14 -04:00
* @ param bool $silent Prevent calling activation hooks . Default is false .
2008-09-16 20:40:10 -04:00
* @ return bool | WP_Error True when finished or WP_Error if there were errors during a plugin activation .
*/
2010-10-27 09:40:14 -04:00
function activate_plugins ( $plugins , $redirect = '' , $network_wide = false , $silent = false ) {
2008-06-04 14:09:31 -04:00
if ( ! is_array ( $plugins ) )
$plugins = array ( $plugins );
2008-01-09 04:37:27 -05:00
2008-06-04 14:09:31 -04:00
$errors = array ();
2010-10-27 09:40:14 -04:00
foreach ( $plugins as $plugin ) {
2008-06-04 14:09:31 -04:00
if ( ! empty ( $redirect ) )
$redirect = add_query_arg ( 'plugin' , $plugin , $redirect );
2010-10-27 09:40:14 -04:00
$result = activate_plugin ( $plugin , $redirect , $network_wide , $silent );
2008-06-04 14:09:31 -04:00
if ( is_wp_error ( $result ) )
$errors [ $plugin ] = $result ;
}
2008-01-09 04:37:27 -05:00
2008-06-04 14:09:31 -04:00
if ( ! empty ( $errors ) )
return new WP_Error ( 'plugins_invalid' , __ ( 'One of the plugins is invalid.' ), $errors );
2008-01-09 04:37:27 -05:00
2008-06-04 14:09:31 -04:00
return true ;
}
2008-01-09 04:37:27 -05:00
2008-09-16 20:40:10 -04:00
/**
* Remove directory and files of a plugin for a single or list of plugin ( s ) .
*
* If the plugins parameter list is empty , false will be returned . True when
* completed .
*
2010-12-01 14:24:38 -05:00
* @ since 2.6 . 0
2008-09-16 20:40:10 -04:00
*
* @ param array $plugins List of plugin
* @ param string $redirect Redirect to page when complete .
* @ return mixed
*/
2008-06-04 14:09:31 -04:00
function delete_plugins ( $plugins , $redirect = '' ) {
global $wp_filesystem ;
2010-01-18 15:34:48 -05:00
if ( empty ( $plugins ) )
2008-06-04 14:09:31 -04:00
return false ;
$checked = array ();
foreach ( $plugins as $plugin )
$checked [] = 'checked[]=' . $plugin ;
ob_start ();
2010-09-08 08:15:50 -04:00
$url = wp_nonce_url ( 'plugins.php?action=delete-selected&verify-delete=1&' . implode ( '&' , $checked ), 'bulk-plugins' );
2008-06-04 14:09:31 -04:00
if ( false === ( $credentials = request_filesystem_credentials ( $url )) ) {
$data = ob_get_contents ();
ob_end_clean ();
2010-01-18 15:34:48 -05:00
if ( ! empty ( $data ) ){
2008-06-04 14:09:31 -04:00
include_once ( ABSPATH . 'wp-admin/admin-header.php' );
echo $data ;
include ( ABSPATH . 'wp-admin/admin-footer.php' );
exit ;
}
2008-01-09 04:37:27 -05:00
return ;
2008-06-04 14:09:31 -04:00
}
2008-01-09 04:37:27 -05:00
2008-06-04 14:09:31 -04:00
if ( ! WP_Filesystem ( $credentials ) ) {
request_filesystem_credentials ( $url , '' , true ); //Failed to connect, Error and request again
$data = ob_get_contents ();
ob_end_clean ();
2010-01-18 15:34:48 -05:00
if ( ! empty ( $data ) ){
2008-06-04 14:09:31 -04:00
include_once ( ABSPATH . 'wp-admin/admin-header.php' );
echo $data ;
include ( ABSPATH . 'wp-admin/admin-footer.php' );
exit ;
}
return ;
}
2008-01-09 04:37:27 -05:00
2008-06-04 14:09:31 -04:00
if ( ! is_object ( $wp_filesystem ) )
return new WP_Error ( 'fs_unavailable' , __ ( 'Could not access filesystem.' ));
2008-01-09 04:37:27 -05:00
2009-04-19 15:36:28 -04:00
if ( is_wp_error ( $wp_filesystem -> errors ) && $wp_filesystem -> errors -> get_error_code () )
2010-01-21 16:37:43 -05:00
return new WP_Error ( 'fs_error' , __ ( 'Filesystem error.' ), $wp_filesystem -> errors );
2008-06-04 14:09:31 -04:00
//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.' ));
2008-08-09 01:36:14 -04:00
2008-06-04 14:09:31 -04:00
$plugins_dir = trailingslashit ( $plugins_dir );
2008-01-09 04:37:27 -05:00
2008-06-04 14:09:31 -04:00
$errors = array ();
foreach ( $plugins as $plugin_file ) {
2008-08-07 19:39:27 -04:00
// Run Uninstall hook
if ( is_uninstallable_plugin ( $plugin_file ) )
uninstall_plugin ( $plugin_file );
2008-06-04 14:09:31 -04:00
$this_plugin_dir = trailingslashit ( dirname ( $plugins_dir . $plugin_file ) );
// If plugin is in its own directory, recursively delete the directory.
2012-12-20 10:55:32 -05:00
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
2008-06-04 14:09:31 -04:00
$deleted = $wp_filesystem -> delete ( $this_plugin_dir , true );
else
$deleted = $wp_filesystem -> delete ( $plugins_dir . $plugin_file );
2008-08-09 01:36:14 -04:00
2008-06-04 14:09:31 -04:00
if ( ! $deleted )
$errors [] = $plugin_file ;
}
2008-08-09 01:36:14 -04:00
2013-11-18 23:08:09 -05:00
// Remove deleted plugins from the plugin updates list.
2010-01-08 15:49:55 -05:00
if ( $current = get_site_transient ( 'update_plugins' ) ) {
2013-11-18 23:08:09 -05:00
// Don't remove the plugins that weren't deleted.
$deleted = array_diff ( $plugins , $errors );
2013-12-11 14:49:11 -05:00
2013-11-18 23:08:09 -05:00
foreach ( $deleted as $plugin_file ) {
unset ( $current -> response [ $plugin_file ] );
}
set_site_transient ( 'update_plugins' , $current );
2009-05-05 16:48:46 -04:00
}
2008-12-04 13:39:11 -05:00
2013-11-18 23:08:09 -05:00
if ( ! empty ( $errors ) )
return new WP_Error ( 'could_not_remove_plugin' , sprintf ( __ ( 'Could not fully remove the plugin(s) %s.' ), implode ( ', ' , $errors )) );
2008-01-09 04:37:27 -05:00
return true ;
}
2010-01-26 13:39:12 -05:00
/**
2010-02-02 16:41:17 -05:00
* Validate active plugins
2010-01-26 17:49:05 -05:00
*
2010-02-02 16:41:17 -05:00
* Validate all active plugins , deactivates invalid and
* returns an array of deactivated ones .
2010-01-26 17:49:05 -05:00
*
2010-12-01 14:24:38 -05:00
* @ since 2.5 . 0
2010-01-26 13:39:12 -05:00
* @ return array invalid plugins , plugin as key , error as value
*/
2008-01-09 04:37:27 -05:00
function validate_active_plugins () {
2010-02-04 13:50:36 -05:00
$plugins = get_option ( 'active_plugins' , array () );
2010-01-26 13:39:12 -05:00
// validate vartype: array
2010-02-02 16:41:17 -05:00
if ( ! is_array ( $plugins ) ) {
update_option ( 'active_plugins' , array () );
$plugins = array ();
2008-01-09 04:37:27 -05:00
}
2013-12-03 16:12:10 -05:00
if ( is_multisite () && current_user_can ( 'manage_network_plugins' ) ) {
2010-02-02 16:41:17 -05:00
$network_plugins = ( array ) get_site_option ( 'active_sitewide_plugins' , array () );
2010-02-05 13:10:30 -05:00
$plugins = array_merge ( $plugins , array_keys ( $network_plugins ) );
2010-02-02 16:41:17 -05:00
}
if ( empty ( $plugins ) )
return ;
2008-08-09 01:36:14 -04:00
$invalid = array ();
2008-07-29 19:10:12 -04:00
2010-01-26 13:39:12 -05:00
// invalid plugins get deactivated
foreach ( $plugins as $plugin ) {
$result = validate_plugin ( $plugin );
2008-06-16 14:35:48 -04:00
if ( is_wp_error ( $result ) ) {
2010-01-26 13:39:12 -05:00
$invalid [ $plugin ] = $result ;
deactivate_plugins ( $plugin , true );
2008-01-09 04:37:27 -05:00
}
}
2008-07-29 19:10:12 -04:00
return $invalid ;
2008-01-09 04:37:27 -05:00
}
2008-09-16 20:40:10 -04:00
/**
* Validate the plugin path .
*
* Checks that the file exists and { @ link validate_file () is valid file } .
*
2010-12-01 14:24:38 -05:00
* @ since 2.5 . 0
2008-09-16 20:40:10 -04:00
*
* @ param string $plugin Plugin Path
* @ return WP_Error | int 0 on success , WP_Error on failure .
*/
2008-01-09 04:37:27 -05:00
function validate_plugin ( $plugin ) {
if ( validate_file ( $plugin ) )
2008-07-29 20:02:47 -04:00
return new WP_Error ( 'plugin_invalid' , __ ( 'Invalid plugin path.' ));
2008-05-27 13:55:24 -04:00
if ( ! file_exists ( WP_PLUGIN_DIR . '/' . $plugin ) )
2008-01-09 04:37:27 -05:00
return new WP_Error ( 'plugin_not_found' , __ ( 'Plugin file does not exist.' ));
2009-02-19 13:39:04 -05:00
$installed_plugins = get_plugins ();
if ( ! isset ( $installed_plugins [ $plugin ]) )
return new WP_Error ( 'no_plugin_header' , __ ( 'The plugin does not have a valid header.' ));
2008-01-09 04:37:27 -05:00
return 0 ;
2007-10-17 13:14:58 -04:00
}
2008-08-07 19:39:27 -04:00
/**
* Whether the plugin can be uninstalled .
*
2008-09-16 20:40:10 -04:00
* @ since 2.7 . 0
2008-08-07 19:39:27 -04:00
*
* @ param string $plugin Plugin path to check .
* @ return bool Whether plugin can be uninstalled .
*/
function is_uninstallable_plugin ( $plugin ) {
$file = plugin_basename ( $plugin );
$uninstallable_plugins = ( array ) get_option ( 'uninstall_plugins' );
if ( isset ( $uninstallable_plugins [ $file ] ) || file_exists ( WP_PLUGIN_DIR . '/' . dirname ( $file ) . '/uninstall.php' ) )
return true ;
return false ;
}
/**
* Uninstall a single plugin .
*
* Calls the uninstall hook , if it is available .
*
2008-09-16 20:40:10 -04:00
* @ since 2.7 . 0
2008-08-08 00:15:03 -04:00
*
2008-08-07 19:39:27 -04:00
* @ param string $plugin Relative plugin path from Plugin Directory .
*/
function uninstall_plugin ( $plugin ) {
$file = plugin_basename ( $plugin );
$uninstallable_plugins = ( array ) get_option ( 'uninstall_plugins' );
if ( file_exists ( WP_PLUGIN_DIR . '/' . dirname ( $file ) . '/uninstall.php' ) ) {
if ( isset ( $uninstallable_plugins [ $file ] ) ) {
unset ( $uninstallable_plugins [ $file ]);
update_option ( 'uninstall_plugins' , $uninstallable_plugins );
}
unset ( $uninstallable_plugins );
define ( 'WP_UNINSTALL_PLUGIN' , $file );
2014-02-10 18:00:15 -05:00
wp_register_plugin_realpath ( WP_PLUGIN_DIR . '/' . dirname ( $file ) );
2008-08-07 19:39:27 -04:00
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 );
2014-02-10 18:00:15 -05:00
wp_register_plugin_realpath ( WP_PLUGIN_DIR . '/' . $file );
2008-08-07 19:39:27 -04:00
include WP_PLUGIN_DIR . '/' . $file ;
add_action ( 'uninstall_' . $file , $callable );
2013-09-18 03:38:12 -04:00
/**
* Fires in uninstall_plugin () once the plugin has been uninstalled .
2013-10-24 22:29:52 -04:00
*
2013-09-18 03:38:12 -04:00
* The action concatenates the 'uninstall_' prefix with the basename of the
2013-09-18 15:36:09 -04:00
* plugin passed to { @ see uninstall_plugin ()} to create a dynamically - named action .
2013-09-18 03:38:12 -04:00
*
2013-09-18 07:58:10 -04:00
* @ since 2.7 . 0
2013-09-18 03:38:12 -04:00
*/
2008-08-07 19:39:27 -04:00
do_action ( 'uninstall_' . $file );
}
}
2007-05-25 03:16:21 -04:00
//
// Menu
//
2010-01-31 12:36:00 -05:00
/**
* Add a top level menu page
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* This function takes a capability which will be used to determine whether
* or not a page is included in the menu .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* The function which is hooked in to handle the output of the page must check
* that the user has the required capability as well .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2013-12-05 01:38:09 -05:00
* @ 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,' .
2013-12-31 05:33:11 -05:00
* * Pass the name of a Dashicons helper class to use a font icon , e . g . 'dashicons-chart-pie' .
2013-12-05 01:38:09 -05:00
* * Pass 'none' to leave div . wp - menu - image empty so an icon can be added via CSS .
2010-01-31 12:36:00 -05:00
* @ param int $position The position in the menu order this one should appear
2010-12-09 01:54:48 -05:00
*
* @ return string The resulting page ' s hook_suffix
2010-01-31 12:36:00 -05:00
*/
2012-01-05 15:50:54 -05:00
function add_menu_page ( $page_title , $menu_title , $capability , $menu_slug , $function = '' , $icon_url = '' , $position = null ) {
2010-06-10 17:38:41 -04:00
global $menu , $admin_page_hooks , $_registered_pages , $_parent_pages ;
2007-05-25 03:16:21 -04:00
2010-01-31 12:36:00 -05:00
$menu_slug = plugin_basename ( $menu_slug );
2007-05-25 03:16:21 -04:00
2010-01-31 12:36:00 -05:00
$admin_page_hooks [ $menu_slug ] = sanitize_title ( $menu_title );
2007-05-25 03:16:21 -04:00
2010-01-31 12:36:00 -05:00
$hookname = get_plugin_page_hookname ( $menu_slug , '' );
2010-03-03 19:15:55 -05:00
2010-04-17 23:38:47 -04:00
if ( ! empty ( $function ) && ! empty ( $hookname ) && current_user_can ( $capability ) )
2007-05-25 03:16:21 -04:00
add_action ( $hookname , $function );
2012-11-05 19:25:18 -05:00
if ( empty ( $icon_url ) ) {
2014-03-09 07:13:13 -04:00
$icon_url = 'dashicons-admin-generic' ;
2012-11-05 19:25:18 -05:00
$icon_class = 'menu-icon-generic ' ;
} else {
2012-08-30 09:33:00 -04:00
$icon_url = set_url_scheme ( $icon_url );
2012-11-05 19:25:18 -05:00
$icon_class = '' ;
}
2008-12-09 13:03:31 -05:00
2012-11-05 19:25:18 -05:00
$new_menu = array ( $menu_title , $capability , $menu_slug , $page_title , 'menu-top ' . $icon_class . $hookname , $hookname , $icon_url );
2008-10-14 18:44:56 -04:00
2011-12-14 12:36:38 -05:00
if ( null === $position )
2009-08-20 17:00:52 -04:00
$menu [] = $new_menu ;
2010-04-17 23:38:47 -04:00
else
2009-08-20 17:00:52 -04:00
$menu [ $position ] = $new_menu ;
2009-09-14 10:03:32 -04:00
2009-06-19 02:08:03 -04:00
$_registered_pages [ $hookname ] = true ;
2010-06-10 17:38:41 -04:00
// No parent as top level
$_parent_pages [ $menu_slug ] = false ;
2010-06-11 16:19:35 -04:00
2007-05-25 03:16:21 -04:00
return $hookname ;
}
2010-01-31 12:36:00 -05:00
/**
* Add a top level menu page in the 'objects' section
2010-02-02 16:41:17 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
*
2010-01-31 12:36:00 -05:00
* @ 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
2010-12-09 01:54:48 -05:00
*
* @ return string The resulting page ' s hook_suffix
2010-01-31 12:36:00 -05:00
*/
function add_object_page ( $page_title , $menu_title , $capability , $menu_slug , $function = '' , $icon_url = '' ) {
2009-08-20 17:00:52 -04:00
global $_wp_last_object_menu ;
2009-09-14 10:03:32 -04:00
2008-11-05 17:46:58 -05:00
$_wp_last_object_menu ++ ;
2009-09-14 10:03:32 -04:00
2010-01-31 12:36:00 -05:00
return add_menu_page ( $page_title , $menu_title , $capability , $menu_slug , $function , $icon_url , $_wp_last_object_menu );
2008-11-28 14:34:49 -05:00
}
2010-01-31 12:36:00 -05:00
/**
* Add a top level menu page in the 'utility' section
2010-02-02 16:41:17 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
*
2010-01-31 12:36:00 -05:00
* @ 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
2010-12-09 01:54:48 -05:00
*
* @ return string The resulting page ' s hook_suffix
2010-01-31 12:36:00 -05:00
*/
function add_utility_page ( $page_title , $menu_title , $capability , $menu_slug , $function = '' , $icon_url = '' ) {
2009-08-20 17:00:52 -04:00
global $_wp_last_utility_menu ;
2009-09-14 10:03:32 -04:00
2008-11-28 14:34:49 -05:00
$_wp_last_utility_menu ++ ;
2009-09-14 10:03:32 -04:00
2010-01-31 12:36:00 -05:00
return add_menu_page ( $page_title , $menu_title , $capability , $menu_slug , $function , $icon_url , $_wp_last_utility_menu );
2008-11-05 17:46:58 -05:00
}
2010-01-31 12:36:00 -05:00
/**
* Add a sub menu page
2010-02-02 16:41:17 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
function add_submenu_page ( $parent_slug , $page_title , $menu_title , $capability , $menu_slug , $function = '' ) {
2007-05-25 03:16:21 -04:00
global $submenu ;
global $menu ;
global $_wp_real_parent_file ;
global $_wp_submenu_nopriv ;
2009-06-19 02:08:03 -04:00
global $_registered_pages ;
2010-06-10 17:38:41 -04:00
global $_parent_pages ;
2007-05-25 03:16:21 -04:00
2010-01-31 12:36:00 -05:00
$menu_slug = plugin_basename ( $menu_slug );
$parent_slug = plugin_basename ( $parent_slug );
2007-05-25 03:16:21 -04:00
2010-01-31 12:36:00 -05:00
if ( isset ( $_wp_real_parent_file [ $parent_slug ] ) )
$parent_slug = $_wp_real_parent_file [ $parent_slug ];
2007-05-25 03:16:21 -04:00
2010-01-31 12:36:00 -05:00
if ( ! current_user_can ( $capability ) ) {
$_wp_submenu_nopriv [ $parent_slug ][ $menu_slug ] = true ;
2007-05-25 03:16:21 -04:00
return false ;
}
// If the parent doesn't already have a submenu, add a link to the parent
2011-12-13 18:45:31 -05:00
// 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
2007-05-25 03:16:21 -04:00
// this case, don't automatically add a link back to avoid duplication.
2011-12-14 12:36:38 -05:00
if ( ! isset ( $submenu [ $parent_slug ] ) && $menu_slug != $parent_slug ) {
2009-01-03 23:29:28 -05:00
foreach ( ( array ) $menu as $parent_menu ) {
2010-01-31 12:36:00 -05:00
if ( $parent_menu [ 2 ] == $parent_slug && current_user_can ( $parent_menu [ 1 ] ) )
$submenu [ $parent_slug ][] = $parent_menu ;
2007-05-25 03:16:21 -04:00
}
}
2010-01-31 12:36:00 -05:00
$submenu [ $parent_slug ][] = array ( $menu_title , $capability , $menu_slug , $page_title );
2007-05-25 03:16:21 -04:00
2010-01-31 12:36:00 -05:00
$hookname = get_plugin_page_hookname ( $menu_slug , $parent_slug );
2007-05-25 03:16:21 -04:00
if ( ! empty ( $function ) && ! empty ( $hookname ))
add_action ( $hookname , $function );
2009-06-19 02:08:03 -04:00
$_registered_pages [ $hookname ] = true ;
2011-12-13 18:45:31 -05:00
// backwards-compatibility for plugins using add_management page. See wp-admin/admin.php for redirect from edit.php to tools.php
2010-01-31 12:36:00 -05:00
if ( 'tools.php' == $parent_slug )
$_registered_pages [ get_plugin_page_hookname ( $menu_slug , 'edit.php' )] = true ;
2009-06-19 02:08:03 -04:00
2010-06-10 17:38:41 -04:00
// No parent as top level
$_parent_pages [ $menu_slug ] = $parent_slug ;
2010-06-11 16:19:35 -04:00
2007-05-25 03:16:21 -04:00
return $hookname ;
}
2008-09-16 20:40:10 -04:00
/**
2008-11-14 15:53:43 -05:00
* Add sub menu page to the tools main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2008-09-16 20:40:10 -04:00
*/
2010-01-31 12:36:00 -05:00
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 );
2007-05-25 03:16:21 -04:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the options main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
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 );
2007-05-25 03:16:21 -04:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the themes main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
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 );
2007-05-25 03:16:21 -04:00
}
2010-02-12 23:04:01 -05:00
/**
* Add sub menu page to the plugins main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-12 23:04:01 -05:00
*
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-02-12 23:04:01 -05:00
*/
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 );
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the Users / Profile main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
function add_users_page ( $page_title , $menu_title , $capability , $menu_slug , $function = '' ) {
2007-05-25 03:16:21 -04:00
if ( current_user_can ( 'edit_users' ) )
$parent = 'users.php' ;
else
$parent = 'profile.php' ;
2010-01-31 12:36:00 -05:00
return add_submenu_page ( $parent , $page_title , $menu_title , $capability , $menu_slug , $function );
2007-05-25 03:16:21 -04:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the Dashboard main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
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 );
2008-11-18 14:30:50 -05:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the posts main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
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 );
2008-11-14 15:53:43 -05:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the media main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
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 );
2008-11-14 15:53:43 -05:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the links main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-01-31 12:36:00 -05:00
*/
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 );
2008-11-14 15:53:43 -05:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the pages main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-12-09 01:54:48 -05:00
*/
2010-01-31 12:36:00 -05:00
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 );
2008-11-14 15:53:43 -05:00
}
2010-01-31 12:36:00 -05:00
/**
* Add sub menu page to the comments main menu .
2010-12-08 23:02:37 -05:00
*
2010-10-07 18:58:45 -04:00
* 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 .
2010-02-02 16:41:17 -05:00
*
2010-01-31 12:36:00 -05:00
* @ 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 .
2010-12-09 01:54:48 -05:00
*
2011-06-03 19:30:46 -04:00
* @ return string | bool The resulting page ' s hook_suffix , or false if the user does not have the capability required .
2010-12-09 01:54:48 -05:00
*/
2010-01-31 12:36:00 -05:00
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 );
2008-11-14 15:53:43 -05:00
}
2010-10-07 18:35:31 -04:00
/**
* Remove a top level admin menu
*
* @ since 3.1 . 0
*
* @ param string $menu_slug The slug of the menu
* @ return array | bool The removed menu on success , False if not found
*/
function remove_menu_page ( $menu_slug ) {
global $menu ;
foreach ( $menu as $i => $item ) {
if ( $menu_slug == $item [ 2 ] ) {
unset ( $menu [ $i ] );
return $item ;
}
}
return false ;
}
/**
* Remove an admin submenu
*
* @ since 3.1 . 0
*
* @ param string $menu_slug The slug for the parent menu
* @ param string $submenu_slug The slug of the submenu
* @ return array | bool The removed submenu on success , False if not found
*/
function remove_submenu_page ( $menu_slug , $submenu_slug ) {
global $submenu ;
if ( ! isset ( $submenu [ $menu_slug ] ) )
return false ;
foreach ( $submenu [ $menu_slug ] as $i => $item ) {
if ( $submenu_slug == $item [ 2 ] ) {
unset ( $submenu [ $menu_slug ][ $i ] );
return $item ;
}
}
return false ;
}
2010-06-10 17:38:41 -04:00
/**
* Get the url to access a particular menu page based on the slug it was registered with .
2010-06-11 16:19:35 -04:00
*
2010-06-10 17:38:41 -04:00
* If the slug hasn ' t been registered properly no url will be returned
2010-06-11 16:19:35 -04:00
*
2013-12-24 13:57:12 -05:00
* @ since 3.0 . 0
2010-06-11 16:19:35 -04:00
*
2010-06-10 17:38:41 -04:00
* @ param string $menu_slug The slug name to refer to this menu by ( should be unique for this menu )
* @ param bool $echo Whether or not to echo the url - default is true
* @ return string the url
*/
function menu_page_url ( $menu_slug , $echo = true ) {
global $_parent_pages ;
2010-06-11 16:19:35 -04:00
2010-06-10 17:38:41 -04:00
if ( isset ( $_parent_pages [ $menu_slug ] ) ) {
2010-12-08 23:02:37 -05:00
$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 ) );
2010-06-10 17:38:41 -04:00
} else {
2010-12-08 23:02:37 -05:00
$url = admin_url ( 'admin.php?page=' . $menu_slug );
2010-06-10 17:38:41 -04:00
}
} else {
$url = '' ;
}
2010-06-11 16:19:35 -04:00
2010-06-10 17:38:41 -04:00
$url = esc_url ( $url );
2010-06-11 16:19:35 -04:00
2010-06-10 17:38:41 -04:00
if ( $echo )
echo $url ;
2010-06-11 16:19:35 -04:00
2010-06-10 17:38:41 -04:00
return $url ;
}
2007-05-25 03:16:21 -04:00
//
// Pluggable Menu Support -- Private
//
2008-08-25 20:54:21 -04:00
function get_admin_page_parent ( $parent = '' ) {
2007-05-25 03:16:21 -04:00
global $parent_file ;
global $menu ;
global $submenu ;
global $pagenow ;
2010-03-03 19:15:55 -05:00
global $typenow ;
2007-05-25 03:16:21 -04:00
global $plugin_page ;
global $_wp_real_parent_file ;
global $_wp_menu_nopriv ;
global $_wp_submenu_nopriv ;
2008-08-26 00:27:00 -04:00
if ( ! empty ( $parent ) && 'admin.php' != $parent ) {
2008-08-25 20:54:21 -04:00
if ( isset ( $_wp_real_parent_file [ $parent ] ) )
$parent = $_wp_real_parent_file [ $parent ];
return $parent ;
}
2010-01-04 11:58:43 -05:00
2007-05-25 03:16:21 -04:00
if ( $pagenow == 'admin.php' && isset ( $plugin_page ) ) {
2009-01-03 23:29:28 -05:00
foreach ( ( array ) $menu as $parent_menu ) {
2007-05-25 03:16:21 -04:00
if ( $parent_menu [ 2 ] == $plugin_page ) {
$parent_file = $plugin_page ;
if ( isset ( $_wp_real_parent_file [ $parent_file ] ) )
$parent_file = $_wp_real_parent_file [ $parent_file ];
return $parent_file ;
}
}
if ( isset ( $_wp_menu_nopriv [ $plugin_page ] ) ) {
$parent_file = $plugin_page ;
if ( isset ( $_wp_real_parent_file [ $parent_file ] ) )
$parent_file = $_wp_real_parent_file [ $parent_file ];
return $parent_file ;
}
}
if ( isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $pagenow ][ $plugin_page ] ) ) {
$parent_file = $pagenow ;
if ( isset ( $_wp_real_parent_file [ $parent_file ] ) )
$parent_file = $_wp_real_parent_file [ $parent_file ];
return $parent_file ;
}
2009-01-03 23:29:28 -05:00
foreach ( array_keys ( ( array ) $submenu ) as $parent ) {
2007-05-25 03:16:21 -04:00
foreach ( $submenu [ $parent ] as $submenu_array ) {
if ( isset ( $_wp_real_parent_file [ $parent ] ) )
$parent = $_wp_real_parent_file [ $parent ];
2010-03-03 19:15:55 -05:00
if ( ! empty ( $typenow ) && ( $submenu_array [ 2 ] == " $pagenow ?post_type= $typenow " ) ) {
$parent_file = $parent ;
return $parent ;
} elseif ( $submenu_array [ 2 ] == $pagenow && empty ( $typenow ) && ( empty ( $parent_file ) || false === strpos ( $parent_file , '?' ) ) ) {
2007-05-25 03:16:21 -04:00
$parent_file = $parent ;
return $parent ;
} else
if ( isset ( $plugin_page ) && ( $plugin_page == $submenu_array [ 2 ] ) ) {
$parent_file = $parent ;
return $parent ;
}
}
}
2008-11-28 20:56:09 -05:00
if ( empty ( $parent_file ) )
$parent_file = '' ;
2007-05-25 03:16:21 -04:00
return '' ;
}
function get_admin_page_title () {
global $title ;
global $menu ;
global $submenu ;
global $pagenow ;
global $plugin_page ;
2010-04-17 22:56:00 -04:00
global $typenow ;
2007-05-25 03:16:21 -04:00
2010-03-19 17:29:21 -04:00
if ( ! empty ( $title ) )
2007-05-25 03:16:21 -04:00
return $title ;
$hook = get_plugin_page_hook ( $plugin_page , $pagenow );
$parent = $parent1 = get_admin_page_parent ();
2008-10-14 18:44:56 -04:00
2007-05-25 03:16:21 -04:00
if ( empty ( $parent ) ) {
2009-01-03 23:29:28 -05:00
foreach ( ( array ) $menu as $menu_array ) {
2007-05-25 03:16:21 -04:00
if ( isset ( $menu_array [ 3 ] ) ) {
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 ];
}
} else {
$title = $menu_array [ 0 ];
return $title ;
}
}
} else {
2010-04-17 22:56:00 -04:00
foreach ( array_keys ( $submenu ) as $parent ) {
2007-05-25 03:16:21 -04:00
foreach ( $submenu [ $parent ] as $submenu_array ) {
2007-09-03 19:32:58 -04:00
if ( isset ( $plugin_page ) &&
2010-04-17 22:56:00 -04:00
( $plugin_page == $submenu_array [ 2 ] ) &&
(
( $parent == $pagenow ) ||
( $parent == $plugin_page ) ||
( $plugin_page == $hook ) ||
( $pagenow == 'admin.php' && $parent1 != $submenu_array [ 2 ] ) ||
( ! empty ( $typenow ) && $parent == $pagenow . '?post_type=' . $typenow )
)
2007-05-25 03:16:21 -04:00
) {
$title = $submenu_array [ 3 ];
return $submenu_array [ 3 ];
}
if ( $submenu_array [ 2 ] != $pagenow || isset ( $_GET [ 'page' ] ) ) // not the current page
continue ;
if ( isset ( $submenu_array [ 3 ] ) ) {
$title = $submenu_array [ 3 ];
return $submenu_array [ 3 ];
} else {
$title = $submenu_array [ 0 ];
return $title ;
}
}
}
2010-03-19 17:29:21 -04:00
if ( empty ( $title ) ) {
2009-04-16 19:42:42 -04:00
foreach ( $menu as $menu_array ) {
if ( isset ( $plugin_page ) &&
2010-04-17 22:56:00 -04:00
( $plugin_page == $menu_array [ 2 ] ) &&
( $pagenow == 'admin.php' ) &&
( $parent1 == $menu_array [ 2 ] ) )
2009-04-16 19:42:42 -04:00
{
$title = $menu_array [ 3 ];
return $menu_array [ 3 ];
}
}
}
2007-05-25 03:16:21 -04:00
}
return $title ;
}
function get_plugin_page_hook ( $plugin_page , $parent_page ) {
$hook = get_plugin_page_hookname ( $plugin_page , $parent_page );
2007-11-06 23:30:11 -05:00
if ( has_action ( $hook ) )
2007-05-25 03:16:21 -04:00
return $hook ;
else
2007-07-15 13:59:05 -04:00
return null ;
2007-05-25 03:16:21 -04:00
}
function get_plugin_page_hookname ( $plugin_page , $parent_page ) {
global $admin_page_hooks ;
2008-08-25 20:54:21 -04:00
$parent = get_admin_page_parent ( $parent_page );
2007-05-25 03:16:21 -04:00
2008-07-07 10:21:47 -04:00
$page_type = 'admin' ;
2008-10-14 18:44:56 -04:00
if ( empty ( $parent_page ) || 'admin.php' == $parent_page || isset ( $admin_page_hooks [ $plugin_page ] ) ) {
if ( isset ( $admin_page_hooks [ $plugin_page ] ) )
2007-05-25 03:16:21 -04:00
$page_type = 'toplevel' ;
else
if ( isset ( $admin_page_hooks [ $parent ] ))
$page_type = $admin_page_hooks [ $parent ];
2008-08-22 00:32:42 -04:00
} else if ( isset ( $admin_page_hooks [ $parent ] ) ) {
$page_type = $admin_page_hooks [ $parent ];
2008-07-07 10:21:47 -04:00
}
2007-05-25 03:16:21 -04:00
$plugin_name = preg_replace ( '!\.php!' , '' , $plugin_page );
2010-04-17 22:56:00 -04:00
return $page_type . '_page_' . $plugin_name ;
2007-05-25 03:16:21 -04:00
}
function user_can_access_admin_page () {
global $pagenow ;
global $menu ;
global $submenu ;
global $_wp_menu_nopriv ;
global $_wp_submenu_nopriv ;
global $plugin_page ;
2009-06-19 02:08:03 -04:00
global $_registered_pages ;
2007-05-25 03:16:21 -04:00
$parent = get_admin_page_parent ();
2008-12-30 14:18:18 -05:00
if ( ! isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $parent ][ $pagenow ] ) )
2007-05-25 03:16:21 -04:00
return false ;
2009-06-19 02:08:03 -04:00
if ( isset ( $plugin_page ) ) {
if ( isset ( $_wp_submenu_nopriv [ $parent ][ $plugin_page ] ) )
return false ;
$hookname = get_plugin_page_hookname ( $plugin_page , $parent );
2010-03-03 19:15:55 -05:00
2009-06-19 02:08:03 -04:00
if ( ! isset ( $_registered_pages [ $hookname ]) )
return false ;
}
2007-05-25 03:16:21 -04:00
if ( empty ( $parent ) ) {
if ( isset ( $_wp_menu_nopriv [ $pagenow ] ) )
return false ;
if ( isset ( $_wp_submenu_nopriv [ $pagenow ][ $pagenow ] ) )
return false ;
if ( isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $pagenow ][ $plugin_page ] ) )
return false ;
2009-06-17 15:50:38 -04:00
if ( isset ( $plugin_page ) && isset ( $_wp_menu_nopriv [ $plugin_page ] ) )
return false ;
2007-05-25 03:16:21 -04:00
foreach ( array_keys ( $_wp_submenu_nopriv ) as $key ) {
if ( isset ( $_wp_submenu_nopriv [ $key ][ $pagenow ] ) )
return false ;
if ( isset ( $plugin_page ) && isset ( $_wp_submenu_nopriv [ $key ][ $plugin_page ] ) )
return false ;
}
return true ;
}
2009-06-14 20:22:53 -04:00
if ( isset ( $plugin_page ) && ( $plugin_page == $parent ) && isset ( $_wp_menu_nopriv [ $plugin_page ] ) )
return false ;
2007-05-25 03:16:21 -04:00
if ( isset ( $submenu [ $parent ] ) ) {
foreach ( $submenu [ $parent ] as $submenu_array ) {
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 ) {
if ( current_user_can ( $submenu_array [ 1 ] ))
return true ;
else
return false ;
}
}
}
foreach ( $menu as $menu_array ) {
if ( $menu_array [ 2 ] == $parent ) {
if ( current_user_can ( $menu_array [ 1 ] ))
return true ;
else
return false ;
}
}
return true ;
}
2008-10-19 19:35:09 -04:00
/* Whitelist functions */
/**
* Register a setting and its sanitization callback
*
* @ since 2.7 . 0
*
2011-12-13 18:45:31 -05:00
* @ param string $option_group A settings group name . Should correspond to a whitelisted option key name .
2009-10-15 16:26:21 -04:00
* Default whitelisted option key names include " general, " " discussion, " and " reading, " among others .
2008-10-19 19:35:09 -04:00
* @ 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
*/
2010-03-22 19:03:31 -04:00
function register_setting ( $option_group , $option_name , $sanitize_callback = '' ) {
2008-10-19 19:35:09 -04:00
global $new_whitelist_options ;
2010-03-18 03:50:43 -04:00
2010-03-22 19:03:31 -04:00
if ( 'misc' == $option_group ) {
2012-09-13 13:28:57 -04:00
_deprecated_argument ( __FUNCTION__ , '3.0' , sprintf ( __ ( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
2010-03-18 03:50:43 -04:00
$option_group = 'general' ;
2010-03-22 19:03:31 -04:00
}
2010-03-18 03:50:43 -04:00
2012-09-13 13:28:57 -04:00
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' ;
}
2008-10-19 19:35:09 -04:00
$new_whitelist_options [ $option_group ][] = $option_name ;
if ( $sanitize_callback != '' )
2011-10-12 12:35:33 -04:00
add_filter ( " sanitize_option_ { $option_name } " , $sanitize_callback );
2008-10-19 19:35:09 -04:00
}
/**
2010-03-22 19:03:31 -04:00
* Unregister a setting
2008-10-19 19:35:09 -04:00
*
2010-03-22 19:03:31 -04:00
* @ since 2.7 . 0
2008-10-19 19:35:09 -04:00
*
* @ param unknown_type $option_group
* @ param unknown_type $option_name
* @ param unknown_type $sanitize_callback
2010-03-22 19:03:31 -04:00
* @ return unknown
2008-10-19 19:35:09 -04:00
*/
2010-03-22 19:03:31 -04:00
function unregister_setting ( $option_group , $option_name , $sanitize_callback = '' ) {
2008-10-19 19:35:09 -04:00
global $new_whitelist_options ;
2010-03-18 03:50:43 -04:00
2010-03-22 19:03:31 -04:00
if ( 'misc' == $option_group ) {
2012-09-13 13:28:57 -04:00
_deprecated_argument ( __FUNCTION__ , '3.0' , sprintf ( __ ( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
2010-03-18 03:50:43 -04:00
$option_group = 'general' ;
2010-03-22 19:03:31 -04:00
}
2010-03-18 03:50:43 -04:00
2012-09-13 13:28:57 -04:00
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' ;
}
2009-04-20 16:37:23 -04:00
$pos = array_search ( $option_name , ( array ) $new_whitelist_options );
2008-10-19 19:35:09 -04:00
if ( $pos !== false )
unset ( $new_whitelist_options [ $option_group ][ $pos ] );
if ( $sanitize_callback != '' )
remove_filter ( " sanitize_option_ { $option_name } " , $sanitize_callback );
}
/**
* { @ internal Missing Short Description }}
*
2010-12-01 14:24:38 -05:00
* @ since 2.7 . 0
2008-10-19 19:35:09 -04:00
*
* @ param unknown_type $options
* @ return unknown
*/
function option_update_filter ( $options ) {
global $new_whitelist_options ;
if ( is_array ( $new_whitelist_options ) )
$options = add_option_whitelist ( $new_whitelist_options , $options );
return $options ;
}
add_filter ( 'whitelist_options' , 'option_update_filter' );
/**
* { @ internal Missing Short Description }}
*
2010-12-01 14:24:38 -05:00
* @ since 2.7 . 0
2008-10-19 19:35:09 -04:00
*
* @ param unknown_type $new_options
* @ param unknown_type $options
* @ return unknown
*/
function add_option_whitelist ( $new_options , $options = '' ) {
2010-01-25 16:33:49 -05:00
if ( $options == '' )
2008-10-19 19:35:09 -04:00
global $whitelist_options ;
2010-01-25 16:33:49 -05:00
else
2008-10-19 19:35:09 -04:00
$whitelist_options = $options ;
2010-01-25 16:33:49 -05:00
foreach ( $new_options as $page => $keys ) {
foreach ( $keys as $key ) {
2008-12-04 18:20:41 -05:00
if ( ! isset ( $whitelist_options [ $page ]) || ! is_array ( $whitelist_options [ $page ]) ) {
$whitelist_options [ $page ] = array ();
2008-10-19 19:35:09 -04:00
$whitelist_options [ $page ][] = $key ;
2008-12-04 18:20:41 -05:00
} else {
$pos = array_search ( $key , $whitelist_options [ $page ] );
if ( $pos === false )
$whitelist_options [ $page ][] = $key ;
}
2008-10-19 19:35:09 -04:00
}
}
2010-01-25 16:33:49 -05:00
2008-10-19 19:35:09 -04:00
return $whitelist_options ;
}
/**
* { @ internal Missing Short Description }}
*
2010-12-01 14:24:38 -05:00
* @ since 2.7 . 0
2008-10-19 19:35:09 -04:00
*
* @ param unknown_type $del_options
* @ param unknown_type $options
* @ return unknown
*/
function remove_option_whitelist ( $del_options , $options = '' ) {
2010-01-25 16:33:49 -05:00
if ( $options == '' )
2008-10-19 19:35:09 -04:00
global $whitelist_options ;
2010-01-25 16:33:49 -05:00
else
2008-10-19 19:35:09 -04:00
$whitelist_options = $options ;
2010-01-25 16:33:49 -05:00
foreach ( $del_options as $page => $keys ) {
foreach ( $keys as $key ) {
2008-12-18 17:26:03 -05:00
if ( isset ( $whitelist_options [ $page ]) && is_array ( $whitelist_options [ $page ]) ) {
$pos = array_search ( $key , $whitelist_options [ $page ] );
2010-01-18 15:34:48 -05:00
if ( $pos !== false )
2008-12-18 17:26:03 -05:00
unset ( $whitelist_options [ $page ][ $pos ] );
}
2008-10-19 19:35:09 -04:00
}
}
2010-01-25 16:33:49 -05:00
2008-10-19 19:35:09 -04:00
return $whitelist_options ;
}
/**
* Output nonce , action , and option_page fields for a settings page .
*
* @ since 2.7 . 0
*
2011-12-13 18:45:31 -05:00
* @ param string $option_group A settings group name . This should match the group name used in register_setting () .
2008-10-19 19:35:09 -04:00
*/
function settings_fields ( $option_group ) {
2009-05-05 15:43:53 -04:00
echo " <input type='hidden' name='option_page' value=' " . esc_attr ( $option_group ) . " ' /> " ;
2008-10-19 19:35:09 -04:00
echo '<input type="hidden" name="action" value="update" />' ;
wp_nonce_field ( " $option_group -options " );
}
2013-09-05 21:33:09 -04:00
/**
* 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' );
}