Make WordPress Core

source: trunk/src/wp-admin/includes/plugin.php @ 35495

Last change on this file since 35495 was 35495, checked in by DrewAPicture, 7 years ago

Docs: Fix two notations for the $_wp_real_parent_file global, which is an array.

Props NExt-Season.
Fixes #34443.

  • Property svn:eol-style set to native
File size: 67.2 KB
Line 
1<?php
2/**
3 * WordPress Plugin Administration API
4 *
5 * @package WordPress
6 * @subpackage Administration
7 */
8
9/**
10 * Parses 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 *     /*
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 *              load_plugin_textdomain()
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
30 *              located in.
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
35 *
36 * Some users have issues with opening large files and manipulating the contents
37 * for want is usually the first 1kiB or 2kiB. This function stops pulling in
38 * the plugin contents when it has all of the required plugin data.
39 *
40 * The first 8kiB of the file will be pulled in and if the plugin data is not
41 * within that first 8kiB, then the plugin author should correct their plugin
42 * and move the plugin data headers to the top.
43 *
44 * The plugin file is assumed to have permissions to allow for scripts to read
45 * the file. This is not checked however and the file is only opened for
46 * reading.
47 *
48 * @since 1.5.0
49 *
50 * @param string $plugin_file Path to the plugin file
51 * @param bool   $markup      Optional. If the returned data should have HTML markup applied.
52 *                            Default true.
53 * @param bool   $translate   Optional. If the returned data should be translated. Default true.
54 * @return array {
55 *     Plugin data. Values will be empty if not supplied by the plugin.
56 *
57 *     @type string $Name        Name of the plugin. Should be unique.
58 *     @type string $Title       Title of the plugin and link to the plugin's site (if set).
59 *     @type string $Description Plugin description.
60 *     @type string $Author      Author's name.
61 *     @type string $AuthorURI   Author's website address (if set).
62 *     @type string $Version     Plugin version.
63 *     @type string $TextDomain  Plugin textdomain.
64 *     @type string $DomainPath  Plugins relative directory path to .mo files.
65 *     @type bool   $Network     Whether the plugin can only be activated network-wide.
66 * }
67 */
68function get_plugin_data( $plugin_file, $markup = true, $translate = true ) {
69
70        $default_headers = array(
71                'Name' => 'Plugin Name',
72                'PluginURI' => 'Plugin URI',
73                'Version' => 'Version',
74                'Description' => 'Description',
75                'Author' => 'Author',
76                'AuthorURI' => 'Author URI',
77                'TextDomain' => 'Text Domain',
78                'DomainPath' => 'Domain Path',
79                'Network' => 'Network',
80                // Site Wide Only is deprecated in favor of Network.
81                '_sitewide' => 'Site Wide Only',
82        );
83
84        $plugin_data = get_file_data( $plugin_file, $default_headers, 'plugin' );
85
86        // Site Wide Only is the old header for Network
87        if ( ! $plugin_data['Network'] && $plugin_data['_sitewide'] ) {
88                /* translators: 1: Site Wide Only: true, 2: Network: true */
89                _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The %1$s plugin header is deprecated. Use %2$s instead.' ), '<code>Site Wide Only: true</code>', '<code>Network: true</code>' ) );
90                $plugin_data['Network'] = $plugin_data['_sitewide'];
91        }
92        $plugin_data['Network'] = ( 'true' == strtolower( $plugin_data['Network'] ) );
93        unset( $plugin_data['_sitewide'] );
94
95        if ( $markup || $translate ) {
96                $plugin_data = _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup, $translate );
97        } else {
98                $plugin_data['Title']      = $plugin_data['Name'];
99                $plugin_data['AuthorName'] = $plugin_data['Author'];
100        }
101
102        return $plugin_data;
103}
104
105/**
106 * Sanitizes plugin data, optionally adds markup, optionally translates.
107 *
108 * @since 2.7.0
109 * @access private
110 * @see get_plugin_data()
111 */
112function _get_plugin_data_markup_translate( $plugin_file, $plugin_data, $markup = true, $translate = true ) {
113
114        // Sanitize the plugin filename to a WP_PLUGIN_DIR relative path
115        $plugin_file = plugin_basename( $plugin_file );
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'] . '">' . $plugin_data['Name'] . '</a>';
161
162                if ( $plugin_data['AuthorURI'] && $plugin_data['Author'] )
163                        $plugin_data['Author'] = '<a href="' . $plugin_data['AuthorURI'] . '">' . $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 */
182function 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
220 * and must be found in those two locations. It is recommended to keep your
221 * plugin files in their own 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 */
234function 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 */
304function 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 */
351function _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 */
361function 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 */
406function _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 */
434function 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 */
449function 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 */
461function 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 */
484function 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 */
518function 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 ( ( $network_wide && ! isset( $current[ $plugin ] ) ) || ( ! $network_wide && ! 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                wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
538                $_wp_plugin_file = $plugin;
539                include_once( WP_PLUGIN_DIR . '/' . $plugin );
540                $plugin = $_wp_plugin_file; // Avoid stomping of the $plugin variable in a plugin.
541
542                if ( ! $silent ) {
543                        /**
544                         * Fires before a plugin is activated.
545                         *
546                         * If a plugin is silently activated (such as during an update),
547                         * this hook does not fire.
548                         *
549                         * @since 2.9.0
550                         *
551                         * @param string $plugin       Plugin path to main plugin file with plugin data.
552                         * @param bool   $network_wide Whether to enable the plugin for all sites in the network
553                         *                             or just the current site. Multisite only. Default is false.
554                         */
555                        do_action( 'activate_plugin', $plugin, $network_wide );
556
557                        /**
558                         * Fires as a specific plugin is being activated.
559                         *
560                         * This hook is the "activation" hook used internally by
561                         * {@see register_activation_hook()}. The dynamic portion of the
562                         * hook name, `$plugin`, refers to the plugin basename.
563                         *
564                         * If a plugin is silently activated (such as during an update),
565                         * this hook does not fire.
566                         *
567                         * @since 2.0.0
568                         *
569                         * @param bool $network_wide Whether to enable the plugin for all sites in the network
570                         *                           or just the current site. Multisite only. Default is false.
571                         */
572                        do_action( 'activate_' . $plugin, $network_wide );
573                }
574
575                if ( $network_wide ) {
576                        $current = get_site_option( 'active_sitewide_plugins', array() );
577                        $current[$plugin] = time();
578                        update_site_option( 'active_sitewide_plugins', $current );
579                } else {
580                        $current = get_option( 'active_plugins', array() );
581                        $current[] = $plugin;
582                        sort($current);
583                        update_option('active_plugins', $current);
584                }
585
586                if ( ! $silent ) {
587                        /**
588                         * Fires after a plugin has been activated.
589                         *
590                         * If a plugin is silently activated (such as during an update),
591                         * this hook does not fire.
592                         *
593                         * @since 2.9.0
594                         *
595                         * @param string $plugin       Plugin path to main plugin file with plugin data.
596                         * @param bool   $network_wide Whether to enable the plugin for all sites in the network
597                         *                             or just the current site. Multisite only. Default is false.
598                         */
599                        do_action( 'activated_plugin', $plugin, $network_wide );
600                }
601
602                if ( ob_get_length() > 0 ) {
603                        $output = ob_get_clean();
604                        return new WP_Error('unexpected_output', __('The plugin generated unexpected output.'), $output);
605                }
606                ob_end_clean();
607        }
608
609        return null;
610}
611
612/**
613 * Deactivate a single plugin or multiple plugins.
614 *
615 * The deactivation hook is disabled by the plugin upgrader by using the $silent
616 * parameter.
617 *
618 * @since 2.5.0
619 *
620 * @param string|array $plugins Single plugin or list of plugins to deactivate.
621 * @param bool $silent Prevent calling deactivation hooks. Default is false.
622 * @param mixed $network_wide Whether to deactivate the plugin for all sites in the network.
623 *      A value of null (the default) will deactivate plugins for both the site and the network.
624 */
625function deactivate_plugins( $plugins, $silent = false, $network_wide = null ) {
626        if ( is_multisite() )
627                $network_current = get_site_option( 'active_sitewide_plugins', array() );
628        $current = get_option( 'active_plugins', array() );
629        $do_blog = $do_network = false;
630
631        foreach ( (array) $plugins as $plugin ) {
632                $plugin = plugin_basename( trim( $plugin ) );
633                if ( ! is_plugin_active($plugin) )
634                        continue;
635
636                $network_deactivating = false !== $network_wide && is_plugin_active_for_network( $plugin );
637
638                if ( ! $silent ) {
639                        /**
640                         * Fires before a plugin is deactivated.
641                         *
642                         * If a plugin is silently deactivated (such as during an update),
643                         * this hook does not fire.
644                         *
645                         * @since 2.9.0
646                         *
647                         * @param string $plugin               Plugin path to main plugin file with plugin data.
648                         * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
649                         *                                     or just the current site. Multisite only. Default is false.
650                         */
651                        do_action( 'deactivate_plugin', $plugin, $network_deactivating );
652                }
653
654                if ( false !== $network_wide ) {
655                        if ( is_plugin_active_for_network( $plugin ) ) {
656                                $do_network = true;
657                                unset( $network_current[ $plugin ] );
658                        } elseif ( $network_wide ) {
659                                continue;
660                        }
661                }
662
663                if ( true !== $network_wide ) {
664                        $key = array_search( $plugin, $current );
665                        if ( false !== $key ) {
666                                $do_blog = true;
667                                unset( $current[ $key ] );
668                        }
669                }
670
671                if ( ! $silent ) {
672                        /**
673                         * Fires as a specific plugin is being deactivated.
674                         *
675                         * This hook is the "deactivation" hook used internally by
676                         * {@see register_deactivation_hook()}. The dynamic portion of the
677                         * hook name, `$plugin`, refers to the plugin basename.
678                         *
679                         * If a plugin is silently deactivated (such as during an update),
680                         * this hook does not fire.
681                         *
682                         * @since 2.0.0
683                         *
684                         * @param bool $network_deactivating Whether the plugin is deactivated for all sites in the network
685                         *                                   or just the current site. Multisite only. Default is false.
686                         */
687                        do_action( 'deactivate_' . $plugin, $network_deactivating );
688
689                        /**
690                         * Fires after a plugin is deactivated.
691                         *
692                         * If a plugin is silently deactivated (such as during an update),
693                         * this hook does not fire.
694                         *
695                         * @since 2.9.0
696                         *
697                         * @param string $plugin               Plugin basename.
698                         * @param bool   $network_deactivating Whether the plugin is deactivated for all sites in the network
699                         *                                     or just the current site. Multisite only. Default false.
700                         */
701                        do_action( 'deactivated_plugin', $plugin, $network_deactivating );
702                }
703        }
704
705        if ( $do_blog )
706                update_option('active_plugins', $current);
707        if ( $do_network )
708                update_site_option( 'active_sitewide_plugins', $network_current );
709}
710
711/**
712 * Activate multiple plugins.
713 *
714 * When WP_Error is returned, it does not mean that one of the plugins had
715 * errors. It means that one or more of the plugins file path was invalid.
716 *
717 * The execution will be halted as soon as one of the plugins has an error.
718 *
719 * @since 2.6.0
720 *
721 * @param string|array $plugins Single plugin or list of plugins to activate.
722 * @param string $redirect Redirect to page after successful activation.
723 * @param bool $network_wide Whether to enable the plugin for all sites in the network.
724 * @param bool $silent Prevent calling activation hooks. Default is false.
725 * @return bool|WP_Error True when finished or WP_Error if there were errors during a plugin activation.
726 */
727function activate_plugins( $plugins, $redirect = '', $network_wide = false, $silent = false ) {
728        if ( !is_array($plugins) )
729                $plugins = array($plugins);
730
731        $errors = array();
732        foreach ( $plugins as $plugin ) {
733                if ( !empty($redirect) )
734                        $redirect = add_query_arg('plugin', $plugin, $redirect);
735                $result = activate_plugin($plugin, $redirect, $network_wide, $silent);
736                if ( is_wp_error($result) )
737                        $errors[$plugin] = $result;
738        }
739
740        if ( !empty($errors) )
741                return new WP_Error('plugins_invalid', __('One of the plugins is invalid.'), $errors);
742
743        return true;
744}
745
746/**
747 * Remove directory and files of a plugin for a list of plugins.
748 *
749 * @since 2.6.0
750 *
751 * @global WP_Filesystem_Base $wp_filesystem
752 *
753 * @param array  $plugins    List of plugins to delete.
754 * @param string $deprecated Deprecated.
755 * @return bool|null|WP_Error True on success, false is $plugins is empty, WP_Error on failure.
756 *                            Null if filesystem credentials are required to proceed.
757 */
758function delete_plugins( $plugins, $deprecated = '' ) {
759        global $wp_filesystem;
760
761        if ( empty($plugins) )
762                return false;
763
764        $checked = array();
765        foreach ( $plugins as $plugin )
766                $checked[] = 'checked[]=' . $plugin;
767
768        ob_start();
769        $url = wp_nonce_url('plugins.php?action=delete-selected&verify-delete=1&' . implode('&', $checked), 'bulk-plugins');
770        if ( false === ($credentials = request_filesystem_credentials($url)) ) {
771                $data = ob_get_clean();
772
773                if ( ! empty($data) ){
774                        include_once( ABSPATH . 'wp-admin/admin-header.php');
775                        echo $data;
776                        include( ABSPATH . 'wp-admin/admin-footer.php');
777                        exit;
778                }
779                return;
780        }
781
782        if ( ! WP_Filesystem($credentials) ) {
783                request_filesystem_credentials($url, '', true); //Failed to connect, Error and request again
784                $data = ob_get_clean();
785
786                if ( ! empty($data) ){
787                        include_once( ABSPATH . 'wp-admin/admin-header.php');
788                        echo $data;
789                        include( ABSPATH . 'wp-admin/admin-footer.php');
790                        exit;
791                }
792                return;
793        }
794
795        if ( ! is_object($wp_filesystem) )
796                return new WP_Error('fs_unavailable', __('Could not access filesystem.'));
797
798        if ( is_wp_error($wp_filesystem->errors) && $wp_filesystem->errors->get_error_code() )
799                return new WP_Error('fs_error', __('Filesystem error.'), $wp_filesystem->errors);
800
801        // Get the base plugin folder.
802        $plugins_dir = $wp_filesystem->wp_plugins_dir();
803        if ( empty( $plugins_dir ) ) {
804                return new WP_Error( 'fs_no_plugins_dir', __( 'Unable to locate WordPress Plugin directory.' ) );
805        }
806
807        $plugins_dir = trailingslashit( $plugins_dir );
808
809        $plugin_translations = wp_get_installed_translations( 'plugins' );
810
811        $errors = array();
812
813        foreach ( $plugins as $plugin_file ) {
814                // Run Uninstall hook.
815                if ( is_uninstallable_plugin( $plugin_file ) ) {
816                        uninstall_plugin($plugin_file);
817                }
818
819                $this_plugin_dir = trailingslashit( dirname( $plugins_dir . $plugin_file ) );
820                // If plugin is in its own directory, recursively delete the directory.
821                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
822                        $deleted = $wp_filesystem->delete( $this_plugin_dir, true );
823                } else {
824                        $deleted = $wp_filesystem->delete( $plugins_dir . $plugin_file );
825                }
826
827                /**
828                 * Fires immediately after a plugin deletion attempt.
829                 *
830                 * @since 4.4.0
831                 *
832                 * @param string $plugin_file Plugin file name.
833                 * @param bool   $deleted     Whether the plugin deletion was successful.
834                 */
835                do_action( 'delete_plugin', $plugin_file, $deleted );
836
837                if ( ! $deleted ) {
838                        $errors[] = $plugin_file;
839                        continue;
840                }
841
842                // Remove language files, silently.
843                $plugin_slug = dirname( $plugin_file );
844                if ( '.' !== $plugin_slug && ! empty( $plugin_translations[ $plugin_slug ] ) ) {
845                        $translations = $plugin_translations[ $plugin_slug ];
846
847                        foreach ( $translations as $translation => $data ) {
848                                $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.po' );
849                                $wp_filesystem->delete( WP_LANG_DIR . '/plugins/' . $plugin_slug . '-' . $translation . '.mo' );
850                        }
851                }
852        }
853
854        // Remove deleted plugins from the plugin updates list.
855        if ( $current = get_site_transient('update_plugins') ) {
856                // Don't remove the plugins that weren't deleted.
857                $deleted = array_diff( $plugins, $errors );
858
859                foreach ( $deleted as $plugin_file ) {
860                        unset( $current->response[ $plugin_file ] );
861                }
862
863                set_site_transient( 'update_plugins', $current );
864        }
865
866        if ( ! empty($errors) )
867                return new WP_Error('could_not_remove_plugin', sprintf(__('Could not fully remove the plugin(s) %s.'), implode(', ', $errors)) );
868
869        return true;
870}
871
872/**
873 * Validate active plugins
874 *
875 * Validate all active plugins, deactivates invalid and
876 * returns an array of deactivated ones.
877 *
878 * @since 2.5.0
879 * @return array invalid plugins, plugin as key, error as value
880 */
881function validate_active_plugins() {
882        $plugins = get_option( 'active_plugins', array() );
883        // Validate vartype: array.
884        if ( ! is_array( $plugins ) ) {
885                update_option( 'active_plugins', array() );
886                $plugins = array();
887        }
888
889        if ( is_multisite() && current_user_can( 'manage_network_plugins' ) ) {
890                $network_plugins = (array) get_site_option( 'active_sitewide_plugins', array() );
891                $plugins = array_merge( $plugins, array_keys( $network_plugins ) );
892        }
893
894        if ( empty( $plugins ) )
895                return array();
896
897        $invalid = array();
898
899        // Invalid plugins get deactivated.
900        foreach ( $plugins as $plugin ) {
901                $result = validate_plugin( $plugin );
902                if ( is_wp_error( $result ) ) {
903                        $invalid[$plugin] = $result;
904                        deactivate_plugins( $plugin, true );
905                }
906        }
907        return $invalid;
908}
909
910/**
911 * Validate the plugin path.
912 *
913 * Checks that the file exists and {@link validate_file() is valid file}.
914 *
915 * @since 2.5.0
916 *
917 * @param string $plugin Plugin Path
918 * @return WP_Error|int 0 on success, WP_Error on failure.
919 */
920function validate_plugin($plugin) {
921        if ( validate_file($plugin) )
922                return new WP_Error('plugin_invalid', __('Invalid plugin path.'));
923        if ( ! file_exists(WP_PLUGIN_DIR . '/' . $plugin) )
924                return new WP_Error('plugin_not_found', __('Plugin file does not exist.'));
925
926        $installed_plugins = get_plugins();
927        if ( ! isset($installed_plugins[$plugin]) )
928                return new WP_Error('no_plugin_header', __('The plugin does not have a valid header.'));
929        return 0;
930}
931
932/**
933 * Whether the plugin can be uninstalled.
934 *
935 * @since 2.7.0
936 *
937 * @param string $plugin Plugin path to check.
938 * @return bool Whether plugin can be uninstalled.
939 */
940function is_uninstallable_plugin($plugin) {
941        $file = plugin_basename($plugin);
942
943        $uninstallable_plugins = (array) get_option('uninstall_plugins');
944        if ( isset( $uninstallable_plugins[$file] ) || file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) )
945                return true;
946
947        return false;
948}
949
950/**
951 * Uninstall a single plugin.
952 *
953 * Calls the uninstall hook, if it is available.
954 *
955 * @since 2.7.0
956 *
957 * @param string $plugin Relative plugin path from Plugin Directory.
958 * @return true True if a plugin's uninstall.php file has been found and included.
959 */
960function uninstall_plugin($plugin) {
961        $file = plugin_basename($plugin);
962
963        $uninstallable_plugins = (array) get_option('uninstall_plugins');
964        if ( file_exists( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' ) ) {
965                if ( isset( $uninstallable_plugins[$file] ) ) {
966                        unset($uninstallable_plugins[$file]);
967                        update_option('uninstall_plugins', $uninstallable_plugins);
968                }
969                unset($uninstallable_plugins);
970
971                define('WP_UNINSTALL_PLUGIN', $file);
972                wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . dirname( $file ) );
973                include( WP_PLUGIN_DIR . '/' . dirname($file) . '/uninstall.php' );
974
975                return true;
976        }
977
978        if ( isset( $uninstallable_plugins[$file] ) ) {
979                $callable = $uninstallable_plugins[$file];
980                unset($uninstallable_plugins[$file]);
981                update_option('uninstall_plugins', $uninstallable_plugins);
982                unset($uninstallable_plugins);
983
984                wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $file );
985                include( WP_PLUGIN_DIR . '/' . $file );
986
987                add_action( 'uninstall_' . $file, $callable );
988
989                /**
990                 * Fires in uninstall_plugin() once the plugin has been uninstalled.
991                 *
992                 * The action concatenates the 'uninstall_' prefix with the basename of the
993                 * plugin passed to {@see uninstall_plugin()} to create a dynamically-named action.
994                 *
995                 * @since 2.7.0
996                 */
997                do_action( 'uninstall_' . $file );
998        }
999}
1000
1001//
1002// Menu
1003//
1004
1005/**
1006 * Add a top level menu page
1007 *
1008 * This function takes a capability which will be used to determine whether
1009 * or not a page is included in the menu.
1010 *
1011 * The function which is hooked in to handle the output of the page must check
1012 * that the user has the required capability as well.
1013 *
1014 * @global array $menu
1015 * @global array $admin_page_hooks
1016 * @global array $_registered_pages
1017 * @global array $_parent_pages
1018 *
1019 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1020 * @param string $menu_title The text to be used for the menu
1021 * @param string $capability The capability required for this menu to be displayed to the user.
1022 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1023 * @param callable $function The function to be called to output the content for this page.
1024 * @param string $icon_url The url to the icon to be used for this menu.
1025 *     * Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme.
1026 *       This should begin with 'data:image/svg+xml;base64,'.
1027 *     * Pass the name of a Dashicons helper class to use a font icon, e.g. 'dashicons-chart-pie'.
1028 *     * Pass 'none' to leave div.wp-menu-image empty so an icon can be added via CSS.
1029 * @param int $position The position in the menu order this one should appear
1030 *
1031 * @return string The resulting page's hook_suffix
1032 */
1033function add_menu_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '', $position = null ) {
1034        global $menu, $admin_page_hooks, $_registered_pages, $_parent_pages;
1035
1036        $menu_slug = plugin_basename( $menu_slug );
1037
1038        $admin_page_hooks[$menu_slug] = sanitize_title( $menu_title );
1039
1040        $hookname = get_plugin_page_hookname( $menu_slug, '' );
1041
1042        if ( !empty( $function ) && !empty( $hookname ) && current_user_can( $capability ) )
1043                add_action( $hookname, $function );
1044
1045        if ( empty($icon_url) ) {
1046                $icon_url = 'dashicons-admin-generic';
1047                $icon_class = 'menu-icon-generic ';
1048        } else {
1049                $icon_url = set_url_scheme( $icon_url );
1050                $icon_class = '';
1051        }
1052
1053        $new_menu = array( $menu_title, $capability, $menu_slug, $page_title, 'menu-top ' . $icon_class . $hookname, $hookname, $icon_url );
1054
1055        if ( null === $position ) {
1056                $menu[] = $new_menu;
1057        } elseif ( isset( $menu[ "$position" ] ) ) {
1058                $position = $position + substr( base_convert( md5( $menu_slug . $menu_title ), 16, 10 ) , -5 ) * 0.00001;
1059                $menu[ "$position" ] = $new_menu;
1060        } else {
1061                $menu[ $position ] = $new_menu;
1062        }
1063
1064        $_registered_pages[$hookname] = true;
1065
1066        // No parent as top level
1067        $_parent_pages[$menu_slug] = false;
1068
1069        return $hookname;
1070}
1071
1072/**
1073 * Add a top level menu page in the 'objects' section
1074 *
1075 * This function takes a capability which will be used to determine whether
1076 * or not a page is included in the menu.
1077 *
1078 * The function which is hooked in to handle the output of the page must check
1079 * that the user has the required capability as well.
1080 *
1081 * @global int $_wp_last_object_menu
1082 *
1083 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1084 * @param string $menu_title The text to be used for the menu
1085 * @param string $capability The capability required for this menu to be displayed to the user.
1086 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1087 * @param callable $function The function to be called to output the content for this page.
1088 * @param string $icon_url The url to the icon to be used for this menu
1089 *
1090 * @return string The resulting page's hook_suffix
1091 */
1092function add_object_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
1093        global $_wp_last_object_menu;
1094
1095        $_wp_last_object_menu++;
1096
1097        return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_object_menu);
1098}
1099
1100/**
1101 * Add a top level menu page in the 'utility' section
1102 *
1103 * This function takes a capability which will be used to determine whether
1104 * or not a page is included in the menu.
1105 *
1106 * The function which is hooked in to handle the output of the page must check
1107 * that the user has the required capability as well.
1108 *
1109 * @global int $_wp_last_utility_menu
1110 *
1111 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1112 * @param string $menu_title The text to be used for the menu
1113 * @param string $capability The capability required for this menu to be displayed to the user.
1114 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1115 * @param callable $function The function to be called to output the content for this page.
1116 * @param string $icon_url The url to the icon to be used for this menu
1117 *
1118 * @return string The resulting page's hook_suffix
1119 */
1120function add_utility_page( $page_title, $menu_title, $capability, $menu_slug, $function = '', $icon_url = '') {
1121        global $_wp_last_utility_menu;
1122
1123        $_wp_last_utility_menu++;
1124
1125        return add_menu_page($page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $_wp_last_utility_menu);
1126}
1127
1128/**
1129 * Add a sub menu page
1130 *
1131 * This function takes a capability which will be used to determine whether
1132 * or not a page is included in the menu.
1133 *
1134 * The function which is hooked in to handle the output of the page must check
1135 * that the user has the required capability as well.
1136 *
1137 * @global array $submenu
1138 * @global array $menu
1139 * @global array $_wp_real_parent_file
1140 * @global bool $_wp_submenu_nopriv
1141 * @global array $_registered_pages
1142 * @global array $_parent_pages
1143 *
1144 * @param string $parent_slug The slug name for the parent menu (or the file name of a standard WordPress admin page)
1145 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1146 * @param string $menu_title The text to be used for the menu
1147 * @param string $capability The capability required for this menu to be displayed to the user.
1148 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1149 * @param callable $function The function to be called to output the content for this page.
1150 *
1151 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1152 */
1153function add_submenu_page( $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1154        global $submenu, $menu, $_wp_real_parent_file, $_wp_submenu_nopriv,
1155                $_registered_pages, $_parent_pages;
1156
1157        $menu_slug = plugin_basename( $menu_slug );
1158        $parent_slug = plugin_basename( $parent_slug);
1159
1160        if ( isset( $_wp_real_parent_file[$parent_slug] ) )
1161                $parent_slug = $_wp_real_parent_file[$parent_slug];
1162
1163        if ( !current_user_can( $capability ) ) {
1164                $_wp_submenu_nopriv[$parent_slug][$menu_slug] = true;
1165                return false;
1166        }
1167
1168        /*
1169         * If the parent doesn't already have a submenu, add a link to the parent
1170         * as the first item in the submenu. If the submenu file is the same as the
1171         * parent file someone is trying to link back to the parent manually. In
1172         * this case, don't automatically add a link back to avoid duplication.
1173         */
1174        if (!isset( $submenu[$parent_slug] ) && $menu_slug != $parent_slug ) {
1175                foreach ( (array)$menu as $parent_menu ) {
1176                        if ( $parent_menu[2] == $parent_slug && current_user_can( $parent_menu[1] ) )
1177                                $submenu[$parent_slug][] = array_slice( $parent_menu, 0, 4 );
1178                }
1179        }
1180
1181        $submenu[$parent_slug][] = array ( $menu_title, $capability, $menu_slug, $page_title );
1182
1183        $hookname = get_plugin_page_hookname( $menu_slug, $parent_slug);
1184        if (!empty ( $function ) && !empty ( $hookname ))
1185                add_action( $hookname, $function );
1186
1187        $_registered_pages[$hookname] = true;
1188
1189        /*
1190         * Backward-compatibility for plugins using add_management page.
1191         * See wp-admin/admin.php for redirect from edit.php to tools.php
1192         */
1193        if ( 'tools.php' == $parent_slug )
1194                $_registered_pages[get_plugin_page_hookname( $menu_slug, 'edit.php')] = true;
1195
1196        // No parent as top level.
1197        $_parent_pages[$menu_slug] = $parent_slug;
1198
1199        return $hookname;
1200}
1201
1202/**
1203 * Add sub menu page to the Tools main menu.
1204 *
1205 * This function takes a capability which will be used to determine whether
1206 * or not a page is included in the menu.
1207 *
1208 * The function which is hooked in to handle the output of the page must check
1209 * that the user has the required capability as well.
1210 *
1211 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1212 * @param string $menu_title The text to be used for the menu
1213 * @param string $capability The capability required for this menu to be displayed to the user.
1214 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1215 * @param callable $function The function to be called to output the content for this page.
1216 *
1217 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1218 */
1219function add_management_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1220        return add_submenu_page( 'tools.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1221}
1222
1223/**
1224 * Add sub menu page to the Settings main menu.
1225 *
1226 * This function takes a capability which will be used to determine whether
1227 * or not a page is included in the menu.
1228 *
1229 * The function which is hooked in to handle the output of the page must check
1230 * that the user has the required capability as well.
1231 *
1232 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1233 * @param string $menu_title The text to be used for the menu
1234 * @param string $capability The capability required for this menu to be displayed to the user.
1235 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1236 * @param callable $function The function to be called to output the content for this page.
1237 *
1238 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1239 */
1240function add_options_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1241        return add_submenu_page( 'options-general.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1242}
1243
1244/**
1245 * Add sub menu page to the Appearance main menu.
1246 *
1247 * This function takes a capability which will be used to determine whether
1248 * or not a page is included in the menu.
1249 *
1250 * The function which is hooked in to handle the output of the page must check
1251 * that the user has the required capability as well.
1252 *
1253 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1254 * @param string $menu_title The text to be used for the menu
1255 * @param string $capability The capability required for this menu to be displayed to the user.
1256 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1257 * @param callable $function The function to be called to output the content for this page.
1258 *
1259 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1260 */
1261function add_theme_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1262        return add_submenu_page( 'themes.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1263}
1264
1265/**
1266 * Add sub menu page to the Plugins main menu.
1267 *
1268 * This function takes a capability which will be used to determine whether
1269 * or not a page is included in the menu.
1270 *
1271 * The function which is hooked in to handle the output of the page must check
1272 * that the user has the required capability as well.
1273 *
1274 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1275 * @param string $menu_title The text to be used for the menu
1276 * @param string $capability The capability required for this menu to be displayed to the user.
1277 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1278 * @param callable $function The function to be called to output the content for this page.
1279 *
1280 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1281 */
1282function add_plugins_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1283        return add_submenu_page( 'plugins.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1284}
1285
1286/**
1287 * Add sub menu page to the Users/Profile main menu.
1288 *
1289 * This function takes a capability which will be used to determine whether
1290 * or not a page is included in the menu.
1291 *
1292 * The function which is hooked in to handle the output of the page must check
1293 * that the user has the required capability as well.
1294 *
1295 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1296 * @param string $menu_title The text to be used for the menu
1297 * @param string $capability The capability required for this menu to be displayed to the user.
1298 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1299 * @param callable $function The function to be called to output the content for this page.
1300 *
1301 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1302 */
1303function add_users_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1304        if ( current_user_can('edit_users') )
1305                $parent = 'users.php';
1306        else
1307                $parent = 'profile.php';
1308        return add_submenu_page( $parent, $page_title, $menu_title, $capability, $menu_slug, $function );
1309}
1310/**
1311 * Add sub menu page to the Dashboard main menu.
1312 *
1313 * This function takes a capability which will be used to determine whether
1314 * or not a page is included in the menu.
1315 *
1316 * The function which is hooked in to handle the output of the page must check
1317 * that the user has the required capability as well.
1318 *
1319 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1320 * @param string $menu_title The text to be used for the menu
1321 * @param string $capability The capability required for this menu to be displayed to the user.
1322 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1323 * @param callable $function The function to be called to output the content for this page.
1324 *
1325 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1326 */
1327function add_dashboard_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1328        return add_submenu_page( 'index.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1329}
1330
1331/**
1332 * Add sub menu page to the Posts main menu.
1333 *
1334 * This function takes a capability which will be used to determine whether
1335 * or not a page is included in the menu.
1336 *
1337 * The function which is hooked in to handle the output of the page must check
1338 * that the user has the required capability as well.
1339 *
1340 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1341 * @param string $menu_title The text to be used for the menu
1342 * @param string $capability The capability required for this menu to be displayed to the user.
1343 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1344 * @param callable $function The function to be called to output the content for this page.
1345 *
1346 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1347 */
1348function add_posts_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1349        return add_submenu_page( 'edit.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1350}
1351
1352/**
1353 * Add sub menu page to the Media main menu.
1354 *
1355 * This function takes a capability which will be used to determine whether
1356 * or not a page is included in the menu.
1357 *
1358 * The function which is hooked in to handle the output of the page must check
1359 * that the user has the required capability as well.
1360 *
1361 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1362 * @param string $menu_title The text to be used for the menu
1363 * @param string $capability The capability required for this menu to be displayed to the user.
1364 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1365 * @param callable $function The function to be called to output the content for this page.
1366 *
1367 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1368 */
1369function add_media_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1370        return add_submenu_page( 'upload.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1371}
1372
1373/**
1374 * Add sub menu page to the Links main menu.
1375 *
1376 * This function takes a capability which will be used to determine whether
1377 * or not a page is included in the menu.
1378 *
1379 * The function which is hooked in to handle the output of the page must check
1380 * that the user has the required capability as well.
1381 *
1382 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1383 * @param string $menu_title The text to be used for the menu
1384 * @param string $capability The capability required for this menu to be displayed to the user.
1385 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1386 * @param callable $function The function to be called to output the content for this page.
1387 *
1388 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1389 */
1390function add_links_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1391        return add_submenu_page( 'link-manager.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1392}
1393
1394/**
1395 * Add sub menu page to the Pages main menu.
1396 *
1397 * This function takes a capability which will be used to determine whether
1398 * or not a page is included in the menu.
1399 *
1400 * The function which is hooked in to handle the output of the page must check
1401 * that the user has the required capability as well.
1402 *
1403 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1404 * @param string $menu_title The text to be used for the menu
1405 * @param string $capability The capability required for this menu to be displayed to the user.
1406 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1407 * @param callable $function The function to be called to output the content for this page.
1408 *
1409 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1410*/
1411function add_pages_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1412        return add_submenu_page( 'edit.php?post_type=page', $page_title, $menu_title, $capability, $menu_slug, $function );
1413}
1414
1415/**
1416 * Add sub menu page to the Comments main menu.
1417 *
1418 * This function takes a capability which will be used to determine whether
1419 * or not a page is included in the menu.
1420 *
1421 * The function which is hooked in to handle the output of the page must check
1422 * that the user has the required capability as well.
1423 *
1424 * @param string $page_title The text to be displayed in the title tags of the page when the menu is selected
1425 * @param string $menu_title The text to be used for the menu
1426 * @param string $capability The capability required for this menu to be displayed to the user.
1427 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1428 * @param callable $function The function to be called to output the content for this page.
1429 *
1430 * @return false|string The resulting page's hook_suffix, or false if the user does not have the capability required.
1431*/
1432function add_comments_page( $page_title, $menu_title, $capability, $menu_slug, $function = '' ) {
1433        return add_submenu_page( 'edit-comments.php', $page_title, $menu_title, $capability, $menu_slug, $function );
1434}
1435
1436/**
1437 * Remove a top level admin menu
1438 *
1439 * @since 3.1.0
1440 *
1441 * @global array $menu
1442 *
1443 * @param string $menu_slug The slug of the menu
1444 * @return array|bool The removed menu on success, False if not found
1445 */
1446function remove_menu_page( $menu_slug ) {
1447        global $menu;
1448
1449        foreach ( $menu as $i => $item ) {
1450                if ( $menu_slug == $item[2] ) {
1451                        unset( $menu[$i] );
1452                        return $item;
1453                }
1454        }
1455
1456        return false;
1457}
1458
1459/**
1460 * Remove an admin submenu
1461 *
1462 * @since 3.1.0
1463 *
1464 * @global array $submenu
1465 *
1466 * @param string $menu_slug The slug for the parent menu
1467 * @param string $submenu_slug The slug of the submenu
1468 * @return array|bool The removed submenu on success, False if not found
1469 */
1470function remove_submenu_page( $menu_slug, $submenu_slug ) {
1471        global $submenu;
1472
1473        if ( !isset( $submenu[$menu_slug] ) )
1474                return false;
1475
1476        foreach ( $submenu[$menu_slug] as $i => $item ) {
1477                if ( $submenu_slug == $item[2] ) {
1478                        unset( $submenu[$menu_slug][$i] );
1479                        return $item;
1480                }
1481        }
1482
1483        return false;
1484}
1485
1486/**
1487 * Get the url to access a particular menu page based on the slug it was registered with.
1488 *
1489 * If the slug hasn't been registered properly no url will be returned
1490 *
1491 * @since 3.0.0
1492 *
1493 * @global array $_parent_pages
1494 *
1495 * @param string $menu_slug The slug name to refer to this menu by (should be unique for this menu)
1496 * @param bool $echo Whether or not to echo the url - default is true
1497 * @return string the url
1498 */
1499function menu_page_url($menu_slug, $echo = true) {
1500        global $_parent_pages;
1501
1502        if ( isset( $_parent_pages[$menu_slug] ) ) {
1503                $parent_slug = $_parent_pages[$menu_slug];
1504                if ( $parent_slug && ! isset( $_parent_pages[$parent_slug] ) ) {
1505                        $url = admin_url( add_query_arg( 'page', $menu_slug, $parent_slug ) );
1506                } else {
1507                        $url = admin_url( 'admin.php?page=' . $menu_slug );
1508                }
1509        } else {
1510                $url = '';
1511        }
1512
1513        $url = esc_url($url);
1514
1515        if ( $echo )
1516                echo $url;
1517
1518        return $url;
1519}
1520
1521//
1522// Pluggable Menu Support -- Private
1523//
1524/**
1525 *
1526 * @global string $parent_file
1527 * @global array $menu
1528 * @global array $submenu
1529 * @global string $pagenow
1530 * @global string $typenow
1531 * @global string $plugin_page
1532 * @global array $_wp_real_parent_file
1533 * @global array $_wp_menu_nopriv
1534 * @global array $_wp_submenu_nopriv
1535 */
1536function get_admin_page_parent( $parent = '' ) {
1537        global $parent_file, $menu, $submenu, $pagenow, $typenow,
1538                $plugin_page, $_wp_real_parent_file, $_wp_menu_nopriv, $_wp_submenu_nopriv;
1539
1540        if ( !empty ( $parent ) && 'admin.php' != $parent ) {
1541                if ( isset( $_wp_real_parent_file[$parent] ) )
1542                        $parent = $_wp_real_parent_file[$parent];
1543                return $parent;
1544        }
1545
1546        if ( $pagenow == 'admin.php' && isset( $plugin_page ) ) {
1547                foreach ( (array)$menu as $parent_menu ) {
1548                        if ( $parent_menu[2] == $plugin_page ) {
1549                                $parent_file = $plugin_page;
1550                                if ( isset( $_wp_real_parent_file[$parent_file] ) )
1551                                        $parent_file = $_wp_real_parent_file[$parent_file];
1552                                return $parent_file;
1553                        }
1554                }
1555                if ( isset( $_wp_menu_nopriv[$plugin_page] ) ) {
1556                        $parent_file = $plugin_page;
1557                        if ( isset( $_wp_real_parent_file[$parent_file] ) )
1558                                        $parent_file = $_wp_real_parent_file[$parent_file];
1559                        return $parent_file;
1560                }
1561        }
1562
1563        if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$pagenow][$plugin_page] ) ) {
1564                $parent_file = $pagenow;
1565                if ( isset( $_wp_real_parent_file[$parent_file] ) )
1566                        $parent_file = $_wp_real_parent_file[$parent_file];
1567                return $parent_file;
1568        }
1569
1570        foreach (array_keys( (array)$submenu ) as $parent) {
1571                foreach ( $submenu[$parent] as $submenu_array ) {
1572                        if ( isset( $_wp_real_parent_file[$parent] ) )
1573                                $parent = $_wp_real_parent_file[$parent];
1574                        if ( !empty($typenow) && ($submenu_array[2] == "$pagenow?post_type=$typenow") ) {
1575                                $parent_file = $parent;
1576                                return $parent;
1577                        } elseif ( $submenu_array[2] == $pagenow && empty($typenow) && ( empty($parent_file) || false === strpos($parent_file, '?') ) ) {
1578                                $parent_file = $parent;
1579                                return $parent;
1580                        } elseif ( isset( $plugin_page ) && ($plugin_page == $submenu_array[2] ) ) {
1581                                $parent_file = $parent;
1582                                return $parent;
1583                        }
1584                }
1585        }
1586
1587        if ( empty($parent_file) )
1588                $parent_file = '';
1589        return '';
1590}
1591
1592/**
1593 *
1594 * @global string $title
1595 * @global array $menu
1596 * @global array $submenu
1597 * @global string $pagenow
1598 * @global string $plugin_page
1599 * @global string $typenow
1600 */
1601function get_admin_page_title() {
1602        global $title, $menu, $submenu, $pagenow, $plugin_page, $typenow;
1603
1604        if ( ! empty ( $title ) )
1605                return $title;
1606
1607        $hook = get_plugin_page_hook( $plugin_page, $pagenow );
1608
1609        $parent = $parent1 = get_admin_page_parent();
1610
1611        if ( empty ( $parent) ) {
1612                foreach ( (array)$menu as $menu_array ) {
1613                        if ( isset( $menu_array[3] ) ) {
1614                                if ( $menu_array[2] == $pagenow ) {
1615                                        $title = $menu_array[3];
1616                                        return $menu_array[3];
1617                                } elseif ( isset( $plugin_page ) && ($plugin_page == $menu_array[2] ) && ($hook == $menu_array[3] ) ) {
1618                                        $title = $menu_array[3];
1619                                        return $menu_array[3];
1620                                }
1621                        } else {
1622                                $title = $menu_array[0];
1623                                return $title;
1624                        }
1625                }
1626        } else {
1627                foreach ( array_keys( $submenu ) as $parent ) {
1628                        foreach ( $submenu[$parent] as $submenu_array ) {
1629                                if ( isset( $plugin_page ) &&
1630                                        ( $plugin_page == $submenu_array[2] ) &&
1631                                        (
1632                                                ( $parent == $pagenow ) ||
1633                                                ( $parent == $plugin_page ) ||
1634                                                ( $plugin_page == $hook ) ||
1635                                                ( $pagenow == 'admin.php' && $parent1 != $submenu_array[2] ) ||
1636                                                ( !empty($typenow) && $parent == $pagenow . '?post_type=' . $typenow)
1637                                        )
1638                                        ) {
1639                                                $title = $submenu_array[3];
1640                                                return $submenu_array[3];
1641                                        }
1642
1643                                if ( $submenu_array[2] != $pagenow || isset( $_GET['page'] ) ) // not the current page
1644                                        continue;
1645
1646                                if ( isset( $submenu_array[3] ) ) {
1647                                        $title = $submenu_array[3];
1648                                        return $submenu_array[3];
1649                                } else {
1650                                        $title = $submenu_array[0];
1651                                        return $title;
1652                                }
1653                        }
1654                }
1655                if ( empty ( $title ) ) {
1656                        foreach ( $menu as $menu_array ) {
1657                                if ( isset( $plugin_page ) &&
1658                                        ( $plugin_page == $menu_array[2] ) &&
1659                                        ( $pagenow == 'admin.php' ) &&
1660                                        ( $parent1 == $menu_array[2] ) )
1661                                        {
1662                                                $title = $menu_array[3];
1663                                                return $menu_array[3];
1664                                        }
1665                        }
1666                }
1667        }
1668
1669        return $title;
1670}
1671
1672/**
1673 * @since 2.3.0
1674 *
1675 * @param string $plugin_page
1676 * @param string $parent_page
1677 * @return string|null
1678 */
1679function get_plugin_page_hook( $plugin_page, $parent_page ) {
1680        $hook = get_plugin_page_hookname( $plugin_page, $parent_page );
1681        if ( has_action($hook) )
1682                return $hook;
1683        else
1684                return null;
1685}
1686
1687/**
1688 *
1689 * @global array $admin_page_hooks
1690 * @param string $plugin_page
1691 * @param string $parent_page
1692 */
1693function get_plugin_page_hookname( $plugin_page, $parent_page ) {
1694        global $admin_page_hooks;
1695
1696        $parent = get_admin_page_parent( $parent_page );
1697
1698        $page_type = 'admin';
1699        if ( empty ( $parent_page ) || 'admin.php' == $parent_page || isset( $admin_page_hooks[$plugin_page] ) ) {
1700                if ( isset( $admin_page_hooks[$plugin_page] ) ) {
1701                        $page_type = 'toplevel';
1702                } elseif ( isset( $admin_page_hooks[$parent] )) {
1703                        $page_type = $admin_page_hooks[$parent];
1704                }
1705        } elseif ( isset( $admin_page_hooks[$parent] ) ) {
1706                $page_type = $admin_page_hooks[$parent];
1707        }
1708
1709        $plugin_name = preg_replace( '!\.php!', '', $plugin_page );
1710
1711        return $page_type . '_page_' . $plugin_name;
1712}
1713
1714/**
1715 *
1716 * @global string $pagenow
1717 * @global array $menu
1718 * @global array $submenu
1719 * @global array $_wp_menu_nopriv
1720 * @global array $_wp_submenu_nopriv
1721 * @global string $plugin_page
1722 * @global array $_registered_pages
1723 */
1724function user_can_access_admin_page() {
1725        global $pagenow, $menu, $submenu, $_wp_menu_nopriv, $_wp_submenu_nopriv,
1726                $plugin_page, $_registered_pages;
1727
1728        $parent = get_admin_page_parent();
1729
1730        if ( !isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$parent][$pagenow] ) )
1731                return false;
1732
1733        if ( isset( $plugin_page ) ) {
1734                if ( isset( $_wp_submenu_nopriv[$parent][$plugin_page] ) )
1735                        return false;
1736
1737                $hookname = get_plugin_page_hookname($plugin_page, $parent);
1738
1739                if ( !isset($_registered_pages[$hookname]) )
1740                        return false;
1741        }
1742
1743        if ( empty( $parent) ) {
1744                if ( isset( $_wp_menu_nopriv[$pagenow] ) )
1745                        return false;
1746                if ( isset( $_wp_submenu_nopriv[$pagenow][$pagenow] ) )
1747                        return false;
1748                if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$pagenow][$plugin_page] ) )
1749                        return false;
1750                if ( isset( $plugin_page ) && isset( $_wp_menu_nopriv[$plugin_page] ) )
1751                        return false;
1752                foreach (array_keys( $_wp_submenu_nopriv ) as $key ) {
1753                        if ( isset( $_wp_submenu_nopriv[$key][$pagenow] ) )
1754                                return false;
1755                        if ( isset( $plugin_page ) && isset( $_wp_submenu_nopriv[$key][$plugin_page] ) )
1756                        return false;
1757                }
1758                return true;
1759        }
1760
1761        if ( isset( $plugin_page ) && ( $plugin_page == $parent ) && isset( $_wp_menu_nopriv[$plugin_page] ) )
1762                return false;
1763
1764        if ( isset( $submenu[$parent] ) ) {
1765                foreach ( $submenu[$parent] as $submenu_array ) {
1766                        if ( isset( $plugin_page ) && ( $submenu_array[2] == $plugin_page ) ) {
1767                                if ( current_user_can( $submenu_array[1] ))
1768                                        return true;
1769                                else
1770                                        return false;
1771                        } elseif ( $submenu_array[2] == $pagenow ) {
1772                                if ( current_user_can( $submenu_array[1] ))
1773                                        return true;
1774                                else
1775                                        return false;
1776                        }
1777                }
1778        }
1779
1780        foreach ( $menu as $menu_array ) {
1781                if ( $menu_array[2] == $parent) {
1782                        if ( current_user_can( $menu_array[1] ))
1783                                return true;
1784                        else
1785                                return false;
1786                }
1787        }
1788
1789        return true;
1790}
1791
1792/* Whitelist functions */
1793
1794/**
1795 * Register a setting and its sanitization callback
1796 *
1797 * @since 2.7.0
1798 *
1799 * @global array $new_whitelist_options
1800 *
1801 * @param string $option_group A settings group name. Should correspond to a whitelisted option key name.
1802 *      Default whitelisted option key names include "general," "discussion," and "reading," among others.
1803 * @param string $option_name The name of an option to sanitize and save.
1804 * @param callable $sanitize_callback A callback function that sanitizes the option's value.
1805 */
1806function register_setting( $option_group, $option_name, $sanitize_callback = '' ) {
1807        global $new_whitelist_options;
1808
1809        if ( 'misc' == $option_group ) {
1810                _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
1811                $option_group = 'general';
1812        }
1813
1814        if ( 'privacy' == $option_group ) {
1815                _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
1816                $option_group = 'reading';
1817        }
1818
1819        $new_whitelist_options[ $option_group ][] = $option_name;
1820        if ( $sanitize_callback != '' )
1821                add_filter( "sanitize_option_{$option_name}", $sanitize_callback );
1822}
1823
1824/**
1825 * Unregister a setting
1826 *
1827 * @since 2.7.0
1828 *
1829 * @global array $new_whitelist_options
1830 *
1831 * @param string   $option_group
1832 * @param string   $option_name
1833 * @param callable $sanitize_callback
1834 */
1835function unregister_setting( $option_group, $option_name, $sanitize_callback = '' ) {
1836        global $new_whitelist_options;
1837
1838        if ( 'misc' == $option_group ) {
1839                _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
1840                $option_group = 'general';
1841        }
1842
1843        if ( 'privacy' == $option_group ) {
1844                _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
1845                $option_group = 'reading';
1846        }
1847
1848        $pos = array_search( $option_name, (array) $new_whitelist_options[ $option_group ] );
1849        if ( $pos !== false )
1850                unset( $new_whitelist_options[ $option_group ][ $pos ] );
1851        if ( $sanitize_callback != '' )
1852                remove_filter( "sanitize_option_{$option_name}", $sanitize_callback );
1853}
1854
1855/**
1856 * Refreshes the value of the options whitelist available via the 'whitelist_options' filter.
1857 *
1858 * @since 2.7.0
1859 *
1860 * @global array $new_whitelist_options
1861 *
1862 * @param array $options
1863 * @return array
1864 */
1865function option_update_filter( $options ) {
1866        global $new_whitelist_options;
1867
1868        if ( is_array( $new_whitelist_options ) )
1869                $options = add_option_whitelist( $new_whitelist_options, $options );
1870
1871        return $options;
1872}
1873
1874/**
1875 * Adds an array of options to the options whitelist.
1876 *
1877 * @since 2.7.0
1878 *
1879 * @global array $whitelist_options
1880 *
1881 * @param array        $new_options
1882 * @param string|array $options
1883 * @return array
1884 */
1885function add_option_whitelist( $new_options, $options = '' ) {
1886        if ( $options == '' )
1887                global $whitelist_options;
1888        else
1889                $whitelist_options = $options;
1890
1891        foreach ( $new_options as $page => $keys ) {
1892                foreach ( $keys as $key ) {
1893                        if ( !isset($whitelist_options[ $page ]) || !is_array($whitelist_options[ $page ]) ) {
1894                                $whitelist_options[ $page ] = array();
1895                                $whitelist_options[ $page ][] = $key;
1896                        } else {
1897                                $pos = array_search( $key, $whitelist_options[ $page ] );
1898                                if ( $pos === false )
1899                                        $whitelist_options[ $page ][] = $key;
1900                        }
1901                }
1902        }
1903
1904        return $whitelist_options;
1905}
1906
1907/**
1908 * Removes a list of options from the options whitelist.
1909 *
1910 * @since 2.7.0
1911 *
1912 * @global array $whitelist_options
1913 *
1914 * @param array        $del_options
1915 * @param string|array $options
1916 * @return array
1917 */
1918function remove_option_whitelist( $del_options, $options = '' ) {
1919        if ( $options == '' )
1920                global $whitelist_options;
1921        else
1922                $whitelist_options = $options;
1923
1924        foreach ( $del_options as $page => $keys ) {
1925                foreach ( $keys as $key ) {
1926                        if ( isset($whitelist_options[ $page ]) && is_array($whitelist_options[ $page ]) ) {
1927                                $pos = array_search( $key, $whitelist_options[ $page ] );
1928                                if ( $pos !== false )
1929                                        unset( $whitelist_options[ $page ][ $pos ] );
1930                        }
1931                }
1932        }
1933
1934        return $whitelist_options;
1935}
1936
1937/**
1938 * Output nonce, action, and option_page fields for a settings page.
1939 *
1940 * @since 2.7.0
1941 *
1942 * @param string $option_group A settings group name. This should match the group name used in register_setting().
1943 */
1944function settings_fields($option_group) {
1945        echo "<input type='hidden' name='option_page' value='" . esc_attr($option_group) . "' />";
1946        echo '<input type="hidden" name="action" value="update" />';
1947        wp_nonce_field("$option_group-options");
1948}
1949
1950/**
1951 * Clears the Plugins cache used by get_plugins() and by default, the Plugin Update cache.
1952 *
1953 * @since 3.7.0
1954 *
1955 * @param bool $clear_update_cache Whether to clear the Plugin updates cache
1956 */
1957function wp_clean_plugins_cache( $clear_update_cache = true ) {
1958        if ( $clear_update_cache )
1959                delete_site_transient( 'update_plugins' );
1960        wp_cache_delete( 'plugins', 'plugins' );
1961}
1962
1963/**
1964 * @param string $plugin
1965 */
1966function plugin_sandbox_scrape( $plugin ) {
1967        wp_register_plugin_realpath( WP_PLUGIN_DIR . '/' . $plugin );
1968        include( WP_PLUGIN_DIR . '/' . $plugin );
1969}
Note: See TracBrowser for help on using the repository browser.