3 * These functions are needed to load WordPress.
5 * @internal This file must be parsable by PHP4.
11 * Turn register globals off.
15 * @return null Will return null if register_globals PHP directive was disabled
17 function wp_unregister_GLOBALS() {
18 if ( !ini_get( 'register_globals' ) )
21 if ( isset( $_REQUEST['GLOBALS'] ) )
22 die( 'GLOBALS overwrite attempt detected' );
24 // Variables that shouldn't be unset
25 $no_unset = array( 'GLOBALS', '_GET', '_POST', '_COOKIE', '_REQUEST', '_SERVER', '_ENV', '_FILES', 'table_prefix' );
27 $input = array_merge( $_GET, $_POST, $_COOKIE, $_SERVER, $_ENV, $_FILES, isset( $_SESSION ) && is_array( $_SESSION ) ? $_SESSION : array() );
28 foreach ( $input as $k => $v )
29 if ( !in_array( $k, $no_unset ) && isset( $GLOBALS[$k] ) ) {
30 unset( $GLOBALS[$k] );
35 * Fix $_SERVER variables for various setups.
40 function wp_fix_server_vars() {
43 $default_server_values = array(
44 'SERVER_SOFTWARE' => '',
48 $_SERVER = array_merge( $default_server_values, $_SERVER );
50 // Fix for IIS when running with PHP ISAPI
51 if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
54 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
55 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
58 else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
59 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
61 // Use ORIG_PATH_INFO if there is no PATH_INFO
62 if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) )
63 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
65 // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
66 if ( isset( $_SERVER['PATH_INFO'] ) ) {
67 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
68 $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
70 $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
73 // Append the query string if it exists and isn't null
74 if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
75 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
80 // Fix for PHP as CGI hosts that set SCRIPT_FILENAME to something ending in php.cgi for all requests
81 if ( isset( $_SERVER['SCRIPT_FILENAME'] ) && ( strpos( $_SERVER['SCRIPT_FILENAME'], 'php.cgi' ) == strlen( $_SERVER['SCRIPT_FILENAME'] ) - 7 ) )
82 $_SERVER['SCRIPT_FILENAME'] = $_SERVER['PATH_TRANSLATED'];
84 // Fix for Dreamhost and other PHP as CGI hosts
85 if ( strpos( $_SERVER['SCRIPT_NAME'], 'php.cgi' ) !== false )
86 unset( $_SERVER['PATH_INFO'] );
89 $PHP_SELF = $_SERVER['PHP_SELF'];
90 if ( empty( $PHP_SELF ) )
91 $_SERVER['PHP_SELF'] = $PHP_SELF = preg_replace( '/(\?.*)?$/', '', $_SERVER["REQUEST_URI"] );
95 * Check for the required PHP version, and the MySQL extension or a database drop-in.
97 * Dies if requirements are not met.
102 function wp_check_php_mysql_versions() {
103 global $required_php_version, $wp_version;
104 $php_version = phpversion();
105 if ( version_compare( $required_php_version, $php_version, '>' ) ) {
106 wp_load_translations_early();
107 die( sprintf( __( 'Your server is running PHP version %1$s but WordPress %2$s requires at least %3$s.' ), $php_version, $wp_version, $required_php_version ) );
110 if ( ! extension_loaded( 'mysql' ) && ! file_exists( WP_CONTENT_DIR . '/db.php' ) ) {
111 wp_load_translations_early();
112 die( __( 'Your PHP installation appears to be missing the MySQL extension which is required by WordPress.' ) );
117 * Don't load all of WordPress when handling a favicon.ico request.
118 * Instead, send the headers for a zero-length favicon and bail.
122 function wp_favicon_request() {
123 if ( '/favicon.ico' == $_SERVER['REQUEST_URI'] ) {
124 header('Content-Type: image/vnd.microsoft.icon');
125 header('Content-Length: 0');
131 * Dies with a maintenance message when conditions are met.
133 * Checks for a file in the WordPress root directory named ".maintenance".
134 * This file will contain the variable $upgrading, set to the time the file
135 * was created. If the file was created less than 10 minutes ago, WordPress
136 * enters maintenance mode and displays a message.
138 * The default message can be replaced by using a drop-in (maintenance.php in
139 * the wp-content directory).
144 function wp_maintenance() {
145 if ( !file_exists( ABSPATH . '.maintenance' ) || defined( 'WP_INSTALLING' ) )
150 include( ABSPATH . '.maintenance' );
151 // If the $upgrading timestamp is older than 10 minutes, don't die.
152 if ( ( time() - $upgrading ) >= 600 )
155 if ( file_exists( WP_CONTENT_DIR . '/maintenance.php' ) ) {
156 require_once( WP_CONTENT_DIR . '/maintenance.php' );
160 wp_load_translations_early();
162 $protocol = $_SERVER["SERVER_PROTOCOL"];
163 if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol )
164 $protocol = 'HTTP/1.0';
165 header( "$protocol 503 Service Unavailable", true, 503 );
166 header( 'Content-Type: text/html; charset=utf-8' );
167 header( 'Retry-After: 600' );
170 <html xmlns="http://www.w3.org/1999/xhtml"<?php if ( is_rtl() ) echo ' dir="rtl"'; ?>>
172 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
173 <title><?php _e( 'Maintenance' ); ?></title>
177 <h1><?php _e( 'Briefly unavailable for scheduled maintenance. Check back in a minute.' ); ?></h1>
185 * PHP 5 standard microtime start capture.
189 * @global float $timestart Seconds from when function is called.
190 * @return bool Always returns true.
192 function timer_start() {
194 $timestart = microtime( true );
199 * Return and/or display the time from the page start to when function is called.
201 * You can get the results and print them by doing:
203 * $nTimePageTookToExecute = timer_stop();
204 * echo $nTimePageTookToExecute;
207 * Or instead, you can do:
211 * which will do what the above does. If you need the result, you can assign it to a variable, but
212 * in most cases, you only need to echo it.
215 * @global float $timestart Seconds from when timer_start() is called
216 * @global float $timeend Seconds from when function is called
218 * @param int $display Use '0' or null to not echo anything and 1 to echo the total time
219 * @param int $precision The amount of digits from the right of the decimal to display. Default is 3.
220 * @return float The "second.microsecond" finished time calculation
222 function timer_stop( $display = 0, $precision = 3 ) { // if called like timer_stop(1), will echo $timetotal
223 global $timestart, $timeend;
224 $timeend = microtime( true );
225 $timetotal = $timeend - $timestart;
226 $r = ( function_exists( 'number_format_i18n' ) ) ? number_format_i18n( $timetotal, $precision ) : number_format( $timetotal, $precision );
233 * Sets PHP error handling and handles WordPress debug mode.
235 * Uses three constants: WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. All three can be
236 * defined in wp-config.php. Example: <code> define( 'WP_DEBUG', true ); </code>
238 * WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.
239 * WP_DEBUG defaults to false.
241 * When WP_DEBUG is true, all PHP notices are reported. WordPress will also display
242 * notices, including one when a deprecated WordPress function, function argument,
243 * or file is used. Deprecated code may be removed from a later version.
245 * It is strongly recommended that plugin and theme developers use WP_DEBUG in their
246 * development environments.
248 * When WP_DEBUG_DISPLAY is true, WordPress will force errors to be displayed.
249 * WP_DEBUG_DISPLAY defaults to true. Defining it as null prevents WordPress from
250 * changing the global configuration setting. Defining WP_DEBUG_DISPLAY as false
251 * will force errors to be hidden.
253 * When WP_DEBUG_LOG is true, errors will be logged to wp-content/debug.log.
254 * WP_DEBUG_LOG defaults to false.
256 * Errors are never displayed for XML-RPC requests.
261 function wp_debug_mode() {
263 error_reporting( E_ALL );
265 if ( WP_DEBUG_DISPLAY )
266 ini_set( 'display_errors', 1 );
267 elseif ( null !== WP_DEBUG_DISPLAY )
268 ini_set( 'display_errors', 0 );
270 if ( WP_DEBUG_LOG ) {
271 ini_set( 'log_errors', 1 );
272 ini_set( 'error_log', WP_CONTENT_DIR . '/debug.log' );
275 error_reporting( E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING | E_RECOVERABLE_ERROR );
277 if ( defined( 'XMLRPC_REQUEST' ) )
278 ini_set( 'display_errors', 0 );
282 * Sets the location of the language directory.
284 * To set directory manually, define <code>WP_LANG_DIR</code> in wp-config.php.
286 * If the language directory exists within WP_CONTENT_DIR, that is used.
287 * Otherwise if the language directory exists within WPINC, that's used.
288 * Finally, if neither of the preceding directories are found,
289 * WP_CONTENT_DIR/languages is used.
291 * The WP_LANG_DIR constant was introduced in 2.1.0.
296 function wp_set_lang_dir() {
297 if ( !defined( 'WP_LANG_DIR' ) ) {
298 if ( file_exists( WP_CONTENT_DIR . '/languages' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) || !@is_dir(ABSPATH . WPINC . '/languages') ) {
299 define( 'WP_LANG_DIR', WP_CONTENT_DIR . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH
300 if ( !defined( 'LANGDIR' ) ) {
301 // Old static relative path maintained for limited backwards compatibility - won't work in some cases
302 define( 'LANGDIR', 'wp-content/languages' );
305 define( 'WP_LANG_DIR', ABSPATH . WPINC . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH
306 if ( !defined( 'LANGDIR' ) ) {
307 // Old relative path maintained for backwards compatibility
308 define( 'LANGDIR', WPINC . '/languages' );
315 * Load the correct database class file.
317 * This function is used to load the database class file either at runtime or by
318 * wp-admin/setup-config.php. We must globalize $wpdb to ensure that it is
319 * defined globally by the inline code in wp-db.php.
322 * @global $wpdb WordPress Database Object
324 function require_wp_db() {
327 require_once( ABSPATH . WPINC . '/wp-db.php' );
328 if ( file_exists( WP_CONTENT_DIR . '/db.php' ) )
329 require_once( WP_CONTENT_DIR . '/db.php' );
331 if ( isset( $wpdb ) )
334 $wpdb = new wpdb( DB_USER, DB_PASSWORD, DB_NAME, DB_HOST );
338 * Sets the database table prefix and the format specifiers for database table columns.
340 * Columns not listed here default to %s.
342 * @see wpdb::$field_types Since 2.8.0
343 * @see wpdb::prepare()
344 * @see wpdb::insert()
345 * @see wpdb::update()
346 * @see wpdb::set_prefix()
351 function wp_set_wpdb_vars() {
352 global $wpdb, $table_prefix;
353 if ( !empty( $wpdb->error ) )
356 $wpdb->field_types = array( 'post_author' => '%d', 'post_parent' => '%d', 'menu_order' => '%d', 'term_id' => '%d', 'term_group' => '%d', 'term_taxonomy_id' => '%d',
357 'parent' => '%d', 'count' => '%d','object_id' => '%d', 'term_order' => '%d', 'ID' => '%d', 'comment_ID' => '%d', 'comment_post_ID' => '%d', 'comment_parent' => '%d',
358 'user_id' => '%d', 'link_id' => '%d', 'link_owner' => '%d', 'link_rating' => '%d', 'option_id' => '%d', 'blog_id' => '%d', 'meta_id' => '%d', 'post_id' => '%d',
359 'user_status' => '%d', 'umeta_id' => '%d', 'comment_karma' => '%d', 'comment_count' => '%d',
361 'active' => '%d', 'cat_id' => '%d', 'deleted' => '%d', 'lang_id' => '%d', 'mature' => '%d', 'public' => '%d', 'site_id' => '%d', 'spam' => '%d',
364 $prefix = $wpdb->set_prefix( $table_prefix );
366 if ( is_wp_error( $prefix ) ) {
367 wp_load_translations_early();
368 wp_die( __( '<strong>ERROR</strong>: <code>$table_prefix</code> in <code>wp-config.php</code> can only contain numbers, letters, and underscores.' ) );
373 * Starts the WordPress object cache.
375 * If an object-cache.php file exists in the wp-content directory,
376 * it uses that drop-in as an external object cache.
381 function wp_start_object_cache() {
382 global $_wp_using_ext_object_cache, $blog_id;
385 if ( ! function_exists( 'wp_cache_init' ) ) {
386 if ( file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
387 require_once ( WP_CONTENT_DIR . '/object-cache.php' );
388 $_wp_using_ext_object_cache = true;
390 require_once ( ABSPATH . WPINC . '/cache.php' );
391 $_wp_using_ext_object_cache = false;
394 } else if ( !$_wp_using_ext_object_cache && file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
395 // Sometimes advanced-cache.php can load object-cache.php before it is loaded here.
396 // This breaks the function_exists check above and can result in $_wp_using_ext_object_cache
397 // being set incorrectly. Double check if an external cache exists.
398 $_wp_using_ext_object_cache = true;
401 // If cache supports reset, reset instead of init if already initialized.
402 // Reset signals to the cache that global IDs have changed and it may need to update keys
403 // and cleanup caches.
404 if ( ! $first_init && function_exists( 'wp_cache_switch_to_blog' ) )
405 wp_cache_switch_to_blog( $blog_id );
409 if ( function_exists( 'wp_cache_add_global_groups' ) ) {
410 wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache' ) );
411 wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) );
416 * Redirects to the installer if WordPress is not installed.
418 * Dies with an error message when multisite is enabled.
423 function wp_not_installed() {
424 if ( is_multisite() ) {
425 if ( ! is_blog_installed() && ! defined( 'WP_INSTALLING' ) )
426 wp_die( __( 'The site you have requested is not installed properly. Please contact the system administrator.' ) );
427 } elseif ( ! is_blog_installed() && false === strpos( $_SERVER['PHP_SELF'], 'install.php' ) && !defined( 'WP_INSTALLING' ) ) {
429 $link = wp_guess_url() . '/wp-admin/install.php';
431 require( ABSPATH . WPINC . '/kses.php' );
432 require( ABSPATH . WPINC . '/pluggable.php' );
433 require( ABSPATH . WPINC . '/formatting.php' );
434 wp_redirect( $link );
440 * Returns array of must-use plugin files to be included in global scope.
442 * The default directory is wp-content/mu-plugins. To change the default directory
443 * manually, define <code>WPMU_PLUGIN_DIR</code> and <code>WPMU_PLUGIN_URL</code>
448 * @return array Files to include
450 function wp_get_mu_plugins() {
451 $mu_plugins = array();
452 if ( !is_dir( WPMU_PLUGIN_DIR ) )
454 if ( ! $dh = opendir( WPMU_PLUGIN_DIR ) )
456 while ( ( $plugin = readdir( $dh ) ) !== false ) {
457 if ( substr( $plugin, -4 ) == '.php' )
458 $mu_plugins[] = WPMU_PLUGIN_DIR . '/' . $plugin;
467 * Returns array of plugin files to be included in global scope.
469 * The default directory is wp-content/plugins. To change the default directory
470 * manually, define <code>WP_PLUGIN_DIR</code> and <code>WP_PLUGIN_URL</code>
475 * @return array Files to include
477 function wp_get_active_and_valid_plugins() {
479 $active_plugins = (array) get_option( 'active_plugins', array() );
481 // Check for hacks file if the option is enabled
482 if ( get_option( 'hack_file' ) && file_exists( ABSPATH . 'my-hacks.php' ) ) {
483 _deprecated_file( 'my-hacks.php', '1.5' );
484 array_unshift( $plugins, ABSPATH . 'my-hacks.php' );
487 if ( empty( $active_plugins ) || defined( 'WP_INSTALLING' ) )
490 $network_plugins = is_multisite() ? wp_get_active_network_plugins() : false;
492 foreach ( $active_plugins as $plugin ) {
493 if ( ! validate_file( $plugin ) // $plugin must validate as file
494 && '.php' == substr( $plugin, -4 ) // $plugin must end with '.php'
495 && file_exists( WP_PLUGIN_DIR . '/' . $plugin ) // $plugin must exist
496 // not already included as a network plugin
497 && ( ! $network_plugins || ! in_array( WP_PLUGIN_DIR . '/' . $plugin, $network_plugins ) )
499 $plugins[] = WP_PLUGIN_DIR . '/' . $plugin;
505 * Sets internal encoding using mb_internal_encoding().
507 * In most cases the default internal encoding is latin1, which is of no use,
508 * since we want to use the mb_ functions for utf-8 strings.
513 function wp_set_internal_encoding() {
514 if ( function_exists( 'mb_internal_encoding' ) ) {
515 $charset = get_option( 'blog_charset' );
516 if ( ! $charset || ! @mb_internal_encoding( $charset ) )
517 mb_internal_encoding( 'UTF-8' );
522 * Add magic quotes to $_GET, $_POST, $_COOKIE, and $_SERVER.
524 * Also forces $_REQUEST to be $_GET + $_POST. If $_SERVER, $_COOKIE,
525 * or $_ENV are needed, use those superglobals directly.
530 function wp_magic_quotes() {
531 // If already slashed, strip.
532 if ( get_magic_quotes_gpc() ) {
533 $_GET = stripslashes_deep( $_GET );
534 $_POST = stripslashes_deep( $_POST );
535 $_COOKIE = stripslashes_deep( $_COOKIE );
539 $_GET = add_magic_quotes( $_GET );
540 $_POST = add_magic_quotes( $_POST );
541 $_COOKIE = add_magic_quotes( $_COOKIE );
542 $_SERVER = add_magic_quotes( $_SERVER );
544 // Force REQUEST to be GET + POST.
545 $_REQUEST = array_merge( $_GET, $_POST );
549 * Runs just before PHP shuts down execution.
554 function shutdown_action_hook() {
555 do_action( 'shutdown' );
565 * @param object $object The object to clone
566 * @return object The cloned object
569 function wp_clone( $object ) {
570 // Use parens for clone to accommodate PHP 4. See #17880
571 return clone( $object );
575 * Whether the current request is for a network or blog admin page
577 * Does not inform on whether the user is an admin! Use capability checks to
578 * tell if the user should be accessing a section or not.
582 * @return bool True if inside WordPress administration pages.
584 function is_admin() {
585 if ( isset( $GLOBALS['current_screen'] ) )
586 return $GLOBALS['current_screen']->in_admin();
587 elseif ( defined( 'WP_ADMIN' ) )
594 * Whether the current request is for a blog admin screen /wp-admin/
596 * Does not inform on whether the user is a blog admin! Use capability checks to
597 * tell if the user should be accessing a section or not.
601 * @return bool True if inside WordPress network administration pages.
603 function is_blog_admin() {
604 if ( isset( $GLOBALS['current_screen'] ) )
605 return $GLOBALS['current_screen']->in_admin( 'site' );
606 elseif ( defined( 'WP_BLOG_ADMIN' ) )
607 return WP_BLOG_ADMIN;
613 * Whether the current request is for a network admin screen /wp-admin/network/
615 * Does not inform on whether the user is a network admin! Use capability checks to
616 * tell if the user should be accessing a section or not.
620 * @return bool True if inside WordPress network administration pages.
622 function is_network_admin() {
623 if ( isset( $GLOBALS['current_screen'] ) )
624 return $GLOBALS['current_screen']->in_admin( 'network' );
625 elseif ( defined( 'WP_NETWORK_ADMIN' ) )
626 return WP_NETWORK_ADMIN;
632 * Whether the current request is for a user admin screen /wp-admin/user/
634 * Does not inform on whether the user is an admin! Use capability checks to
635 * tell if the user should be accessing a section or not.
639 * @return bool True if inside WordPress user administration pages.
641 function is_user_admin() {
642 if ( isset( $GLOBALS['current_screen'] ) )
643 return $GLOBALS['current_screen']->in_admin( 'user' );
644 elseif ( defined( 'WP_USER_ADMIN' ) )
645 return WP_USER_ADMIN;
651 * Whether Multisite support is enabled
655 * @return bool True if multisite is enabled, false otherwise.
657 function is_multisite() {
658 if ( defined( 'MULTISITE' ) )
661 if ( defined( 'SUBDOMAIN_INSTALL' ) || defined( 'VHOST' ) || defined( 'SUNRISE' ) )
668 * Retrieve the current blog id
672 * @return int Blog id
674 function get_current_blog_id() {
676 return absint($blog_id);
680 * Attempts an early load of translations.
682 * Used for errors encountered during the initial loading process, before the locale has been
683 * properly detected and loaded.
685 * Designed for unusual load sequences (like setup-config.php) or for when the script will then
686 * terminate with an error, otherwise there is a risk that a file can be double-included.
691 function wp_load_translations_early() {
692 global $text_direction, $wp_locale;
694 static $loaded = false;
699 if ( function_exists( 'did_action' ) && did_action( 'init' ) )
702 // We need $wp_local_package
703 require ABSPATH . WPINC . '/version.php';
705 // Translation and localization
706 require_once ABSPATH . WPINC . '/pomo/mo.php';
707 require_once ABSPATH . WPINC . '/l10n.php';
708 require_once ABSPATH . WPINC . '/locale.php';
711 require_once ABSPATH . WPINC . '/plugin.php';
713 $locales = $locations = array();
716 if ( defined( 'WPLANG' ) ) {
722 if ( isset( $wp_local_package ) )
723 $locales[] = $wp_local_package;
728 if ( defined( 'WP_LANG_DIR' ) && @is_dir( WP_LANG_DIR ) )
729 $locations[] = WP_LANG_DIR;
731 if ( defined( 'WP_CONTENT_DIR' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) )
732 $locations[] = WP_CONTENT_DIR . '/languages';
734 if ( @is_dir( ABSPATH . 'wp-content/languages' ) )
735 $locations[] = ABSPATH . 'wp-content/languages';
737 if ( @is_dir( ABSPATH . WPINC . '/languages' ) )
738 $locations[] = ABSPATH . WPINC . '/languages';
743 $locations = array_unique( $locations );
745 foreach ( $locales as $locale ) {
746 foreach ( $locations as $location ) {
747 if ( file_exists( $location . '/' . $locale . '.mo' ) ) {
748 load_textdomain( 'default', $location . '/' . $locale . '.mo' );
749 if ( defined( 'WP_SETUP_CONFIG' ) && file_exists( $location . '/admin-' . $locale . '.mo' ) )
750 load_textdomain( 'default', $location . '/admin-' . $locale . '.mo' );
759 $wp_locale = new WP_Locale();