wp-admin/includes/plugin.php

   1 <?php
   2 /**
   3  * WordPress Plugin Administration API
   4  *
   5  * @package WordPress
   6  * @subpackage Administration
   7  */
   8
   9 /**
  10  * Parse the plugin contents to retrieve plugin's metadata.
  11  *
  12  * The metadata of the plugin's data searches for the following in the plugin's
  13  * header. All plugin data must be on its own line. For plugin description, it
  14  * must not have any newlines or only parts of the description will be displayed
  15  * and the same goes for the plugin data. The below is formatted for printing.
  16  *
  17  * <code>
  18  * /*
  19  * Plugin Name: Name of Plugin
  20  * Plugin URI: Link to plugin information
  21  * Description: Plugin Description
  22  * Author: Plugin author's name
  23  * Author URI: Link to the author's web site
  24  * Version: Must be set in the plugin for WordPress 2.3+
  25  * Text Domain: Optional. Unique identifier, should be same as the one used in
  26  *              plugin_text_domain()
  27  * Domain Path: Optional. Only useful if the translations are located in a
  28  *              folder above the plugin's base path. For example, if .mo files are
  29  *              located in the locale folder then Domain Path will be "/locale/" and
  30  *              must have the first slash. Defaults to the base folder the plugin is
  31  *              located in.
  32  * Network: Optional. Specify "Network: true" to require that a plugin is activated
  33  *              across all sites in an installation. This will prevent a plugin from being
  34  *              activated on a single site when Multisite is enabled.
  35  *  * / # Remove the space to close comment
  36  * </code>
  37  *
  38  * Plugin data returned array contains the following:
  39  *              'Name' - Name of the plugin, must be unique.
  40  *              'Title' - Title of the plugin and the link to the plugin's web site.
  41  *              'Description' - Description of what the plugin does and/or notes
  42  *              from the author.
  43  *              'Author' - The author's name
  44  *              'AuthorURI' - The authors web site address.
  45  *              'Version' - The plugin version number.
  46  *              'PluginURI' - Plugin web site address.
  47  *              'TextDomain' - Plugin's text domain for localization.
  48  *              'DomainPath' - Plugin's relative directory path to .mo files.
  49  *              'Network' - Boolean. Whether the plugin can only be activated network wide.
  50  *
  51  * Some users have issues with opening large files and manipulating the contents
  52  * for want is usually the first 1kiB or 2kiB. This function stops pulling in
  53  * the plugin contents when it has all of the required plugin data.
  54  *
  55  * The first 8kiB of the file will be pulled in and if the plugin data is not
  56  * within that first 8kiB, then the plugin author should correct their plugin
  57  * and move the plugin data headers to the top.
  58  *
  59  * The plugin file is assumed to have permissions to allow for scripts to read
  60  * the file. This is not checked however and the file is only opened for
  61  * reading.
  62  *
  63  * @link http://trac.wordpress.org/ticket/5651 Previous Optimizations.
  64  * @link http://trac.wordpress.org/ticket/7372 Further and better Optimizations.
  65  * @since 1.5.0
  66  *
  67  * @param string $plugin_file Path to the plugin file
  68  * @param bool $markup Optional. If the returned data should have HTML markup applied. Defaults to true.
  69  * @param bool $translate Optional. If the returned data should be translated. Defaults to true.
  70  * @return array See above for description.
  71  */
  72 function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
  73
  74         $default_headers = array(
  75                 'Name' => 'Plugin Name',
  76                 'PluginURI' => 'Plugin URI',
  77                 'Version' => 'Version',
  78                 'Description' => 'Description',
  79                 'Author' => 'Author',
  80                 'AuthorURI' => 'Author URI',
  81                 'TextDomain' => 'Text Domain',
  82                 'DomainPath' => 'Domain Path',
  83                 'Network' => 'Network',
  84                 // Site Wide Only is deprecated in favor of Network.
  85                 '_sitewide' => 'Site Wide Only',
  86         );
  87
  88         $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
  89
  90         // Site Wide Only is the old header for Network
  91         if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
  92                 _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' ) );
  93                 $plugin_data['Network'] = $plugin_data['_sitewide'];
  94         }
  95         $plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
  96         unset( $plugin_data['_sitewide'] );
  97
  98         if ( $markup || $translate ) {
  99                 $plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
 100         } else {
 101                 $plugin_data['Title']      = $plugin_data['Name'];
 102                 $plugin_data['AuthorName'] = $plugin_data['Author'];
 103         }
 104
 105         return $plugin_data;
 106 }
 107
 108 /**
 109  * Sanitizes plugin data, optionally adds markup, optionally translates.
 110  *
 111  * @since 2.7.0
 112  * @access private
 113  * @see get_plugin_data()
 114  */
 115 function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
 116
 117         // Translate fields
 118         if ( $translate ) {
 119                 if ( $textdomain = $plugin_data['TextDomain'] ) {
 120                         if ( $plugin_data['DomainPath'] )
 121                                 load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] );
 122                         else
 123                                 load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) );
 124                 } elseif ( in_array( basename( $plugin_file ), array( 'hello.php', 'akismet.php' ) ) ) {
 125                         $textdomain = 'default';
 126                 }
 127                 if ( $textdomain ) {
 128                         foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field )
 129                                 $plugin_data[ $field ] = translate( $plugin_data[ $field ], $textdomain );
 130                 }
 131         }
 132
 133         // Sanitize fields
 134         $allowed_tags = $allowed_tags_in_links = array(
 135                 'abbr'    => array( 'title' => true ),
 136                 'acronym' => array( 'title' => true ),
 137                 'code'    => true,
 138                 'em'      => true,
 139                 'strong'  => true,
 140         );
 141         $allowed_tags['a'] = array( 'href' => true, 'title' => true );
 142
 143         // Name is marked up inside <a> tags. Don't allow these.
 144         // Author is too, but some plugins have used <a> here (omitting Author URI).
 145         $plugin_data['Name']        = wp_kses( $plugin_data['Name'],        $allowed_tags_in_links );
 146         $plugin_data['Author']      = wp_kses( $plugin_data['Author'],      $allowed_tags );
 147
 148         $plugin_data['Description'] = wp_kses( $plugin_data['Description'], $allowed_tags );
 149         $plugin_data['Version']     = wp_kses( $plugin_data['Version'],     $allowed_tags );
 150
 151         $plugin_data['PluginURI']   = esc_url( $plugin_data['PluginURI'] );
 152         $plugin_data['AuthorURI']   = esc_url( $plugin_data['AuthorURI'] );
 153
 154         $plugin_data['Title']      = $plugin_data['Name'];
 155         $plugin_data['AuthorName'] = $plugin_data['Author'];
 156
 157         // Apply markup
 158         if ( $markup ) {
 159                 if ( $plugin_data['PluginURI'] && $plugin_data['Name'] )
 160                         $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin homepage' ) . '">' . $plugin_data['Name'] . '</a>';
 161
 162                 if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] )
 163                         $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '" title="' . esc_attr__( 'Visit author homepage' ) . '">' . $plugin_data['Author'] . '</a>';
 164
 165                 $plugin_data['Description'] = wptexturize( $plugin_data['Description'] );
 166
 167                 if ( $plugin_data['Author'] )
 168                         $plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s.'), $plugin_data['Author'] ) . '</cite>';
 169         }
 170
 171         return $plugin_data;
 172 }
 173
 174 /**
 175  * Get a list of a plugin's files.
 176  *
 177  * @since 2.8.0
 178  *
 179  * @param string $plugin Plugin ID
 180  * @return array List of files relative to the plugin root.
 181  */
 182 function get_plugin_files($plugin) {
 183         $plugin_file = WP_PLUGIN_DIR . '/' . $plugin;
 184         $dir = dirname($plugin_file);
 185         $plugin_files = array($plugin);
 186         if ( is_dir($dir) && $dir != WP_PLUGIN_DIR ) {
 187                 $plugins_dir = @ opendir( $dir );
 188                 if ( $plugins_dir ) {
 189                         while (($file = readdir( $plugins_dir ) ) !== false ) {
 190                                 if ( substr($file, 0, 1) == '.' )
 191                                         continue;
 192                                 if ( is_dir( $dir . '/' . $file ) ) {
 193                                         $plugins_subdir = @ opendir( $dir . '/' . $file );
 194                                         if ( $plugins_subdir ) {
 195                                                 while (($subfile = readdir( $plugins_subdir ) ) !== false ) {
 196                                                         if ( substr($subfile, 0, 1) == '.' )
 197                                                                 continue;
 198                                                         $plugin_files[] = plugin_basename("$dir/$file/$subfile");
 199                                                 }
 200                                                 @closedir( $plugins_subdir );
 201                                         }
 202                                 } else {
 203                                         if ( plugin_basename("$dir/$file") != $plugin )
 204                                                 $plugin_files[] = plugin_basename("$dir/$file");
 205                                 }
 206                         }
 207                         @closedir( $plugins_dir );
 208                 }
 209         }
 210
 211         return $plugin_files;
 212 }
 213
 214 /**
 215  * Check the plugins directory and retrieve all plugin files with plugin data.
 216  *
 217  * WordPress only supports plugin files in the base plugins directory
 218  * (wp-content/plugins) and in one directory above the plugins directory
 219  * (wp-content/plugins/my-plugin). The file it looks for has the plugin data and
 220  * must be found in those two locations. It is recommended that do keep your
 221  * plugin files in directories.
 222  *
 223  * The file with the plugin data is the file that will be included and therefore
 224  * needs to have the main execution for the plugin. This does not mean
 225  * everything must be contained in the file and it is recommended that the file
 226  * be split for maintainability. Keep everything in one file for extreme
 227  * optimization purposes.
 228  *
 229  * @since 1.5.0
 230  *
 231  * @param string $plugin_folder Optional. Relative path to single plugin folder.
 232  * @return array Key is the plugin file path and the value is an array of the plugin data.
 233  */
 234 function get_plugins($plugin_folder = '') {
 235
 236         if ( ! $cache_plugins = wp_cache_get('plugins', 'plugins') )
 237                 $cache_plugins = array();
 238
 239         if ( isset($cache_plugins[ $plugin_folder ]) )
 240                 return $cache_plugins[ $plugin_folder ];
 241
 242         $wp_plugins = array ();
 243         $plugin_root = WP_PLUGIN_DIR;
 244         if ( !empty($plugin_folder) )
 245                 $plugin_root .= $plugin_folder;
 246
 247         // Files in wp-content/plugins directory
 248         $plugins_dir = @ opendir( $plugin_root);
 249         $plugin_files = array();
 250         if ( $plugins_dir ) {
 251                 while (($file = readdir( $plugins_dir ) ) !== false ) {
 252                         if ( substr($file, 0, 1) == '.' )
 253                                 continue;
 254                         if ( is_dir( $plugin_root.'/'.$file ) ) {
 255                                 $plugins_subdir = @ opendir( $plugin_root.'/'.$file );
 256                                 if ( $plugins_subdir ) {
 257                                         while (($subfile = readdir( $plugins_subdir ) ) !== false ) {
 258                                                 if ( substr($subfile, 0, 1) == '.' )
 259                                                         continue;
 260                                                 if ( substr($subfile, -4) == '.php' )
 261                                                         $plugin_files[] = "$file/$subfile";
 262                                         }
 263                                         closedir( $plugins_subdir );
 264                                 }
 265                         } else {
 266                                 if ( substr($file, -4) == '.php' )
 267                                         $plugin_files[] = $file;
 268                         }
 269                 }
 270                 closedir( $plugins_dir );
 271         }
 272
 273         if ( empty($plugin_files) )
 274                 return $wp_plugins;
 275
 276         foreach ( $plugin_files as $plugin_file ) {
 277                 if ( !is_readable( "$plugin_root/$plugin_file" ) )
 278                         continue;
 279
 280                 $plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
 281
 282                 if ( empty ( $plugin_data['Name'] ) )
 283                         continue;
 284
 285                 $wp_plugins[plugin_basename( $plugin_file )] = $plugin_data;
 286         }
 287
 288         uasort( $wp_plugins, '_sort_uname_callback' );
 289
 290         $cache_plugins[ $plugin_folder ] = $wp_plugins;
 291         wp_cache_set('plugins', $cache_plugins, 'plugins');
 292
 293         return $wp_plugins;
 294 }
 295
 296 /**
 297  * Check the mu-plugins directory and retrieve all mu-plugin files with any plugin data.
 298  *
 299  * WordPress only includes mu-plugin files in the base mu-plugins directory (wp-content/mu-plugins).
 300  *
 301  * @since 3.0.0
 302  * @return array Key is the mu-plugin file path and the value is an array of the mu-plugin data.
 303  */
 304 function get_mu_plugins() {
 305         $wp_plugins = array();
 306         // Files in wp-content/mu-plugins directory
 307         $plugin_files = array();
 308
 309         if ( ! is_dir( WPMU_PLUGIN_DIR ) )
 310                 return $wp_plugins;
 311         if ( $plugins_dir = @ opendir( WPMU_PLUGIN_DIR ) ) {
 312                 while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
 313                         if ( substr( $file, -4 ) == '.php' )
 314                                 $plugin_files[] = $file;
 315                 }
 316         } else {
 317                 return $wp_plugins;
 318         }
 319
 320         @closedir( $plugins_dir );
 321
 322         if ( empty($plugin_files) )
 323                 return $wp_plugins;
 324
 325         foreach ( $plugin_files as $plugin_file ) {
 326                 if ( !is_readable( WPMU_PLUGIN_DIR . "/$plugin_file" ) )
 327                         continue;
 328
 329                 $plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
 330
 331                 if ( empty ( $plugin_data['Name'] ) )
 332                         $plugin_data['Name'] = $plugin_file;
 333
 334                 $wp_plugins[ $plugin_file ] = $plugin_data;
 335         }
 336
 337         if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php') <= 30 ) // silence is golden
 338                 unset( $wp_plugins['index.php'] );
 339
 340         uasort( $wp_plugins, '_sort_uname_callback' );
 341
 342         return $wp_plugins;
 343 }
 344
 345 /**
 346  * Callback to sort array by a 'Name' key.
 347  *
 348  * @since 3.1.0
 349  * @access private
 350  */
 351 function _sort_uname_callback( $a, $b ) {
 352         return strnatcasecmp( $a['Name'], $b['Name'] );
 353 }
 354
 355 /**
 356  * Check the wp-content directory and retrieve all drop-ins with any plugin data.
 357  *
 358  * @since 3.0.0
 359  * @return array Key is the file path and the value is an array of the plugin data.
 360  */
 361 function get_dropins() {
 362         $dropins = array();
 363         $plugin_files = array();
 364
 365         $_dropins = _get_dropins();
 366
 367         // These exist in the wp-content directory
 368         if ( $plugins_dir = @ opendir( WP_CONTENT_DIR ) ) {
 369                 while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
 370                         if ( isset( $_dropins[ $file ] ) )
 371                                 $plugin_files[] = $file;
 372                 }
 373         } else {
 374                 return $dropins;
 375         }
 376
 377         @closedir( $plugins_dir );
 378
 379         if ( empty($plugin_files) )
 380                 return $dropins;
 381
 382         foreach ( $plugin_files as $plugin_file ) {
 383                 if ( !is_readable( WP_CONTENT_DIR . "/$plugin_file" ) )
 384                         continue;
 385                 $plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
 386                 if ( empty( $plugin_data['Name'] ) )
 387                         $plugin_data['Name'] = $plugin_file;
 388                 $dropins[ $plugin_file ] = $plugin_data;
 389         }
 390
 391         uksort( $dropins, 'strnatcasecmp' );
 392
 393         return $dropins;
 394 }
 395
 396 /**
 397  * Returns drop-ins that WordPress uses.
 398  *
 399  * Includes Multisite drop-ins only when is_multisite()
 400  *
 401  * @since 3.0.0
 402  * @return array Key is file name. The value is an array, with the first value the
 403  *      purpose of the drop-in and the second value the name of the constant that must be
 404  *      true for the drop-in to be used, or true if no constant is required.
 405  */
 406 function _get_dropins() {
 407         $dropins = array(
 408                 'advanced-cache.php' => array( __( 'Advanced caching plugin.'       ), 'WP_CACHE' ), // WP_CACHE
 409                 'db.php'             => array( __( 'Custom database class.'         ), true ), // auto on load
 410                 'db-error.php'       => array( __( 'Custom database error message.' ), true ), // auto on error
 411                 'install.php'        => array( __( 'Custom install script.'         ), true ), // auto on install
 412                 'maintenance.php'    => array( __( 'Custom maintenance message.'    ), true ), // auto on maintenance
 413                 'object-cache.php'   => array( __( 'External object cache.'         ), true ), // auto on load
 414         );
 415
 416         if ( is_multisite() ) {
 417                 $dropins['sunrise.php'       ] = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE
 418                 $dropins['blog-deleted.php'  ] = array( __( 'Custom site deleted message.'   ), true ); // auto on deleted blog
 419                 $dropins['blog-inactive.php' ] = array( __( 'Custom site inactive message.'  ), true ); // auto on inactive blog
 420                 $dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // auto on archived or spammed blog
 421         }
 422
 423         return $dropins;
 424 }
 425
 426 /**
 427  * Check whether the plugin is active by checking the active_plugins list.
 428  *
 429  * @since 2.5.0
 430  *
 431  * @param string $plugin Base plugin path from plugins directory.
 432  * @return bool True, if in the active plugins list. False, not in the list.
 433  */
 434 function is_plugin_active( $plugin ) {
 435         return in_array( $plugin, (array) get_option( 'active_plugins', array() ) ) || is_plugin_active_for_network( $plugin );
 436 }
 437
 438 /**
 439  * Check whether the plugin is inactive.
 440  *
 441  * Reverse of is_plugin_active(). Used as a callback.
 442  *
 443  * @since 3.1.0
 444  * @see is_plugin_active()
 445  *
 446  * @param string $plugin Base plugin path from plugins directory.
 447  * @return bool True if inactive. False if active.
 448  */
 449 function is_plugin_inactive( $plugin ) {
 450         return ! is_plugin_active( $plugin );
 451 }
 452
 453 /**
 454  * Check whether the plugin is active for the entire network.
 455  *
 456  * @since 3.0.0
 457  *
 458  * @param string $plugin Base plugin path from plugins directory.
 459  * @return bool True, if active for the network, otherwise false.
 460  */
 461 function is_plugin_active_for_network( $plugin ) {
 462         if ( !is_multisite() )
 463                 return false;
 464
 465         $plugins = get_site_option( 'active_sitewide_plugins');
 466         if ( isset($plugins[$plugin]) )
 467                 return true;
 468
 469         return false;
 470 }
 471
 472 /**
 473  * Checks for "Network: true" in the plugin header to see if this should
 474  * be activated only as a network wide plugin. The plugin would also work
 475  * when Multisite is not enabled.
 476  *
 477  * Checks for "Site Wide Only: true" for backwards compatibility.
 478  *
 479  * @since 3.0.0
 480  *
 481  * @param string $plugin Plugin to check
 482  * @return bool True if plugin is network only, false otherwise.
 483  */
 484 function is_network_only_plugin( $plugin ) {
 485         $plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
 486         if ( $plugin_data )
 487                 return $plugin_data['Network'];
 488         return false;
 489 }
 490
 491 /**
 492  * Attempts activation of plugin in a "sandbox" and redirects on success.
 493  *
 494  * A plugin that is already activated will not attempt to be activated again.
 495  *
 496  * The way it works is by setting the redirection to the error before trying to
 497  * include the plugin file. If the plugin fails, then the redirection will not
 498  * be overwritten with the success message. Also, the options will not be
 499  * updated and the activation hook will not be called on plugin error.
 500  *
 501  * It should be noted that in no way the below code will actually prevent errors
 502  * within the file. The code should not be used elsewhere to replicate the
 503  * "sandbox", which uses redirection to work.
 504  * {@source 13 1}
 505  *
 506  * If any errors are found or text is outputted, then it will be captured to
 507  * ensure that the success redirection will update the error redirection.
 508  *
 509  * @since 2.5.0
 510  *
 511  * @param string $plugin Plugin path to main plugin file with plugin data.
 512  * @param string $redirect Optional. URL to redirect to.
 513  * @param bool $network_wide Whether to enable the plugin for all sites in the
 514  *   network or just the current site. Multisite only. Default is false.
 515  * @param bool $silent Prevent calling activation hooks. Optional, default is false.
 516  * @return WP_Error|null WP_Error on invalid file or null on success.
 517  */
 518 function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {
 519         $plugin = plugin_basename( trim( $plugin ) );
 520
 521         if ( is_multisite() && ( $network_wide || is_network_only_plugin($plugin) ) ) {
 522                 $network_wide = true;
 523                 $current = get_site_option( 'active_sitewide_plugins', array() );
 524                 $_GET['networkwide'] = 1; // Back compat for plugins looking for this value.
 525         } else {
 526                 $current = get_option( 'active_plugins', array() );
 527         }
 528
 529         $valid = validate_plugin($plugin);
 530         if ( is_wp_error($valid) )
 531                 return $valid;
 532
 533         if ( !in_array($plugin, $current) ) {
 534                 if ( !empty($redirect) )
 535                         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
 536                 ob_start();
 537                 include_once(WP_PLUGIN_DIR . '/' . $plugin);
 538
 539                 if ( ! $silent ) {
 540                         do_action( 'activate_plugin', $plugin, $network_wide );
 541                         do_action( 'activate_' . $plugin, $network_wide );
 542                 }
 543
 544                 if ( $network_wide ) {
 545                         $current[$plugin] = time();
 546                         update_site_option( 'active_sitewide_plugins', $current );
 547                 } else {
 548                         $current[] = $plugin;
 549                         sort($current);
 550                         update_option('active_plugins', $current);
 551                 }
 552
 553                 if ( ! $silent ) {
 554                         do_action( 'activated_plugin', $plugin, $network_wide );
 555                 }
 556
 557                 if ( ob_get_length() > 0 ) {
 558                         $output = ob_get_clean();
 559                         return new WP_Error('unexpected_output', __('The plugin generated unexpected output.'), $output);
 560                 }
 561                 ob_end_clean();
 562         }
 563
 564         return null;
 565 }
 566
 567 /**
 568  * Deactivate a single plugin or multiple plugins.
 569  *
 570  * The deactivation hook is disabled by the plugin upgrader by using the $silent
 571  * parameter.
 572  *
 573  * @since 2.5.0
 574  *
 575  * @param string|array $plugins Single plugin or list of plugins to deactivate.
 576  * @param mixed $network_wide Whether to deactivate the plugin for all sites in the network.
 577  *      A value of null (the default) will deactivate plugins for both the site and the network.
 578  * @param bool $silent Prevent calling deactivation hooks. Default is false.
 579  */
 580 function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
 581         if ( is_multisite() )
 582                 $network_current = get_site_option( 'active_sitewide_plugins', array() );
 583         $current = get_option( 'active_plugins', array() );
 584         $do_blog = $do_network = false;
 585
 586         foreach ( (array) $plugins as $plugin ) {
 587                 $plugin = plugin_basename( trim( $plugin ) );
 588                 if ( ! is_plugin_active($plugin) )
 589                         continue;
 590
 591                 $network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
 592
 593                 if ( ! $silent )
 594                         do_action( 'deactivate_plugin', $plugin, $network_deactivating );
 595
 596                 if ( false !== $network_wide ) {
 597                         if ( is_plugin_active_for_network( $plugin ) ) {
 598                                 $do_network = true;
 599                                 unset( $network_current[ $plugin ] );
 600                         } elseif ( $network_wide ) {
 601                                 continue;
 602                         }
 603                 }
 604
 605                 if ( true !== $network_wide ) {
 606                         $key = array_search( $plugin, $current );
 607                         if ( false !== $key ) {
 608                                 $do_blog = true;
 609                                 array_splice( $current, $key, 1 );
 610                         }
 611                 }
 612
 613                 if ( ! $silent ) {
 614                         do_action( 'deactivate_' . $plugin, $network_deactivating );
 615                         do_action( 'deactivated_plugin', $plugin, $network_deactivating );
 616                 }
 617         }
 618
 619         if ( $do_blog )
 620                 update_option('active_plugins', $current);
 621         if ( $do_network )
 622                 update_site_option( 'active_sitewide_plugins', $network_current );
 623 }
 624
 625 /**
 626  * Activate multiple plugins.
 627  *
 628  * When WP_Error is returned, it does not mean that one of the plugins had
 629  * errors. It means that one or more of the plugins file path was invalid.
 630  *
 631  * The execution will be halted as soon as one of the plugins has an error.
 632  *
 633  * @since 2.6.0
 634  *
 635  * @param string|array $plugins
 636  * @param string $redirect Redirect to page after successful activation.
 637  * @param bool $network_wide Whether to enable the plugin for all sites in the network.
 638  * @param bool $silent Prevent calling activation hooks. Default is false.
 639  * @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
 640  */
 641 function activate_plugins( $plugins, $redirect = '', $network_wide = false, $silent = false ) {
 642         if ( !is_array($plugins) )
 643                 $plugins = array($plugins);
 644
 645         $errors = array();
 646         foreach ( $plugins as $plugin ) {
 647                 if ( !empty($redirect) )
 648                         $redirect = add_query_arg('plugin', $plugin, $redirect);
 649                 $result = activate_plugin($plugin, $redirect, $network_wide, $silent);
 650                 if ( is_wp_error($result) )
 651                         $errors[$plugin] = $result;
 652         }
 653
 654         if ( !empty($errors) )
 655                 return new WP_Error('plugins_invalid', __('One of the plugins is invalid.'), $errors);
 656
 657         return true;
 658 }
 659
 660 /**
 661  * Remove directory and files of a plugin for a single or list of plugin(s).
 662  *
 663  * If the plugins parameter list is empty, false will be returned. True when
 664  * completed.
 665  *
 666  * @since 2.6.0
 667  *
 668  * @param array $plugins List of plugin
 669  * @param string $redirect Redirect to page when complete.
 670  * @return mixed
 671  */
 672 function delete_plugins($plugins, $redirect = '' ) {
 673         global $wp_filesystem;
 674
 675         if ( empty($plugins) )
 676                 return false;
 677
 678         $checked = array();
 679         foreach( $plugins as $plugin )
 680                 $checked[] = 'checked[]=' . $plugin;
 681
 682         ob_start();
 683         $url = wp_nonce_url('plugins.php?action=delete-selected&verify-delete=1&' . implode('&', $checked), 'bulk-plugins');
 684         if ( false === ($credentials = request_filesystem_credentials($url)) ) {
 685                 $data = ob_get_contents();
 686                 ob_end_clean();
 687                 if ( ! empty($data) ){
 688                         include_once( ABSPATH . 'wp-admin/admin-header.php');
 689                         echo $data;
 690                         include( ABSPATH . 'wp-admin/admin-footer.php');
 691                         exit;
 692                 }
 693                 return;
 694         }
 695
 696         if ( ! WP_Filesystem($credentials) ) {
 697                 request_filesystem_credentials($url, '', true); //Failed to connect, Error and request again
 698                 $data = ob_get_contents();
 699                 ob_end_clean();
 700                 if ( ! empty($data) ){
 701                         include_once( ABSPATH . 'wp-admin/admin-header.php');
 702                         echo $data;
 703                         include( ABSPATH . 'wp-admin/admin-footer.php');
 704                         exit;
 705                 }
 706                 return;
 707         }
 708
 709         if ( ! is_object($wp_filesystem) )
 710                 return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
 711
 712         if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
 713                 return new WP_Error('fs_error', __('Filesystem error.'), $wp_filesystem->errors);
 714
 715         //Get the base plugin folder
 716         $plugins_dir = $wp_filesystem->wp_plugins_dir();
 717         if ( empty($plugins_dir) )
 718                 return new WP_Error('fs_no_plugins_dir', __('Unable to locate WordPress Plugin directory.'));
 719
 720         $plugins_dir = trailingslashit( $plugins_dir );
 721
 722         $errors = array();
 723
 724         foreach( $plugins as $plugin_file ) {
 725                 // Run Uninstall hook
 726                 if ( is_uninstallable_plugin( $plugin_file ) )
 727                         uninstall_plugin($plugin_file);
 728
 729                 $this_plugin_dir = trailingslashit( dirname($plugins_dir . $plugin_file) );
 730                 // If plugin is in its own directory, recursively delete the directory.
 731                 if ( strpos($plugin_file, '/') && $this_plugin_dir != $plugins_dir ) //base check on if plugin includes directory separator AND that its not the root plugin folder
 732                         $deleted = $wp_filesystem->delete($this_plugin_dir, true);
 733                 else
 734                         $deleted = $wp_filesystem->delete($plugins_dir . $plugin_file);
 735
 736                 if ( ! $deleted )
 737                         $errors[] = $plugin_file;
 738         }
 739
 740         if ( ! empty($errors) )
 741                 return new WP_Error('could_not_remove_plugin', sprintf(__('Could not fully remove the plugin(s) %s.'), implode(', ', $errors)) );
 742
 743         // Force refresh of plugin update information
 744         if ( $current = get_site_transient('update_plugins') ) {
 745                 unset( $current->response[ $plugin_file ] );
 746                 set_site_transient('update_plugins', $current);
 747         }
 748
 749         return true;
 750 }
 751
 752 /**
 753  * Validate active plugins
 754  *
 755  * Validate all active plugins, deactivates invalid and
 756  * returns an array of deactivated ones.
 757  *
 758  * @since 2.5.0
 759  * @return array invalid plugins, plugin as key, error as value
 760  */
 761 function validate_active_plugins() {
 762         $plugins = get_option( 'active_plugins', array() );
 763         // validate vartype: array
 764         if ( ! is_array( $plugins ) ) {
 765                 update_option( 'active_plugins', array() );
 766                 $plugins = array();
 767         }
 768
 769         if ( is_multisite() && is_super_admin() ) {
 770                 $network_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
 771                 $plugins = array_merge( $plugins, array_keys( $network_plugins ) );
 772         }
 773
 774         if ( empty( $plugins ) )
 775                 return;
 776
 777         $invalid = array();
 778
 779         // invalid plugins get deactivated
 780         foreach ( $plugins as $plugin ) {
 781                 $result = validate_plugin( $plugin );
 782                 if ( is_wp_error( $result ) ) {
 783                         $invalid[$plugin] = $result;
 784                         deactivate_plugins( $plugin, true );
 785                 }
 786         }
 787         return $invalid;
 788 }
 789
 790 /**
 791  * Validate the plugin path.
 792  *
 793  * Checks that the file exists and {@link validate_file() is valid file}.
 794  *
 795  * @since 2.5.0
 796  *
 797  * @param string $plugin Plugin Path
 798  * @return WP_Error|int 0 on success, WP_Error on failure.
 799  */
 800 function validate_plugin($plugin) {
 801         if ( validate_file($plugin) )
 802                 return new WP_Error('plugin_invalid', __('Invalid plugin path.'));
 803         if ( ! file_exists(WP_PLUGIN_DIR . '/' . $plugin) )
 804                 return new WP_Error('plugin_not_found', __('Plugin file does not exist.'));
 805
 806         $installed_plugins = get_plugins();
 807         if ( ! isset($installed_plugins[$plugin]) )
 808                 return new WP_Error('no_plugin_header', __('The plugin does not have a valid header.'));
 809         return 0;
 810 }
 811
 812 /**
 813  * Whether the plugin can be uninstalled.
 814  *
 815  * @since 2.7.0
 816  *
 817  * @param string $plugin Plugin path to check.
 818  * @return bool Whether plugin can be uninstalled.
 819  */
 820 function is_uninstallable_plugin($plugin) {
 821         $file = plugin_basename($plugin);
 822
 823         $uninstallable_plugins = (array) get_option('uninstall_plugins');
 824         if ( isset( $uninstallable_plugins[$file] ) || file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) )
 825                 return true;
 826
 827         return false;
 828 }
 829
 830 /**
 831  * Uninstall a single plugin.
 832  *
 833  * Calls the uninstall hook, if it is available.
 834  *
 835  * @since 2.7.0
 836  *
 837  * @param string $plugin Relative plugin path from Plugin Directory.
 838  */
 839 function uninstall_plugin($plugin) {
 840         $file = plugin_basename($plugin);
 841
 842         $uninstallable_plugins = (array) get_option('uninstall_plugins');
 843         if ( file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) ) {
 844                 if ( isset( $uninstallable_plugins[$file] ) ) {
 845                         unset($uninstallable_plugins[$file]);
 846                         update_option('uninstall_plugins', $uninstallable_plugins);
 847                 }
 848                 unset($uninstallable_plugins);
 849
 850                 define('WP_UNINSTALL_PLUGIN', $file);
 851                 include WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php';
 852
 853                 return true;
 854         }
 855
 856         if ( isset( $uninstallable_plugins[$file] ) ) {
 857                 $callable = $uninstallable_plugins[$file];
 858                 unset($uninstallable_plugins[$file]);
 859                 update_option('uninstall_plugins', $uninstallable_plugins);
 860                 unset($uninstallable_plugins);
 861
 862                 include WP_PLUGIN_DIR . '/' . $file;
 863
 864                 add_action( 'uninstall_' . $file, $callable );
 865                 do_action( 'uninstall_' . $file );
 866         }
 867 }
 868
 869 //
 870 // Menu
 871 //
 872
 873 /**
 874  * Add a top level menu page
 875  *
 876  * This function takes a capability which will be used to determine whether
 877  * or not a page is included in the menu.
 878  *
 879  * The function which is hooked in to handle the output of the page must check
 880  * that the user has the required capability as well.
 881  *
 882  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
 883  * @param string $menu_title The text to be used for the menu
 884  * @param string $capability The capability required for this menu to be displayed to the user.
 885  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
 886  * @param callback $function The function to be called to output the content for this page.
 887  * @param string $icon_url The url to the icon to be used for this menu
 888  * @param int $position The position in the menu order this one should appear
 889  *
 890  * @return string The resulting page's hook_suffix
 891  */
 892 function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null ) {
 893         global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;
 894
 895         $menu_slug = plugin_basename( $menu_slug );
 896
 897         $admin_page_hooks[$menu_slug] = sanitize_title( $menu_title );
 898
 899         $hookname = get_plugin_page_hookname( $menu_slug, '' );
 900
 901         if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
 902                 add_action( $hookname, $function );
 903
 904         if ( empty($icon_url) )
 905                 $icon_url = esc_url( admin_url( 'images/generic.png' ) );
 906         elseif ( is_ssl() && 0 === strpos($icon_url, 'http://') )
 907                 $icon_url = 'https://' . substr($icon_url, 7);
 908
 909         $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $hookname, $hookname, $icon_url );
 910
 911         if ( null === $position )
 912                 $menu[] = $new_menu;
 913         else
 914                 $menu[$position] = $new_menu;
 915
 916         $_registered_pages[$hookname] = true;
 917
 918         // No parent as top level
 919         $_parent_pages[$menu_slug] = false;
 920
 921         return $hookname;
 922 }
 923
 924 /**
 925  * Add a top level menu page in the 'objects' section
 926  *
 927  * This function takes a capability which will be used to determine whether
 928  * or not a page is included in the menu.
 929  *
 930  * The function which is hooked in to handle the output of the page must check
 931  * that the user has the required capability as well.
 932  *
 933  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
 934  * @param string $menu_title The text to be used for the menu
 935  * @param string $capability The capability required for this menu to be displayed to the user.
 936  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
 937  * @param callback $function The function to be called to output the content for this page.
 938  * @param string $icon_url The url to the icon to be used for this menu
 939  *
 940  * @return string The resulting page's hook_suffix
 941  */
 942 function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
 943         global $_wp_last_object_menu;
 944
 945         $_wp_last_object_menu++;
 946
 947         return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_object_menu);
 948 }
 949
 950 /**
 951  * Add a top level menu page in the 'utility' section
 952  *
 953  * This function takes a capability which will be used to determine whether
 954  * or not a page is included in the menu.
 955  *
 956  * The function which is hooked in to handle the output of the page must check
 957  * that the user has the required capability as well.
 958  *
 959  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
 960  * @param string $menu_title The text to be used for the menu
 961  * @param string $capability The capability required for this menu to be displayed to the user.
 962  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
 963  * @param callback $function The function to be called to output the content for this page.
 964  * @param string $icon_url The url to the icon to be used for this menu
 965  *
 966  * @return string The resulting page's hook_suffix
 967  */
 968 function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
 969         global $_wp_last_utility_menu;
 970
 971         $_wp_last_utility_menu++;
 972
 973         return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_utility_menu);
 974 }
 975
 976 /**
 977  * Add a sub menu page
 978  *
 979  * This function takes a capability which will be used to determine whether
 980  * or not a page is included in the menu.
 981  *
 982  * The function which is hooked in to handle the output of the page must check
 983  * that the user has the required capability as well.
 984  *
 985  * @param string $parent_slug The slug name for the parent menu (or the file name of a standard WordPress admin page)
 986  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
 987  * @param string $menu_title The text to be used for the menu
 988  * @param string $capability The capability required for this menu to be displayed to the user.
 989  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
 990  * @param callback $function The function to be called to output the content for this page.
 991  *
 992  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
 993  */
 994 function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
 995         global $submenu;
 996         global $menu;
 997         global $_wp_real_parent_file;
 998         global $_wp_submenu_nopriv;
 999         global $_registered_pages;
