3 * WordPress Plugin Administration API
6 * @subpackage Administration
10 * Parse the plugin contents to retrieve plugin's metadata.
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.
18 * Plugin Name: Name of Plugin
19 * Plugin URI: Link to plugin information
20 * Description: Plugin Description
21 * Author: Plugin author's name
22 * Author URI: Link to the author's web site
23 * Version: Must be set in the plugin for WordPress 2.3+
24 * Text Domain: Optional. Unique identifier, should be same as the one used in
25 * plugin_text_domain()
26 * Domain Path: Optional. Only useful if the translations are located in a
27 * folder above the plugin's base path. For example, if .mo files are
28 * located in the locale folder then Domain Path will be "/locale/" and
29 * must have the first slash. Defaults to the base folder the plugin is
31 * Network: Optional. Specify "Network: true" to require that a plugin is activated
32 * across all sites in an installation. This will prevent a plugin from being
33 * activated on a single site when Multisite is enabled.
34 * * / # Remove the space to close comment
36 * Plugin data returned array contains the following:
38 * - 'Name' - Name of the plugin, must be unique.
39 * - 'Title' - Title of the plugin and the link to the plugin's web site.
40 * - 'Description' - Description of what the plugin does and/or notes
42 * - 'Author' - The author's name
43 * - 'AuthorURI' - The authors web site address.
44 * - 'Version' - The plugin version number.
45 * - 'PluginURI' - Plugin web site address.
46 * - 'TextDomain' - Plugin's text domain for localization.
47 * - 'DomainPath' - Plugin's relative directory path to .mo files.
48 * - 'Network' - Boolean. Whether the plugin can only be activated network wide.
50 * Some users have issues with opening large files and manipulating the contents
51 * for want is usually the first 1kiB or 2kiB. This function stops pulling in
52 * the plugin contents when it has all of the required plugin data.
54 * The first 8kiB of the file will be pulled in and if the plugin data is not
55 * within that first 8kiB, then the plugin author should correct their plugin
56 * and move the plugin data headers to the top.
58 * The plugin file is assumed to have permissions to allow for scripts to read
59 * the file. This is not checked however and the file is only opened for
62 * @link https://core.trac.wordpress.org/ticket/5651 Previous Optimizations.
63 * @link https://core.trac.wordpress.org/ticket/7372 Further and better Optimizations.
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.
72 function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
74 $default_headers = array(
75 'Name' => 'Plugin Name',
76 'PluginURI' => 'Plugin URI',
77 'Version' => 'Version',
78 'Description' => 'Description',
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',
88 $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
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'];
95 $plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
96 unset( $plugin_data['_sitewide'] );
98 if ( $markup || $translate ) {
99 $plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
101 $plugin_data['Title'] = $plugin_data['Name'];
102 $plugin_data['AuthorName'] = $plugin_data['Author'];
109 * Sanitizes plugin data, optionally adds markup, optionally translates.
113 * @see get_plugin_data()
115 function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
117 // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path
118 $plugin_file = plugin_basename( $plugin_file );
122 if ( $textdomain = $plugin_data['TextDomain'] ) {
123 if ( $plugin_data['DomainPath'] )
124 load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) . $plugin_data['DomainPath'] );
126 load_plugin_textdomain( $textdomain, false, dirname( $plugin_file ) );
127 } elseif ( in_array( basename( $plugin_file ), array( 'hello.php', 'akismet.php' ) ) ) {
128 $textdomain = 'default';
131 foreach ( array( 'Name', 'PluginURI', 'Description', 'Author', 'AuthorURI', 'Version' ) as $field )
132 $plugin_data[ $field ] = translate( $plugin_data[ $field ], $textdomain );
137 $allowed_tags = $allowed_tags_in_links = array(
138 'abbr' => array( 'title' => true ),
139 'acronym' => array( 'title' => true ),
144 $allowed_tags['a'] = array( 'href' => true, 'title' => true );
146 // Name is marked up inside <a> tags. Don't allow these.
147 // Author is too, but some plugins have used <a> here (omitting Author URI).
148 $plugin_data['Name'] = wp_kses( $plugin_data['Name'], $allowed_tags_in_links );
149 $plugin_data['Author'] = wp_kses( $plugin_data['Author'], $allowed_tags );
151 $plugin_data['Description'] = wp_kses( $plugin_data['Description'], $allowed_tags );
152 $plugin_data['Version'] = wp_kses( $plugin_data['Version'], $allowed_tags );
154 $plugin_data['PluginURI'] = esc_url( $plugin_data['PluginURI'] );
155 $plugin_data['AuthorURI'] = esc_url( $plugin_data['AuthorURI'] );
157 $plugin_data['Title'] = $plugin_data['Name'];
158 $plugin_data['AuthorName'] = $plugin_data['Author'];
162 if ( $plugin_data['PluginURI'] && $plugin_data['Name'] )
163 $plugin_data['Title'] = '<a href="' . $plugin_data['PluginURI'] . '">' . $plugin_data['Name'] . '</a>';
165 if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] )
166 $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '">' . $plugin_data['Author'] . '</a>';
168 $plugin_data['Description'] = wptexturize( $plugin_data['Description'] );
170 if ( $plugin_data['Author'] )
171 $plugin_data['Description'] .= ' <cite>' . sprintf( __('By %s.'), $plugin_data['Author'] ) . '</cite>';
178 * Get a list of a plugin's files.
182 * @param string $plugin Plugin ID
183 * @return array List of files relative to the plugin root.
185 function get_plugin_files($plugin) {
186 $plugin_file = WP_PLUGIN_DIR . '/' . $plugin;
187 $dir = dirname($plugin_file);
188 $plugin_files = array($plugin);
189 if ( is_dir($dir) && $dir != WP_PLUGIN_DIR ) {
190 $plugins_dir = @ opendir( $dir );
191 if ( $plugins_dir ) {
192 while (($file = readdir( $plugins_dir ) ) !== false ) {
193 if ( substr($file, 0, 1) == '.' )
195 if ( is_dir( $dir . '/' . $file ) ) {
196 $plugins_subdir = @ opendir( $dir . '/' . $file );
197 if ( $plugins_subdir ) {
198 while (($subfile = readdir( $plugins_subdir ) ) !== false ) {
199 if ( substr($subfile, 0, 1) == '.' )
201 $plugin_files[] = plugin_basename("$dir/$file/$subfile");
203 @closedir( $plugins_subdir );
206 if ( plugin_basename("$dir/$file") != $plugin )
207 $plugin_files[] = plugin_basename("$dir/$file");
210 @closedir( $plugins_dir );
214 return $plugin_files;
218 * Check the plugins directory and retrieve all plugin files with plugin data.
220 * WordPress only supports plugin files in the base plugins directory
221 * (wp-content/plugins) and in one directory above the plugins directory
222 * (wp-content/plugins/my-plugin). The file it looks for has the plugin data and
223 * must be found in those two locations. It is recommended that do keep your
224 * plugin files in directories.
226 * The file with the plugin data is the file that will be included and therefore
227 * needs to have the main execution for the plugin. This does not mean
228 * everything must be contained in the file and it is recommended that the file
229 * be split for maintainability. Keep everything in one file for extreme
230 * optimization purposes.
234 * @param string $plugin_folder Optional. Relative path to single plugin folder.
235 * @return array Key is the plugin file path and the value is an array of the plugin data.
237 function get_plugins($plugin_folder = '') {
239 if ( ! $cache_plugins = wp_cache_get('plugins', 'plugins') )
240 $cache_plugins = array();
242 if ( isset($cache_plugins[ $plugin_folder ]) )
243 return $cache_plugins[ $plugin_folder ];
245 $wp_plugins = array ();
246 $plugin_root = WP_PLUGIN_DIR;
247 if ( !empty($plugin_folder) )
248 $plugin_root .= $plugin_folder;
250 // Files in wp-content/plugins directory
251 $plugins_dir = @ opendir( $plugin_root);
252 $plugin_files = array();
253 if ( $plugins_dir ) {
254 while (($file = readdir( $plugins_dir ) ) !== false ) {
255 if ( substr($file, 0, 1) == '.' )
257 if ( is_dir( $plugin_root.'/'.$file ) ) {
258 $plugins_subdir = @ opendir( $plugin_root.'/'.$file );
259 if ( $plugins_subdir ) {
260 while (($subfile = readdir( $plugins_subdir ) ) !== false ) {
261 if ( substr($subfile, 0, 1) == '.' )
263 if ( substr($subfile, -4) == '.php' )
264 $plugin_files[] = "$file/$subfile";
266 closedir( $plugins_subdir );
269 if ( substr($file, -4) == '.php' )
270 $plugin_files[] = $file;
273 closedir( $plugins_dir );
276 if ( empty($plugin_files) )
279 foreach ( $plugin_files as $plugin_file ) {
280 if ( !is_readable( "$plugin_root/$plugin_file" ) )
283 $plugin_data = get_plugin_data( "$plugin_root/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
285 if ( empty ( $plugin_data['Name'] ) )
288 $wp_plugins[plugin_basename( $plugin_file )] = $plugin_data;
291 uasort( $wp_plugins, '_sort_uname_callback' );
293 $cache_plugins[ $plugin_folder ] = $wp_plugins;
294 wp_cache_set('plugins', $cache_plugins, 'plugins');
300 * Check the mu-plugins directory and retrieve all mu-plugin files with any plugin data.
302 * WordPress only includes mu-plugin files in the base mu-plugins directory (wp-content/mu-plugins).
305 * @return array Key is the mu-plugin file path and the value is an array of the mu-plugin data.
307 function get_mu_plugins() {
308 $wp_plugins = array();
309 // Files in wp-content/mu-plugins directory
310 $plugin_files = array();
312 if ( ! is_dir( WPMU_PLUGIN_DIR ) )
314 if ( $plugins_dir = @ opendir( WPMU_PLUGIN_DIR ) ) {
315 while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
316 if ( substr( $file, -4 ) == '.php' )
317 $plugin_files[] = $file;
323 @closedir( $plugins_dir );
325 if ( empty($plugin_files) )
328 foreach ( $plugin_files as $plugin_file ) {
329 if ( !is_readable( WPMU_PLUGIN_DIR . "/$plugin_file" ) )
332 $plugin_data = get_plugin_data( WPMU_PLUGIN_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
334 if ( empty ( $plugin_data['Name'] ) )
335 $plugin_data['Name'] = $plugin_file;
337 $wp_plugins[ $plugin_file ] = $plugin_data;
340 if ( isset( $wp_plugins['index.php'] ) && filesize( WPMU_PLUGIN_DIR . '/index.php') <= 30 ) // silence is golden
341 unset( $wp_plugins['index.php'] );
343 uasort( $wp_plugins, '_sort_uname_callback' );
349 * Callback to sort array by a 'Name' key.
354 function _sort_uname_callback( $a, $b ) {
355 return strnatcasecmp( $a['Name'], $b['Name'] );
359 * Check the wp-content directory and retrieve all drop-ins with any plugin data.
362 * @return array Key is the file path and the value is an array of the plugin data.
364 function get_dropins() {
366 $plugin_files = array();
368 $_dropins = _get_dropins();
370 // These exist in the wp-content directory
371 if ( $plugins_dir = @ opendir( WP_CONTENT_DIR ) ) {
372 while ( ( $file = readdir( $plugins_dir ) ) !== false ) {
373 if ( isset( $_dropins[ $file ] ) )
374 $plugin_files[] = $file;
380 @closedir( $plugins_dir );
382 if ( empty($plugin_files) )
385 foreach ( $plugin_files as $plugin_file ) {
386 if ( !is_readable( WP_CONTENT_DIR . "/$plugin_file" ) )
388 $plugin_data = get_plugin_data( WP_CONTENT_DIR . "/$plugin_file", false, false ); //Do not apply markup/translate as it'll be cached.
389 if ( empty( $plugin_data['Name'] ) )
390 $plugin_data['Name'] = $plugin_file;
391 $dropins[ $plugin_file ] = $plugin_data;
394 uksort( $dropins, 'strnatcasecmp' );
400 * Returns drop-ins that WordPress uses.
402 * Includes Multisite drop-ins only when is_multisite()
405 * @return array Key is file name. The value is an array, with the first value the
406 * purpose of the drop-in and the second value the name of the constant that must be
407 * true for the drop-in to be used, or true if no constant is required.
409 function _get_dropins() {
411 'advanced-cache.php' => array( __( 'Advanced caching plugin.' ), 'WP_CACHE' ), // WP_CACHE
412 'db.php' => array( __( 'Custom database class.' ), true ), // auto on load
413 'db-error.php' => array( __( 'Custom database error message.' ), true ), // auto on error
414 'install.php' => array( __( 'Custom install script.' ), true ), // auto on install
415 'maintenance.php' => array( __( 'Custom maintenance message.' ), true ), // auto on maintenance
416 'object-cache.php' => array( __( 'External object cache.' ), true ), // auto on load
419 if ( is_multisite() ) {
420 $dropins['sunrise.php' ] = array( __( 'Executed before Multisite is loaded.' ), 'SUNRISE' ); // SUNRISE
421 $dropins['blog-deleted.php' ] = array( __( 'Custom site deleted message.' ), true ); // auto on deleted blog
422 $dropins['blog-inactive.php' ] = array( __( 'Custom site inactive message.' ), true ); // auto on inactive blog
423 $dropins['blog-suspended.php'] = array( __( 'Custom site suspended message.' ), true ); // auto on archived or spammed blog
430 * Check whether the plugin is active by checking the active_plugins list.
434 * @param string $plugin Base plugin path from plugins directory.
435 * @return bool True, if in the active plugins list. False, not in the list.
437 function is_plugin_active( $plugin ) {
438 return in_array( $plugin, (array) get_option( 'active_plugins', array() ) ) || is_plugin_active_for_network( $plugin );
442 * Check whether the plugin is inactive.
444 * Reverse of is_plugin_active(). Used as a callback.
447 * @see is_plugin_active()
449 * @param string $plugin Base plugin path from plugins directory.
450 * @return bool True if inactive. False if active.
452 function is_plugin_inactive( $plugin ) {
453 return ! is_plugin_active( $plugin );
457 * Check whether the plugin is active for the entire network.
461 * @param string $plugin Base plugin path from plugins directory.
462 * @return bool True, if active for the network, otherwise false.
464 function is_plugin_active_for_network( $plugin ) {
465 if ( !is_multisite() )
468 $plugins = get_site_option( 'active_sitewide_plugins');
469 if ( isset($plugins[$plugin]) )
476 * Checks for "Network: true" in the plugin header to see if this should
477 * be activated only as a network wide plugin. The plugin would also work
478 * when Multisite is not enabled.
480 * Checks for "Site Wide Only: true" for backwards compatibility.
484 * @param string $plugin Plugin to check
485 * @return bool True if plugin is network only, false otherwise.
487 function is_network_only_plugin( $plugin ) {
488 $plugin_data = get_plugin_data( WP_PLUGIN_DIR . '/' . $plugin );
490 return $plugin_data['Network'];
495 * Attempts activation of plugin in a "sandbox" and redirects on success.
497 * A plugin that is already activated will not attempt to be activated again.
499 * The way it works is by setting the redirection to the error before trying to
500 * include the plugin file. If the plugin fails, then the redirection will not
501 * be overwritten with the success message. Also, the options will not be
502 * updated and the activation hook will not be called on plugin error.
504 * It should be noted that in no way the below code will actually prevent errors
505 * within the file. The code should not be used elsewhere to replicate the
506 * "sandbox", which uses redirection to work.
509 * If any errors are found or text is outputted, then it will be captured to
510 * ensure that the success redirection will update the error redirection.
514 * @param string $plugin Plugin path to main plugin file with plugin data.
515 * @param string $redirect Optional. URL to redirect to.
516 * @param bool $network_wide Whether to enable the plugin for all sites in the
517 * network or just the current site. Multisite only. Default is false.
518 * @param bool $silent Prevent calling activation hooks. Optional, default is false.
519 * @return WP_Error|null WP_Error on invalid file or null on success.
521 function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {
522 $plugin = plugin_basename( trim( $plugin ) );
524 if ( is_multisite() && ( $network_wide || is_network_only_plugin($plugin) ) ) {
525 $network_wide = true;
526 $current = get_site_option( 'active_sitewide_plugins', array() );
527 $_GET['networkwide'] = 1; // Back compat for plugins looking for this value.
529 $current = get_option( 'active_plugins', array() );
532 $valid = validate_plugin($plugin);
533 if ( is_wp_error($valid) )
536 if ( ( $network_wide && ! isset( $current[ $plugin ] ) ) || ( ! $network_wide && ! in_array( $plugin, $current ) ) ) {
537 if ( !empty($redirect) )
538 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
540 wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
541 $_wp_plugin_file = $plugin;
542 include_once( WP_PLUGIN_DIR . '/' . $plugin );
543 $plugin = $_wp_plugin_file; // Avoid stomping of the $plugin variable in a plugin.
547 * Fires before a plugin is activated.
549 * If a plugin is silently activated (such as during an update),
550 * this hook does not fire.
554 * @param string $plugin Plugin path to main plugin file with plugin data.
555 * @param bool $network_wide Whether to enable the plugin for all sites in the network
556 * or just the current site. Multisite only. Default is false.
558 do_action( 'activate_plugin', $plugin, $network_wide );
561 * Fires as a specific plugin is being activated.
563 * This hook is the "activation" hook used internally by
564 * {@see register_activation_hook()}. The dynamic portion of the
565 * hook name, `$plugin`, refers to the plugin basename.
567 * If a plugin is silently activated (such as during an update),
568 * this hook does not fire.
572 * @param bool $network_wide Whether to enable the plugin for all sites in the network
573 * or just the current site. Multisite only. Default is false.
575 do_action( 'activate_' . $plugin, $network_wide );
578 if ( $network_wide ) {
579 $current[$plugin] = time();
580 update_site_option( 'active_sitewide_plugins', $current );
582 $current[] = $plugin;
584 update_option('active_plugins', $current);
589 * Fires after a plugin has been activated.
591 * If a plugin is silently activated (such as during an update),
592 * this hook does not fire.
596 * @param string $plugin Plugin path to main plugin file with plugin data.
597 * @param bool $network_wide Whether to enable the plugin for all sites in the network
598 * or just the current site. Multisite only. Default is false.
600 do_action( 'activated_plugin', $plugin, $network_wide );
603 if ( ob_get_length() > 0 ) {
604 $output = ob_get_clean();
605 return new WP_Error('unexpected_output', __('The plugin generated unexpected output.'), $output);
614 * Deactivate a single plugin or multiple plugins.
616 * The deactivation hook is disabled by the plugin upgrader by using the $silent
621 * @param string|array $plugins Single plugin or list of plugins to deactivate.
622 * @param bool $silent Prevent calling deactivation hooks. Default is false.
623 * @param mixed $network_wide Whether to deactivate the plugin for all sites in the network.
624 * A value of null (the default) will deactivate plugins for both the site and the network.
626 function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
627 if ( is_multisite() )
628 $network_current = get_site_option( 'active_sitewide_plugins', array() );
629 $current = get_option( 'active_plugins', array() );
630 $do_blog = $do_network = false;
632 foreach ( (array) $plugins as $plugin ) {
633 $plugin = plugin_basename( trim( $plugin ) );
634 if ( ! is_plugin_active($plugin) )
637 $network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
641 * Fires before a plugin is deactivated.
643 * If a plugin is silently deactivated (such as during an update),
644 * this hook does not fire.
648 * @param string $plugin Plugin path to main plugin file with plugin data.
649 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
650 * or just the current site. Multisite only. Default is false.
652 do_action( 'deactivate_plugin', $plugin, $network_deactivating );
655 if ( false !== $network_wide ) {
656 if ( is_plugin_active_for_network( $plugin ) ) {
658 unset( $network_current[ $plugin ] );
659 } elseif ( $network_wide ) {
664 if ( true !== $network_wide ) {
665 $key = array_search( $plugin, $current );
666 if ( false !== $key ) {
668 unset( $current[ $key ] );
674 * Fires as a specific plugin is being deactivated.
676 * This hook is the "deactivation" hook used internally by
677 * {@see register_deactivation_hook()}. The dynamic portion of the
678 * hook name, `$plugin`, refers to the plugin basename.
680 * If a plugin is silently deactivated (such as during an update),
681 * this hook does not fire.
685 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
686 * or just the current site. Multisite only. Default is false.
688 do_action( 'deactivate_' . $plugin, $network_deactivating );
691 * Fires after a plugin is deactivated.
693 * If a plugin is silently deactivated (such as during an update),
694 * this hook does not fire.
698 * @param string $plugin Plugin basename.
699 * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
700 * or just the current site. Multisite only. Default false.
702 do_action( 'deactivated_plugin', $plugin, $network_deactivating );
707 update_option('active_plugins', $current);
709 update_site_option( 'active_sitewide_plugins', $network_current );
713 * Activate multiple plugins.
715 * When WP_Error is returned, it does not mean that one of the plugins had
716 * errors. It means that one or more of the plugins file path was invalid.
718 * The execution will be halted as soon as one of the plugins has an error.
722 * @param string|array $plugins Single plugin or list of plugins to activate.
723 * @param string $redirect Redirect to page after successful activation.
724 * @param bool $network_wide Whether to enable the plugin for all sites in the network.
725 * @param bool $silent Prevent calling activation hooks. Default is false.
726 * @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
728 function activate_plugins( $plugins, $redirect = '', $network_wide = false, $silent = false ) {
729 if ( !is_array($plugins) )
730 $plugins = array($plugins);
733 foreach ( $plugins as $plugin ) {
734 if ( !empty($redirect) )
735 $redirect = add_query_arg('plugin', $plugin, $redirect);
736 $result = activate_plugin($plugin, $redirect, $network_wide, $silent);
737 if ( is_wp_error($result) )
738 $errors[$plugin] = $result;
741 if ( !empty($errors) )
742 return new WP_Error('plugins_invalid', __('One of the plugins is invalid.'), $errors);
748 * Remove directory and files of a plugin for a list of plugins.
752 * @param array $plugins List of plugins to delete.
753 * @param string $deprecated Deprecated.
754 * @return bool|null|WP_Error True on success, false is $plugins is empty, WP_Error on failure.
755 * Null if filesystem credentials are required to proceed.
757 function delete_plugins( $plugins, $deprecated = '' ) {
758 global $wp_filesystem;
760 if ( empty($plugins) )
764 foreach( $plugins as $plugin )
765 $checked[] = 'checked[]=' . $plugin;
768 $url = wp_nonce_url('plugins.php?action=delete-selected&verify-delete=1&' . implode('&', $checked), 'bulk-plugins');
769 if ( false === ($credentials = request_filesystem_credentials($url)) ) {
770 $data = ob_get_contents();
772 if ( ! empty($data) ){
773 include_once( ABSPATH . 'wp-admin/admin-header.php');
775 include( ABSPATH . 'wp-admin/admin-footer.php');
781 if ( ! WP_Filesystem($credentials) ) {
782 request_filesystem_credentials($url, '', true); //Failed to connect, Error and request again
783 $data = ob_get_contents();
785 if ( ! empty($data) ){
786 include_once( ABSPATH . 'wp-admin/admin-header.php');
788 include( ABSPATH . 'wp-admin/admin-footer.php');
794 if ( ! is_object($wp_filesystem) )
795 return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
797 if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
798 return new WP_Error('fs_error', __('Filesystem error.'), $wp_filesystem->errors);
800 // Get the base plugin folder.
801 $plugins_dir = $wp_filesystem->wp_plugins_dir();
802 if ( empty( $plugins_dir ) ) {
803 return new WP_Error( 'fs_no_plugins_dir', __( 'Unable to locate WordPress Plugin directory.' ) );
806 $plugins_dir = trailingslashit( $plugins_dir );
808 $translations_dir = $wp_filesystem->wp_lang_dir();
809 $translations_dir = trailingslashit( $translations_dir );
811 $plugin_translations = wp_get_installed_translations( 'plugins' );
815 foreach( $plugins as $plugin_file ) {
816 // Run Uninstall hook.
817 if ( is_uninstallable_plugin( $plugin_file ) ) {
818 uninstall_plugin($plugin_file);
821 $this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin_file ) );
822 // If plugin is in its own directory, recursively delete the directory.
823 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
824 $deleted = $wp_filesystem->delete( $this_plugin_dir, true );
826 $deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file );
830 $errors[] = $plugin_file;
834 // Remove language files, silently.
835 $plugin_slug = dirname( $plugin_file );
836 if ( '.' !== $plugin_slug && ! empty( $plugin_translations[ $plugin_slug ] ) ) {
837 $translations = $plugin_translations[ $plugin_slug ];
839 foreach ( $translations as $translation => $data ) {
840 $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' );
841 $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.mo' );
846 // Remove deleted plugins from the plugin updates list.
847 if ( $current = get_site_transient('update_plugins') ) {
848 // Don't remove the plugins that weren't deleted.
849 $deleted = array_diff( $plugins, $errors );
851 foreach ( $deleted as $plugin_file ) {
852 unset( $current->response[ $plugin_file ] );
855 set_site_transient( 'update_plugins', $current );
858 if ( ! empty($errors) )
859 return new WP_Error('could_not_remove_plugin', sprintf(__('Could not fully remove the plugin(s) %s.'), implode(', ', $errors)) );
865 * Validate active plugins
867 * Validate all active plugins, deactivates invalid and
868 * returns an array of deactivated ones.
871 * @return array invalid plugins, plugin as key, error as value
873 function validate_active_plugins() {
874 $plugins = get_option( 'active_plugins', array() );
875 // Validate vartype: array.
876 if ( ! is_array( $plugins ) ) {
877 update_option( 'active_plugins', array() );
881 if ( is_multisite() && current_user_can( 'manage_network_plugins' ) ) {
882 $network_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
883 $plugins = array_merge( $plugins, array_keys( $network_plugins ) );
886 if ( empty( $plugins ) )
891 // Invalid plugins get deactivated.
892 foreach ( $plugins as $plugin ) {
893 $result = validate_plugin( $plugin );
894 if ( is_wp_error( $result ) ) {
895 $invalid[$plugin] = $result;
896 deactivate_plugins( $plugin, true );
903 * Validate the plugin path.
905 * Checks that the file exists and {@link validate_file() is valid file}.
909 * @param string $plugin Plugin Path
910 * @return WP_Error|int 0 on success, WP_Error on failure.
912 function validate_plugin($plugin) {
913 if ( validate_file($plugin) )
914 return new WP_Error('plugin_invalid', __('Invalid plugin path.'));
915 if ( ! file_exists(WP_PLUGIN_DIR . '/' . $plugin) )
916 return new WP_Error('plugin_not_found', __('Plugin file does not exist.'));
918 $installed_plugins = get_plugins();
919 if ( ! isset($installed_plugins[$plugin]) )
920 return new WP_Error('no_plugin_header', __('The plugin does not have a valid header.'));
925 * Whether the plugin can be uninstalled.
929 * @param string $plugin Plugin path to check.
930 * @return bool Whether plugin can be uninstalled.
932 function is_uninstallable_plugin($plugin) {
933 $file = plugin_basename($plugin);
935 $uninstallable_plugins = (array) get_option('uninstall_plugins');
936 if ( isset( $uninstallable_plugins[$file] ) || file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) )
943 * Uninstall a single plugin.
945 * Calls the uninstall hook, if it is available.
949 * @param string $plugin Relative plugin path from Plugin Directory.
951 function uninstall_plugin($plugin) {
952 $file = plugin_basename($plugin);
954 $uninstallable_plugins = (array) get_option('uninstall_plugins');
955 if ( file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) ) {
956 if ( isset( $uninstallable_plugins[$file] ) ) {
957 unset($uninstallable_plugins[$file]);
958 update_option('uninstall_plugins', $uninstallable_plugins);
960 unset($uninstallable_plugins);
962 define('WP_UNINSTALL_PLUGIN', $file);
963 wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . dirname( $file ) );
964 include( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' );
969 if ( isset( $uninstallable_plugins[$file] ) ) {
970 $callable = $uninstallable_plugins[$file];
971 unset($uninstallable_plugins[$file]);
972 update_option('uninstall_plugins', $uninstallable_plugins);
973 unset($uninstallable_plugins);
975 wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );
976 include( WP_PLUGIN_DIR . '/' . $file );
978 add_action( 'uninstall_' . $file, $callable );
981 * Fires in uninstall_plugin() once the plugin has been uninstalled.
983 * The action concatenates the 'uninstall_' prefix with the basename of the
984 * plugin passed to {@see uninstall_plugin()} to create a dynamically-named action.
988 do_action( 'uninstall_' . $file );
997 * Add a top level menu page
999 * This function takes a capability which will be used to determine whether
1000 * or not a page is included in the menu.
1002 * The function which is hooked in to handle the output of the page must check
1003 * that the user has the required capability as well.
1005 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1006 * @param string $menu_title The text to be used for the menu
1007 * @param string $capability The capability required for this menu to be displayed to the user.
1008 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1009 * @param callback $function The function to be called to output the content for this page.
1010 * @param string $icon_url The url to the icon to be used for this menu.
1011 * * Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme.
1012 * This should begin with 'data:image/svg+xml;base64,'.
1013 * * Pass the name of a Dashicons helper class to use a font icon, e.g. 'dashicons-chart-pie'.
1014 * * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.
1015 * @param int $position The position in the menu order this one should appear
1017 * @return string The resulting page's hook_suffix
1019 function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null ) {
1020 global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;
1022 $menu_slug = plugin_basename( $menu_slug );
1024 $admin_page_hooks[$menu_slug] = sanitize_title( $menu_title );
1026 $hookname = get_plugin_page_hookname( $menu_slug, '' );
1028 if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
1029 add_action( $hookname, $function );
1031 if ( empty($icon_url) ) {
1032 $icon_url = 'dashicons-admin-generic';
1033 $icon_class = 'menu-icon-generic ';
1035 $icon_url = set_url_scheme( $icon_url );
1039 $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $icon_class . $hookname, $hookname, $icon_url );
1041 if ( null === $position )
1042 $menu[] = $new_menu;
1044 $menu[$position] = $new_menu;
1046 $_registered_pages[$hookname] = true;
1048 // No parent as top level
1049 $_parent_pages[$menu_slug] = false;
1055 * Add a top level menu page in the 'objects' section
1057 * This function takes a capability which will be used to determine whether
1058 * or not a page is included in the menu.
1060 * The function which is hooked in to handle the output of the page must check
1061 * that the user has the required capability as well.
1063 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1064 * @param string $menu_title The text to be used for the menu
1065 * @param string $capability The capability required for this menu to be displayed to the user.
1066 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1067 * @param callback $function The function to be called to output the content for this page.
1068 * @param string $icon_url The url to the icon to be used for this menu
1070 * @return string The resulting page's hook_suffix
1072 function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
1073 global $_wp_last_object_menu;
1075 $_wp_last_object_menu++;
1077 return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_object_menu);
1081 * Add a top level menu page in the 'utility' section
1083 * This function takes a capability which will be used to determine whether
1084 * or not a page is included in the menu.
1086 * The function which is hooked in to handle the output of the page must check
1087 * that the user has the required capability as well.
1089 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1090 * @param string $menu_title The text to be used for the menu
1091 * @param string $capability The capability required for this menu to be displayed to the user.
1092 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1093 * @param callback $function The function to be called to output the content for this page.
1094 * @param string $icon_url The url to the icon to be used for this menu
1096 * @return string The resulting page's hook_suffix
1098 function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
1099 global $_wp_last_utility_menu;
1101 $_wp_last_utility_menu++;
1103 return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_utility_menu);
1107 * Add a sub menu page
1109 * This function takes a capability which will be used to determine whether
1110 * or not a page is included in the menu.
1112 * The function which is hooked in to handle the output of the page must check
1113 * that the user has the required capability as well.
1115 * @param string $parent_slug The slug name for the parent menu (or the file name of a standard WordPress admin page)
1116 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1117 * @param string $menu_title The text to be used for the menu
1118 * @param string $capability The capability required for this menu to be displayed to the user.
1119 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1120 * @param callback $function The function to be called to output the content for this page.
1122 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1124 function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1127 global $_wp_real_parent_file;
1128 global $_wp_submenu_nopriv;
1129 global $_registered_pages;
1130 global $_parent_pages;
1132 $menu_slug = plugin_basename( $menu_slug );
1133 $parent_slug = plugin_basename( $parent_slug);
1135 if ( isset( $_wp_real_parent_file[$parent_slug] ) )
1136 $parent_slug = $_wp_real_parent_file[$parent_slug];
1138 if ( !current_user_can( $capability ) ) {
1139 $_wp_submenu_nopriv[$parent_slug][$menu_slug] = true;
1144 * If the parent doesn't already have a submenu, add a link to the parent
1145 * as the first item in the submenu. If the submenu file is the same as the
1146 * parent file someone is trying to link back to the parent manually. In
1147 * this case, don't automatically add a link back to avoid duplication.
1149 if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug ) {
1150 foreach ( (array)$menu as $parent_menu ) {
1151 if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) )
1152 $submenu[$parent_slug][] = array_slice( $parent_menu, 0, 4 );
1156 $submenu[$parent_slug][] = array ( $menu_title, $capability, $menu_slug, $page_title );
1158 $hookname = get_plugin_page_hookname( $menu_slug, $parent_slug);
1159 if (!empty ( $function ) && !empty ( $hookname ))
1160 add_action( $hookname, $function );
1162 $_registered_pages[$hookname] = true;
1165 * Backward-compatibility for plugins using add_management page.
1166 * See wp-admin/admin.php for redirect from edit.php to tools.php
1168 if ( 'tools.php' == $parent_slug )
1169 $_registered_pages[get_plugin_page_hookname( $menu_slug, 'edit.php')] = true;
1171 // No parent as top level.
1172 $_parent_pages[$menu_slug] = $parent_slug;
1178 * Add sub menu page to the tools main menu.
1180 * This function takes a capability which will be used to determine whether
1181 * or not a page is included in the menu.
1183 * The function which is hooked in to handle the output of the page must check
1184 * that the user has the required capability as well.
1186 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1187 * @param string $menu_title The text to be used for the menu
1188 * @param string $capability The capability required for this menu to be displayed to the user.
1189 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1190 * @param callback $function The function to be called to output the content for this page.
1192 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1194 function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1195 return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1199 * Add sub menu page to the options main menu.
1201 * This function takes a capability which will be used to determine whether
1202 * or not a page is included in the menu.
1204 * The function which is hooked in to handle the output of the page must check
1205 * that the user has the required capability as well.
1207 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1208 * @param string $menu_title The text to be used for the menu
1209 * @param string $capability The capability required for this menu to be displayed to the user.
1210 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1211 * @param callback $function The function to be called to output the content for this page.
1213 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1215 function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1216 return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1220 * Add sub menu page to the themes main menu.
1222 * This function takes a capability which will be used to determine whether
1223 * or not a page is included in the menu.
1225 * The function which is hooked in to handle the output of the page must check
1226 * that the user has the required capability as well.
1228 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1229 * @param string $menu_title The text to be used for the menu
1230 * @param string $capability The capability required for this menu to be displayed to the user.
1231 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1232 * @param callback $function The function to be called to output the content for this page.
1234 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1236 function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1237 return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1241 * Add sub menu page to the plugins main menu.
1243 * This function takes a capability which will be used to determine whether
1244 * or not a page is included in the menu.
1246 * The function which is hooked in to handle the output of the page must check
1247 * that the user has the required capability as well.
1249 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1250 * @param string $menu_title The text to be used for the menu
1251 * @param string $capability The capability required for this menu to be displayed to the user.
1252 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1253 * @param callback $function The function to be called to output the content for this page.
1255 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1257 function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1258 return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1262 * Add sub menu page to the Users/Profile main menu.
1264 * This function takes a capability which will be used to determine whether
1265 * or not a page is included in the menu.
1267 * The function which is hooked in to handle the output of the page must check
1268 * that the user has the required capability as well.
1270 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1271 * @param string $menu_title The text to be used for the menu
1272 * @param string $capability The capability required for this menu to be displayed to the user.
1273 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1274 * @param callback $function The function to be called to output the content for this page.
1276 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1278 function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1279 if ( current_user_can('edit_users') )
1280 $parent = 'users.php';
1282 $parent = 'profile.php';
1283 return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function );
1286 * Add sub menu page to the Dashboard main menu.
1288 * This function takes a capability which will be used to determine whether
1289 * or not a page is included in the menu.
1291 * The function which is hooked in to handle the output of the page must check
1292 * that the user has the required capability as well.
1294 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1295 * @param string $menu_title The text to be used for the menu
1296 * @param string $capability The capability required for this menu to be displayed to the user.
1297 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1298 * @param callback $function The function to be called to output the content for this page.
1300 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1302 function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1303 return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1307 * Add sub menu page to the posts main menu.
1309 * This function takes a capability which will be used to determine whether
1310 * or not a page is included in the menu.
1312 * The function which is hooked in to handle the output of the page must check
1313 * that the user has the required capability as well.
1315 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1316 * @param string $menu_title The text to be used for the menu
1317 * @param string $capability The capability required for this menu to be displayed to the user.
1318 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1319 * @param callback $function The function to be called to output the content for this page.
1321 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1323 function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1324 return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1328 * Add sub menu page to the media main menu.
1330 * This function takes a capability which will be used to determine whether
1331 * or not a page is included in the menu.
1333 * The function which is hooked in to handle the output of the page must check
1334 * that the user has the required capability as well.
1336 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1337 * @param string $menu_title The text to be used for the menu
1338 * @param string $capability The capability required for this menu to be displayed to the user.
1339 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1340 * @param callback $function The function to be called to output the content for this page.
1342 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1344 function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1345 return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1349 * Add sub menu page to the links main menu.
1351 * This function takes a capability which will be used to determine whether
1352 * or not a page is included in the menu.
1354 * The function which is hooked in to handle the output of the page must check
1355 * that the user has the required capability as well.
1357 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1358 * @param string $menu_title The text to be used for the menu
1359 * @param string $capability The capability required for this menu to be displayed to the user.
1360 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1361 * @param callback $function The function to be called to output the content for this page.
1363 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1365 function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1366 return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1370 * Add sub menu page to the pages main menu.
1372 * This function takes a capability which will be used to determine whether
1373 * or not a page is included in the menu.
1375 * The function which is hooked in to handle the output of the page must check
1376 * that the user has the required capability as well.
1378 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1379 * @param string $menu_title The text to be used for the menu
1380 * @param string $capability The capability required for this menu to be displayed to the user.
1381 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1382 * @param callback $function The function to be called to output the content for this page.
1384 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1386 function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1387 return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
1391 * Add sub menu page to the comments main menu.
1393 * This function takes a capability which will be used to determine whether
1394 * or not a page is included in the menu.
1396 * The function which is hooked in to handle the output of the page must check
1397 * that the user has the required capability as well.
1399 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1400 * @param string $menu_title The text to be used for the menu
1401 * @param string $capability The capability required for this menu to be displayed to the user.
1402 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1403 * @param callback $function The function to be called to output the content for this page.
1405 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1407 function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1408 return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1412 * Remove a top level admin menu
1416 * @param string $menu_slug The slug of the menu
1417 * @return array|bool The removed menu on success, False if not found
1419 function remove_menu_page( $menu_slug ) {
1422 foreach ( $menu as $i => $item ) {
1423 if ( $menu_slug == $item[2] ) {
1433 * Remove an admin submenu
1437 * @param string $menu_slug The slug for the parent menu
1438 * @param string $submenu_slug The slug of the submenu
1439 * @return array|bool The removed submenu on success, False if not found
1441 function remove_submenu_page( $menu_slug, $submenu_slug ) {
1444 if ( !isset( $submenu[$menu_slug] ) )
1447 foreach ( $submenu[$menu_slug] as $i => $item ) {
1448 if ( $submenu_slug == $item[2] ) {
1449 unset( $submenu[$menu_slug][$i] );
1458 * Get the url to access a particular menu page based on the slug it was registered with.
1460 * If the slug hasn't been registered properly no url will be returned
1464 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1465 * @param bool $echo Whether or not to echo the url - default is true
1466 * @return string the url
1468 function menu_page_url($menu_slug, $echo = true) {
1469 global $_parent_pages;
1471 if ( isset( $_parent_pages[$menu_slug] ) ) {
1472 $parent_slug = $_parent_pages[$menu_slug];
1473 if ( $parent_slug && ! isset( $_parent_pages[$parent_slug] ) ) {
1474 $url = admin_url( add_query_arg( 'page', $menu_slug, $parent_slug ) );
1476 $url = admin_url( 'admin.php?page=' . $menu_slug );
1482 $url = esc_url($url);
1491 // Pluggable Menu Support -- Private
1494 function get_admin_page_parent( $parent = '' ) {
1495 global $parent_file;
1500 global $plugin_page;
1501 global $_wp_real_parent_file;
1502 global $_wp_menu_nopriv;
1503 global $_wp_submenu_nopriv;
1505 if ( !empty ( $parent ) && 'admin.php' != $parent ) {
1506 if ( isset( $_wp_real_parent_file[$parent] ) )
1507 $parent = $_wp_real_parent_file[$parent];
1511 if ( $pagenow == 'admin.php' && isset( $plugin_page ) ) {
1512 foreach ( (array)$menu as $parent_menu ) {
1513 if ( $parent_menu[2] == $plugin_page ) {
1514 $parent_file = $plugin_page;
1515 if ( isset( $_wp_real_parent_file[$parent_file] ) )
1516 $parent_file = $_wp_real_parent_file[$parent_file];
1517 return $parent_file;
1520 if ( isset( $_wp_menu_nopriv[$plugin_page] ) ) {
1521 $parent_file = $plugin_page;
1522 if ( isset( $_wp_real_parent_file[$parent_file] ) )
1523 $parent_file = $_wp_real_parent_file[$parent_file];
1524 return $parent_file;
1528 if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$pagenow][$plugin_page] ) ) {
1529 $parent_file = $pagenow;
1530 if ( isset( $_wp_real_parent_file[$parent_file] ) )
1531 $parent_file = $_wp_real_parent_file[$parent_file];
1532 return $parent_file;
1535 foreach (array_keys( (array)$submenu ) as $parent) {
1536 foreach ( $submenu[$parent] as $submenu_array ) {
1537 if ( isset( $_wp_real_parent_file[$parent] ) )
1538 $parent = $_wp_real_parent_file[$parent];
1539 if ( !empty($typenow) && ($submenu_array[2] == "$pagenow?post_type=$typenow") ) {
1540 $parent_file = $parent;
1542 } elseif ( $submenu_array[2] == $pagenow && empty($typenow) && ( empty($parent_file) || false === strpos($parent_file, '?') ) ) {
1543 $parent_file = $parent;
1546 if ( isset( $plugin_page ) && ($plugin_page == $submenu_array[2] ) ) {
1547 $parent_file = $parent;
1553 if ( empty($parent_file) )
1558 function get_admin_page_title() {
1563 global $plugin_page;
1566 if ( ! empty ( $title ) )
1569 $hook = get_plugin_page_hook( $plugin_page, $pagenow );
1571 $parent = $parent1 = get_admin_page_parent();
1573 if ( empty ( $parent) ) {
1574 foreach ( (array)$menu as $menu_array ) {
1575 if ( isset( $menu_array[3] ) ) {
1576 if ( $menu_array[2] == $pagenow ) {
1577 $title = $menu_array[3];
1578 return $menu_array[3];
1580 if ( isset( $plugin_page ) && ($plugin_page == $menu_array[2] ) && ($hook == $menu_array[3] ) ) {
1581 $title = $menu_array[3];
1582 return $menu_array[3];
1585 $title = $menu_array[0];
1590 foreach ( array_keys( $submenu ) as $parent ) {
1591 foreach ( $submenu[$parent] as $submenu_array ) {
1592 if ( isset( $plugin_page ) &&
1593 ( $plugin_page == $submenu_array[2] ) &&
1595 ( $parent == $pagenow ) ||
1596 ( $parent == $plugin_page ) ||
1597 ( $plugin_page == $hook ) ||
1598 ( $pagenow == 'admin.php' && $parent1 != $submenu_array[2] ) ||
1599 ( !empty($typenow) && $parent == $pagenow . '?post_type=' . $typenow)
1602 $title = $submenu_array[3];
1603 return $submenu_array[3];
1606 if ( $submenu_array[2] != $pagenow || isset( $_GET['page'] ) ) // not the current page
1609 if ( isset( $submenu_array[3] ) ) {
1610 $title = $submenu_array[3];
1611 return $submenu_array[3];
1613 $title = $submenu_array[0];
1618 if ( empty ( $title ) ) {
1619 foreach ( $menu as $menu_array ) {
1620 if ( isset( $plugin_page ) &&
1621 ( $plugin_page == $menu_array[2] ) &&
1622 ( $pagenow == 'admin.php' ) &&
1623 ( $parent1 == $menu_array[2] ) )
1625 $title = $menu_array[3];
1626 return $menu_array[3];
1635 function get_plugin_page_hook( $plugin_page, $parent_page ) {
1636 $hook = get_plugin_page_hookname( $plugin_page, $parent_page );
1637 if ( has_action($hook) )
1643 function get_plugin_page_hookname( $plugin_page, $parent_page ) {
1644 global $admin_page_hooks;
1646 $parent = get_admin_page_parent( $parent_page );
1648 $page_type = 'admin';
1649 if ( empty ( $parent_page ) || 'admin.php' == $parent_page || isset( $admin_page_hooks[$plugin_page] ) ) {
1650 if ( isset( $admin_page_hooks[$plugin_page] ) )
1651 $page_type = 'toplevel';
1653 if ( isset( $admin_page_hooks[$parent] ))
1654 $page_type = $admin_page_hooks[$parent];
1655 } else if ( isset( $admin_page_hooks[$parent] ) ) {
1656 $page_type = $admin_page_hooks[$parent];
1659 $plugin_name = preg_replace( '!\.php!', '', $plugin_page );
1661 return $page_type . '_page_' . $plugin_name;
1664 function user_can_access_admin_page() {
1668 global $_wp_menu_nopriv;
1669 global $_wp_submenu_nopriv;
1670 global $plugin_page;
1671 global $_registered_pages;
1673 $parent = get_admin_page_parent();
1675 if ( !isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$parent][$pagenow] ) )
1678 if ( isset( $plugin_page ) ) {
1679 if ( isset( $_wp_submenu_nopriv[$parent][$plugin_page] ) )
1682 $hookname = get_plugin_page_hookname($plugin_page, $parent);
1684 if ( !isset($_registered_pages[$hookname]) )
1688 if ( empty( $parent) ) {
1689 if ( isset( $_wp_menu_nopriv[$pagenow] ) )
1691 if ( isset( $_wp_submenu_nopriv[$pagenow][$pagenow] ) )
1693 if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$pagenow][$plugin_page] ) )
1695 if ( isset( $plugin_page ) && isset( $_wp_menu_nopriv[$plugin_page] ) )
1697 foreach (array_keys( $_wp_submenu_nopriv ) as $key ) {
1698 if ( isset( $_wp_submenu_nopriv[$key][$pagenow] ) )
1700 if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$key][$plugin_page] ) )
1706 if ( isset( $plugin_page ) && ( $plugin_page == $parent ) && isset( $_wp_menu_nopriv[$plugin_page] ) )
1709 if ( isset( $submenu[$parent] ) ) {
1710 foreach ( $submenu[$parent] as $submenu_array ) {
1711 if ( isset( $plugin_page ) && ( $submenu_array[2] == $plugin_page ) ) {
1712 if ( current_user_can( $submenu_array[1] ))
1716 } else if ( $submenu_array[2] == $pagenow ) {
1717 if ( current_user_can( $submenu_array[1] ))
1725 foreach ( $menu as $menu_array ) {
1726 if ( $menu_array[2] == $parent) {
1727 if ( current_user_can( $menu_array[1] ))
1737 /* Whitelist functions */
1740 * Register a setting and its sanitization callback
1744 * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
1745 * Default whitelisted option key names include "general," "discussion," and "reading," among others.
1746 * @param string $option_name The name of an option to sanitize and save.
1747 * @param callable $sanitize_callback A callback function that sanitizes the option's value.
1749 function register_setting( $option_group, $option_name, $sanitize_callback = '' ) {
1750 global $new_whitelist_options;
1752 if ( 'misc' == $option_group ) {
1753 _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
1754 $option_group = 'general';
1757 if ( 'privacy' == $option_group ) {
1758 _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
1759 $option_group = 'reading';
1762 $new_whitelist_options[ $option_group ][] = $option_name;
1763 if ( $sanitize_callback != '' )
1764 add_filter( "sanitize_option_{$option_name}", $sanitize_callback );
1768 * Unregister a setting
1772 * @param string $option_group
1773 * @param string $option_name
1774 * @param callable $sanitize_callback
1776 function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) {
1777 global $new_whitelist_options;
1779 if ( 'misc' == $option_group ) {
1780 _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
1781 $option_group = 'general';
1784 if ( 'privacy' == $option_group ) {
1785 _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
1786 $option_group = 'reading';
1789 $pos = array_search( $option_name, (array) $new_whitelist_options );
1790 if ( $pos !== false )
1791 unset( $new_whitelist_options[ $option_group ][ $pos ] );
1792 if ( $sanitize_callback != '' )
1793 remove_filter( "sanitize_option_{$option_name}", $sanitize_callback );
1797 * {@internal Missing Short Description}}
1801 * @param array $options
1804 function option_update_filter( $options ) {
1805 global $new_whitelist_options;
1807 if ( is_array( $new_whitelist_options ) )
1808 $options = add_option_whitelist( $new_whitelist_options, $options );
1812 add_filter( 'whitelist_options', 'option_update_filter' );
1815 * {@internal Missing Short Description}}
1819 * @param array $new_options
1820 * @param string|array $options
1823 function add_option_whitelist( $new_options, $options = '' ) {
1824 if ( $options == '' )
1825 global $whitelist_options;
1827 $whitelist_options = $options;
1829 foreach ( $new_options as $page => $keys ) {
1830 foreach ( $keys as $key ) {
1831 if ( !isset($whitelist_options[ $page ]) || !is_array($whitelist_options[ $page ]) ) {
1832 $whitelist_options[ $page ] = array();
1833 $whitelist_options[ $page ][] = $key;
1835 $pos = array_search( $key, $whitelist_options[ $page ] );
1836 if ( $pos === false )
1837 $whitelist_options[ $page ][] = $key;
1842 return $whitelist_options;
1846 * {@internal Missing Short Description}}
1850 * @param array $del_options
1851 * @param string|array $options
1854 function remove_option_whitelist( $del_options, $options = '' ) {
1855 if ( $options == '' )
1856 global $whitelist_options;
1858 $whitelist_options = $options;
1860 foreach ( $del_options as $page => $keys ) {
1861 foreach ( $keys as $key ) {
1862 if ( isset($whitelist_options[ $page ]) && is_array($whitelist_options[ $page ]) ) {
1863 $pos = array_search( $key, $whitelist_options[ $page ] );
1864 if ( $pos !== false )
1865 unset( $whitelist_options[ $page ][ $pos ] );
1870 return $whitelist_options;
1874 * Output nonce, action, and option_page fields for a settings page.
1878 * @param string $option_group A settings group name. This should match the group name used in register_setting().
1880 function settings_fields($option_group) {
1881 echo "<input type='hidden' name='option_page' value='" . esc_attr($option_group) . "' />";
1882 echo '<input type="hidden" name="action" value="update" />';
1883 wp_nonce_field("$option_group-options");
1887 * Clears the Plugins cache used by get_plugins() and by default, the Plugin Update cache.
1891 * @param bool $clear_update_cache Whether to clear the Plugin updates cache
1893 function wp_clean_plugins_cache( $clear_update_cache = true ) {
1894 if ( $clear_update_cache )
1895 delete_site_transient( 'update_plugins' );
1896 wp_cache_delete( 'plugins', 'plugins' );