1000         global $_parent_pages;
1001
1002         $menu_slug = plugin_basename( $menu_slug );
1003         $parent_slug = plugin_basename( $parent_slug);
1004
1005         if ( isset( $_wp_real_parent_file[$parent_slug] ) )
1006                 $parent_slug = $_wp_real_parent_file[$parent_slug];
1007
1008         if ( !current_user_can( $capability ) ) {
1009                 $_wp_submenu_nopriv[$parent_slug][$menu_slug] = true;
1010                 return false;
1011         }
1012
1013         // If the parent doesn't already have a submenu, add a link to the parent
1014         // as the first item in the submenu. If the submenu file is the same as the
1015         // parent file someone is trying to link back to the parent manually. In
1016         // this case, don't automatically add a link back to avoid duplication.
1017         if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug ) {
1018                 foreach ( (array)$menu as $parent_menu ) {
1019                         if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) )
1020                                 $submenu[$parent_slug][] = $parent_menu;
1021                 }
1022         }
1023
1024         $submenu[$parent_slug][] = array ( $menu_title, $capability, $menu_slug, $page_title );
1025
1026         $hookname = get_plugin_page_hookname( $menu_slug, $parent_slug);
1027         if (!empty ( $function ) && !empty ( $hookname ))
1028                 add_action( $hookname, $function );
1029
1030         $_registered_pages[$hookname] = true;
1031         // backwards-compatibility for plugins using add_management page. See wp-admin/admin.php for redirect from edit.php to tools.php
1032         if ( 'tools.php' == $parent_slug )
1033                 $_registered_pages[get_plugin_page_hookname( $menu_slug, 'edit.php')] = true;
1034
1035         // No parent as top level
1036         $_parent_pages[$menu_slug] = $parent_slug;
1037
1038         return $hookname;
1039 }
1040
1041 /**
1042  * Add sub menu page to the tools main menu.
1043  *
1044  * This function takes a capability which will be used to determine whether
1045  * or not a page is included in the menu.
1046  *
1047  * The function which is hooked in to handle the output of the page must check
1048  * that the user has the required capability as well.
1049  *
1050  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1051  * @param string $menu_title The text to be used for the menu
1052  * @param string $capability The capability required for this menu to be displayed to the user.
1053  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1054  * @param callback $function The function to be called to output the content for this page.
1055  *
1056  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1057  */
1058 function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1059         return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1060 }
1061
1062 /**
1063  * Add sub menu page to the options main menu.
1064  *
1065  * This function takes a capability which will be used to determine whether
1066  * or not a page is included in the menu.
1067  *
1068  * The function which is hooked in to handle the output of the page must check
1069  * that the user has the required capability as well.
1070  *
1071  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1072  * @param string $menu_title The text to be used for the menu
1073  * @param string $capability The capability required for this menu to be displayed to the user.
1074  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1075  * @param callback $function The function to be called to output the content for this page.
1076  *
1077  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1078  */
1079 function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1080         return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1081 }
1082
1083 /**
1084  * Add sub menu page to the themes main menu.
1085  *
1086  * This function takes a capability which will be used to determine whether
1087  * or not a page is included in the menu.
1088  *
1089  * The function which is hooked in to handle the output of the page must check
1090  * that the user has the required capability as well.
1091  *
1092  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1093  * @param string $menu_title The text to be used for the menu
1094  * @param string $capability The capability required for this menu to be displayed to the user.
1095  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1096  * @param callback $function The function to be called to output the content for this page.
1097  *
1098  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1099  */
1100 function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1101         return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1102 }
1103
1104 /**
1105  * Add sub menu page to the plugins main menu.
1106  *
1107  * This function takes a capability which will be used to determine whether
1108  * or not a page is included in the menu.
1109  *
1110  * The function which is hooked in to handle the output of the page must check
1111  * that the user has the required capability as well.
1112  *
1113  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1114  * @param string $menu_title The text to be used for the menu
1115  * @param string $capability The capability required for this menu to be displayed to the user.
1116  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1117  * @param callback $function The function to be called to output the content for this page.
1118  *
1119  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1120  */
1121 function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1122         return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1123 }
1124
1125 /**
1126  * Add sub menu page to the Users/Profile main menu.
1127  *
1128  * This function takes a capability which will be used to determine whether
1129  * or not a page is included in the menu.
1130  *
1131  * The function which is hooked in to handle the output of the page must check
1132  * that the user has the required capability as well.
1133  *
1134  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1135  * @param string $menu_title The text to be used for the menu
1136  * @param string $capability The capability required for this menu to be displayed to the user.
1137  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1138  * @param callback $function The function to be called to output the content for this page.
1139  *
1140  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1141  */
1142 function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1143         if ( current_user_can('edit_users') )
1144                 $parent = 'users.php';
1145         else
1146                 $parent = 'profile.php';
1147         return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function );
1148 }
1149 /**
1150  * Add sub menu page to the Dashboard main menu.
1151  *
1152  * This function takes a capability which will be used to determine whether
1153  * or not a page is included in the menu.
1154  *
1155  * The function which is hooked in to handle the output of the page must check
1156  * that the user has the required capability as well.
1157  *
1158  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1159  * @param string $menu_title The text to be used for the menu
1160  * @param string $capability The capability required for this menu to be displayed to the user.
1161  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1162  * @param callback $function The function to be called to output the content for this page.
1163  *
1164  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1165  */
1166 function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1167         return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1168 }
1169
1170 /**
1171  * Add sub menu page to the posts main menu.
1172  *
1173  * This function takes a capability which will be used to determine whether
1174  * or not a page is included in the menu.
1175  *
1176  * The function which is hooked in to handle the output of the page must check
1177  * that the user has the required capability as well.
1178  *
1179  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1180  * @param string $menu_title The text to be used for the menu
1181  * @param string $capability The capability required for this menu to be displayed to the user.
1182  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1183  * @param callback $function The function to be called to output the content for this page.
1184  *
1185  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1186  */
1187 function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1188         return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1189 }
1190
1191 /**
1192  * Add sub menu page to the media main menu.
1193  *
1194  * This function takes a capability which will be used to determine whether
1195  * or not a page is included in the menu.
1196  *
1197  * The function which is hooked in to handle the output of the page must check
1198  * that the user has the required capability as well.
1199  *
1200  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1201  * @param string $menu_title The text to be used for the menu
1202  * @param string $capability The capability required for this menu to be displayed to the user.
1203  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1204  * @param callback $function The function to be called to output the content for this page.
1205  *
1206  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1207  */
1208 function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1209         return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1210 }
1211
1212 /**
1213  * Add sub menu page to the links main menu.
1214  *
1215  * This function takes a capability which will be used to determine whether
1216  * or not a page is included in the menu.
1217  *
1218  * The function which is hooked in to handle the output of the page must check
1219  * that the user has the required capability as well.
1220  *
1221  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1222  * @param string $menu_title The text to be used for the menu
1223  * @param string $capability The capability required for this menu to be displayed to the user.
1224  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1225  * @param callback $function The function to be called to output the content for this page.
1226  *
1227  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1228  */
1229 function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1230         return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1231 }
1232
1233 /**
1234  * Add sub menu page to the pages main menu.
1235  *
1236  * This function takes a capability which will be used to determine whether
1237  * or not a page is included in the menu.
1238  *
1239  * The function which is hooked in to handle the output of the page must check
1240  * that the user has the required capability as well.
1241  *
1242  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1243  * @param string $menu_title The text to be used for the menu
1244  * @param string $capability The capability required for this menu to be displayed to the user.
1245  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1246  * @param callback $function The function to be called to output the content for this page.
1247  *
1248  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1249 */
1250 function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1251         return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
1252 }
1253
1254 /**
1255  * Add sub menu page to the comments main menu.
1256  *
1257  * This function takes a capability which will be used to determine whether
1258  * or not a page is included in the menu.
1259  *
1260  * The function which is hooked in to handle the output of the page must check
1261  * that the user has the required capability as well.
1262  *
1263  * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1264  * @param string $menu_title The text to be used for the menu
1265  * @param string $capability The capability required for this menu to be displayed to the user.
1266  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1267  * @param callback $function The function to be called to output the content for this page.
1268  *
1269  * @return string|bool The resulting page's hook_suffix, or false if the user does not have the capability required.
1270 */
1271 function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1272         return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1273 }
1274
1275 /**
1276  * Remove a top level admin menu
1277  *
1278  * @since 3.1.0
1279  *
1280  * @param string $menu_slug The slug of the menu
1281  * @return array|bool The removed menu on success, False if not found
1282  */
1283 function remove_menu_page( $menu_slug ) {
1284         global $menu;
1285
1286         foreach ( $menu as $i => $item ) {
1287                 if ( $menu_slug == $item[2] ) {
1288                         unset( $menu[$i] );
1289                         return $item;
1290                 }
1291         }
1292
1293         return false;
1294 }
1295
1296 /**
1297  * Remove an admin submenu
1298  *
1299  * @since 3.1.0
1300  *
1301  * @param string $menu_slug The slug for the parent menu
1302  * @param string $submenu_slug The slug of the submenu
1303  * @return array|bool The removed submenu on success, False if not found
1304  */
1305 function remove_submenu_page( $menu_slug, $submenu_slug ) {
1306         global $submenu;
1307
1308         if ( !isset( $submenu[$menu_slug] ) )
1309                 return false;
1310
1311         foreach ( $submenu[$menu_slug] as $i => $item ) {
1312                 if ( $submenu_slug == $item[2] ) {
1313                         unset( $submenu[$menu_slug][$i] );
1314                         return $item;
1315                 }
1316         }
1317
1318         return false;
1319 }
1320
1321 /**
1322  * Get the url to access a particular menu page based on the slug it was registered with.
1323  *
1324  * If the slug hasn't been registered properly no url will be returned
1325  *
1326  * @since 3.0
1327  *
1328  * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1329  * @param bool $echo Whether or not to echo the url - default is true
1330  * @return string the url
1331  */
1332 function menu_page_url($menu_slug, $echo = true) {
1333         global $_parent_pages;
1334
1335         if ( isset( $_parent_pages[$menu_slug] ) ) {
1336                 $parent_slug = $_parent_pages[$menu_slug];
1337                 if ( $parent_slug && ! isset( $_parent_pages[$parent_slug] ) ) {
1338                         $url = admin_url( add_query_arg( 'page', $menu_slug, $parent_slug ) );
1339                 } else {
1340                         $url = admin_url( 'admin.php?page=' . $menu_slug );
1341                 }
1342         } else {
1343                 $url = '';
1344         }
1345
1346         $url = esc_url($url);
1347
1348         if ( $echo )
1349                 echo $url;
1350
1351         return $url;
1352 }
1353
1354 //
1355 // Pluggable Menu Support -- Private
1356 //
1357
1358 function get_admin_page_parent( $parent = '' ) {
1359         global $parent_file;
1360         global $menu;
1361         global $submenu;
1362         global $pagenow;
1363         global $typenow;
1364         global $plugin_page;
1365         global $_wp_real_parent_file;
1366         global $_wp_menu_nopriv;
1367         global $_wp_submenu_nopriv;
1368
1369         if ( !empty ( $parent ) && 'admin.php' != $parent ) {
1370                 if ( isset( $_wp_real_parent_file[$parent] ) )
1371                         $parent = $_wp_real_parent_file[$parent];
1372                 return $parent;
1373         }
1374
1375         /*
1376         if ( !empty ( $parent_file ) ) {
1377                 if ( isset( $_wp_real_parent_file[$parent_file] ) )
1378                         $parent_file = $_wp_real_parent_file[$parent_file];
1379
1380                 return $parent_file;
1381         }
1382         */
1383
1384         if ( $pagenow == 'admin.php' && isset( $plugin_page ) ) {
1385                 foreach ( (array)$menu as $parent_menu ) {
1386                         if ( $parent_menu[2] == $plugin_page ) {
1387                                 $parent_file = $plugin_page;
1388                                 if ( isset( $_wp_real_parent_file[$parent_file] ) )
1389                                         $parent_file = $_wp_real_parent_file[$parent_file];
1390                                 return $parent_file;
1391                         }
1392                 }
1393                 if ( isset( $_wp_menu_nopriv[$plugin_page] ) ) {
1394                         $parent_file = $plugin_page;
1395                         if ( isset( $_wp_real_parent_file[$parent_file] ) )
1396                                         $parent_file = $_wp_real_parent_file[$parent_file];
1397                         return $parent_file;
1398                 }
1399         }
1400
1401         if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$pagenow][$plugin_page] ) ) {
1402                 $parent_file = $pagenow;
1403                 if ( isset( $_wp_real_parent_file[$parent_file] ) )
1404                         $parent_file = $_wp_real_parent_file[$parent_file];
1405                 return $parent_file;
1406         }
1407
1408         foreach (array_keys( (array)$submenu ) as $parent) {
1409                 foreach ( $submenu[$parent] as $submenu_array ) {
1410                         if ( isset( $_wp_real_parent_file[$parent] ) )
1411                                 $parent = $_wp_real_parent_file[$parent];
1412                         if ( !empty($typenow) && ($submenu_array[2] == "$pagenow?post_type=$typenow") ) {
1413                                 $parent_file = $parent;
1414                                 return $parent;
1415                         } elseif ( $submenu_array[2] == $pagenow && empty($typenow) && ( empty($parent_file) || false === strpos($parent_file, '?') ) ) {
1416                                 $parent_file = $parent;
1417                                 return $parent;
1418                         } else
1419                                 if ( isset( $plugin_page ) && ($plugin_page == $submenu_array[2] ) ) {
1420                                         $parent_file = $parent;
1421                                         return $parent;
1422                                 }
1423                 }
1424         }
1425
1426         if ( empty($parent_file) )
1427                 $parent_file = '';
1428         return '';
1429 }
1430
1431 function get_admin_page_title() {
1432         global $title;
1433         global $menu;
1434         global $submenu;
1435         global $pagenow;
1436         global $plugin_page;
1437         global $typenow;
1438
1439         if ( ! empty ( $title ) )
1440                 return $title;
1441
1442         $hook = get_plugin_page_hook( $plugin_page, $pagenow );
1443
1444         $parent = $parent1 = get_admin_page_parent();
1445
1446         if ( empty ( $parent) ) {
1447                 foreach ( (array)$menu as $menu_array ) {
1448                         if ( isset( $menu_array[3] ) ) {
1449                                 if ( $menu_array[2] == $pagenow ) {
1450                                         $title = $menu_array[3];
1451                                         return $menu_array[3];
1452                                 } else
1453                                         if ( isset( $plugin_page ) && ($plugin_page == $menu_array[2] ) && ($hook == $menu_array[3] ) ) {
1454                                                 $title = $menu_array[3];
1455                                                 return $menu_array[3];
1456                                         }
1457                         } else {
1458                                 $title = $menu_array[0];
1459                                 return $title;
1460                         }
1461                 }
1462         } else {
1463                 foreach ( array_keys( $submenu ) as $parent ) {
1464                         foreach ( $submenu[$parent] as $submenu_array ) {
1465                                 if ( isset( $plugin_page ) &&
1466                                         ( $plugin_page == $submenu_array[2] ) &&
1467                                         (
1468                                                 ( $parent == $pagenow ) ||
1469                                                 ( $parent == $plugin_page ) ||
1470                                                 ( $plugin_page == $hook ) ||
1471                                                 ( $pagenow == 'admin.php' && $parent1 != $submenu_array[2] ) ||
1472                                                 ( !empty($typenow) && $parent == $pagenow . '?post_type=' . $typenow)
1473                                         )
1474                                         ) {
1475                                                 $title = $submenu_array[3];
1476                                                 return $submenu_array[3];
1477                                         }
1478
1479                                 if ( $submenu_array[2] != $pagenow || isset( $_GET['page'] ) ) // not the current page
1480                                         continue;
1481
1482                                 if ( isset( $submenu_array[3] ) ) {
1483                                         $title = $submenu_array[3];
1484                                         return $submenu_array[3];
1485                                 } else {
1486                                         $title = $submenu_array[0];
1487                                         return $title;
1488                                 }
1489                         }
1490                 }
1491                 if ( empty ( $title ) ) {
1492                         foreach ( $menu as $menu_array ) {
1493                                 if ( isset( $plugin_page ) &&
1494                                         ( $plugin_page == $menu_array[2] ) &&
1495                                         ( $pagenow == 'admin.php' ) &&
1496                                         ( $parent1 == $menu_array[2] ) )
1497                                         {
1498                                                 $title = $menu_array[3];
1499                                                 return $menu_array[3];
1500                                         }
1501                         }
1502                 }
1503         }
1504
1505         return $title;
1506 }
1507
1508 function get_plugin_page_hook( $plugin_page, $parent_page ) {
1509         $hook = get_plugin_page_hookname( $plugin_page, $parent_page );
1510         if ( has_action($hook) )
1511                 return $hook;
1512         else
1513                 return null;
1514 }
1515
1516 function get_plugin_page_hookname( $plugin_page, $parent_page ) {
1517         global $admin_page_hooks;
1518
1519         $parent = get_admin_page_parent( $parent_page );
1520
1521         $page_type = 'admin';
1522         if ( empty ( $parent_page ) || 'admin.php' == $parent_page || isset( $admin_page_hooks[$plugin_page] ) ) {
1523                 if ( isset( $admin_page_hooks[$plugin_page] ) )
1524                         $page_type = 'toplevel';
1525                 else
1526                         if ( isset( $admin_page_hooks[$parent] ))
1527                                 $page_type = $admin_page_hooks[$parent];
1528         } else if ( isset( $admin_page_hooks[$parent] ) ) {
1529                 $page_type = $admin_page_hooks[$parent];
1530         }
1531
1532         $plugin_name = preg_replace( '!\.php!', '', $plugin_page );
1533
1534         return $page_type . '_page_' . $plugin_name;
1535 }
1536
1537 function user_can_access_admin_page() {
1538         global $pagenow;
1539         global $menu;
1540         global $submenu;
1541         global $_wp_menu_nopriv;
1542         global $_wp_submenu_nopriv;
1543         global $plugin_page;
1544         global $_registered_pages;
1545
1546         $parent = get_admin_page_parent();
1547
1548         if ( !isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$parent][$pagenow] ) )
1549                 return false;
1550
1551         if ( isset( $plugin_page ) ) {
1552                 if ( isset( $_wp_submenu_nopriv[$parent][$plugin_page] ) )
1553                         return false;
1554
1555                 $hookname = get_plugin_page_hookname($plugin_page, $parent);
1556
1557                 if ( !isset($_registered_pages[$hookname]) )
1558                         return false;
1559         }
1560
1561         if ( empty( $parent) ) {
1562                 if ( isset( $_wp_menu_nopriv[$pagenow] ) )
1563                         return false;
1564                 if ( isset( $_wp_submenu_nopriv[$pagenow][$pagenow] ) )
1565                         return false;
1566                 if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$pagenow][$plugin_page] ) )
1567                         return false;
1568                 if ( isset( $plugin_page ) && isset( $_wp_menu_nopriv[$plugin_page] ) )
1569                         return false;
1570                 foreach (array_keys( $_wp_submenu_nopriv ) as $key ) {
1571                         if ( isset( $_wp_submenu_nopriv[$key][$pagenow] ) )
1572                                 return false;
1573                         if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$key][$plugin_page] ) )
1574                         return false;
1575                 }
1576                 return true;
1577         }
1578
1579         if ( isset( $plugin_page ) && ( $plugin_page == $parent ) && isset( $_wp_menu_nopriv[$plugin_page] ) )
1580                 return false;
1581
1582         if ( isset( $submenu[$parent] ) ) {
1583                 foreach ( $submenu[$parent] as $submenu_array ) {
1584                         if ( isset( $plugin_page ) && ( $submenu_array[2] == $plugin_page ) ) {
1585                                 if ( current_user_can( $submenu_array[1] ))
1586                                         return true;
1587                                 else
1588                                         return false;
1589                         } else if ( $submenu_array[2] == $pagenow ) {
1590                                 if ( current_user_can( $submenu_array[1] ))
1591                                         return true;
1592                                 else
1593                                         return false;
1594                         }
1595                 }
1596         }
1597
1598         foreach ( $menu as $menu_array ) {
1599                 if ( $menu_array[2] == $parent) {
1600                         if ( current_user_can( $menu_array[1] ))
1601                                 return true;
1602                         else
1603                                 return false;
1604                 }
1605         }
1606
1607         return true;
1608 }
1609
1610 /* Whitelist functions */
1611
1612 /**
1613  * Register a setting and its sanitization callback
1614  *
1615  * @since 2.7.0
1616  *
1617  * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
1618  *      Default whitelisted option key names include "general," "discussion," and "reading," among others.
1619  * @param string $option_name The name of an option to sanitize and save.
1620  * @param unknown_type $sanitize_callback A callback function that sanitizes the option's value.
1621  * @return unknown
1622  */
1623 function register_setting( $option_group, $option_name, $sanitize_callback = '' ) {
1624         global $new_whitelist_options;
1625
1626         if ( 'misc' == $option_group ) {
1627                 _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
1628                 $option_group = 'general';
1629         }
1630
1631         $new_whitelist_options[ $option_group ][] = $option_name;
1632         if ( $sanitize_callback != '' )
1633                 add_filter( "sanitize_option_{$option_name}", $sanitize_callback );
1634 }
1635
1636 /**
1637  * Unregister a setting
1638  *
1639  * @since 2.7.0
1640  *
1641  * @param unknown_type $option_group
1642  * @param unknown_type $option_name
1643  * @param unknown_type $sanitize_callback
1644  * @return unknown
1645  */
1646 function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) {
1647         global $new_whitelist_options;
1648
1649         if ( 'misc' == $option_group ) {
1650                 _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
1651                 $option_group = 'general';
1652         }
1653
1654         $pos = array_search( $option_name, (array) $new_whitelist_options );
1655         if ( $pos !== false )
1656                 unset( $new_whitelist_options[ $option_group ][ $pos ] );
1657         if ( $sanitize_callback != '' )
1658                 remove_filter( "sanitize_option_{$option_name}", $sanitize_callback );
1659 }
1660
1661 /**
1662  * {@internal Missing Short Description}}
1663  *
1664  * @since 2.7.0
1665  *
1666  * @param unknown_type $options
1667  * @return unknown
1668  */
1669 function option_update_filter( $options ) {
1670         global $new_whitelist_options;
1671
1672         if ( is_array( $new_whitelist_options ) )
1673                 $options = add_option_whitelist( $new_whitelist_options, $options );
1674
1675         return $options;
1676 }
1677 add_filter( 'whitelist_options', 'option_update_filter' );
1678
1679 /**
1680  * {@internal Missing Short Description}}
1681  *
1682  * @since 2.7.0
1683  *
1684  * @param unknown_type $new_options
1685  * @param unknown_type $options
1686  * @return unknown
1687  */
1688 function add_option_whitelist( $new_options, $options = '' ) {
1689         if ( $options == '' )
1690                 global $whitelist_options;
1691         else
1692                 $whitelist_options = $options;
1693
1694         foreach ( $new_options as $page => $keys ) {
1695                 foreach ( $keys as $key ) {
1696                         if ( !isset($whitelist_options[ $page ]) || !is_array($whitelist_options[ $page ]) ) {
1697                                 $whitelist_options[ $page ] = array();
1698                                 $whitelist_options[ $page ][] = $key;
1699                         } else {
1700                                 $pos = array_search( $key, $whitelist_options[ $page ] );
1701                                 if ( $pos === false )
1702                                         $whitelist_options[ $page ][] = $key;
1703                         }
1704                 }
1705         }
1706
1707         return $whitelist_options;
1708 }
1709
1710 /**
1711  * {@internal Missing Short Description}}
1712  *
1713  * @since 2.7.0
1714  *
1715  * @param unknown_type $del_options
1716  * @param unknown_type $options
1717  * @return unknown
1718  */
1719 function remove_option_whitelist( $del_options, $options = '' ) {
1720         if ( $options == '' )
1721                 global $whitelist_options;
1722         else
1723                 $whitelist_options = $options;
1724
1725         foreach ( $del_options as $page => $keys ) {
1726                 foreach ( $keys as $key ) {
1727                         if ( isset($whitelist_options[ $page ]) && is_array($whitelist_options[ $page ]) ) {
1728                                 $pos = array_search( $key, $whitelist_options[ $page ] );
1729                                 if ( $pos !== false )
1730                                         unset( $whitelist_options[ $page ][ $pos ] );
1731                         }
1732                 }
1733         }
1734
1735         return $whitelist_options;
1736 }
1737
1738 /**
1739  * Output nonce, action, and option_page fields for a settings page.
1740  *
1741  * @since 2.7.0
1742  *
1743  * @param string $option_group A settings group name. This should match the group name used in register_setting().
1744  */
1745 function settings_fields($option_group) {
1746         echo "<input type='hidden' name='option_page' value='" . esc_attr($option_group) . "' />";
1747         echo '<input type="hidden" name="action" value="update" />';
1748         wp_nonce_field("$option_group-options");
1749 }