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( /*WP_I18N_GLOBALS_OVERWRITE*/'GLOBALS overwrite attempt detected'/*/WP_I18N_GLOBALS_OVERWRITE*/ );
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] ) ) {
31 unset( $GLOBALS[$k] );
36 * Fix $_SERVER variables for various setups.
41 function wp_fix_server_vars() {
44 $default_server_values = array(
45 'SERVER_SOFTWARE' => '',
49 $_SERVER = array_merge( $default_server_values, $_SERVER );
51 // Fix for IIS when running with PHP ISAPI
52 if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
55 if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
56 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
59 else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
60 $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
62 // Use ORIG_PATH_INFO if there is no PATH_INFO
63 if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) )
64 $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
66 // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
67 if ( isset( $_SERVER['PATH_INFO'] ) ) {
68 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] )
69 $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO'];
71 $_SERVER['REQUEST_URI'] = $_SERVER['SCRIPT_NAME'] . $_SERVER['PATH_INFO'];
74 // Append the query string if it exists and isn't null
75 if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
76 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
81 // Fix for PHP as CGI hosts that set SCRIPT_FILENAME to something ending in php.cgi for all requests
82 if ( isset( $_SERVER['SCRIPT_FILENAME'] ) && ( strpos( $_SERVER['SCRIPT_FILENAME'], 'php.cgi' ) == strlen( $_SERVER['SCRIPT_FILENAME'] ) - 7 ) )
83 $_SERVER['SCRIPT_FILENAME'] = $_SERVER['PATH_TRANSLATED'];
85 // Fix for Dreamhost and other PHP as CGI hosts
86 if ( strpos( $_SERVER['SCRIPT_NAME'], 'php.cgi' ) !== false )
87 unset( $_SERVER['PATH_INFO'] );
90 $PHP_SELF = $_SERVER['PHP_SELF'];
91 if ( empty( $PHP_SELF ) )
92 $_SERVER['PHP_SELF'] = $PHP_SELF = preg_replace( '/(\?.*)?$/', '', $_SERVER["REQUEST_URI"] );
96 * Check for the required PHP version, and the MySQL extension or a database drop-in.
98 * Dies if requirements are not met.
100 * This function must be able to work without a complete environment set up. In wp-load.php, for
101 * example, WP_CONTENT_DIR is defined and version.php is included before this function is called.
106 function wp_check_php_mysql_versions() {
107 // we can probably extend this function to check if wp_die() exists then use translated strings, and then use it in install.php etc.
109 global $required_php_version, $wp_version;
110 $php_version = phpversion();
111 if ( version_compare( $required_php_version, $php_version, '>' ) )
112 die( sprintf( /*WP_I18N_OLD_PHP*/'Your server is running PHP version %1$s but WordPress %2$s requires at least %3$s.'/*/WP_I18N_OLD_PHP*/, $php_version, $wp_version, $required_php_version ) );
114 if ( !extension_loaded( 'mysql' ) && !file_exists( WP_CONTENT_DIR . '/db.php' ) )
115 die( /*WP_I18N_OLD_MYSQL*/'Your PHP installation appears to be missing the MySQL extension which is required by WordPress.'/*/WP_I18N_OLD_MYSQL*/ );
119 * Don't load all of WordPress when handling a favicon.ico request.
120 * Instead, send the headers for a zero-length favicon and bail.
124 function wp_favicon_request() {
125 if ( '/favicon.ico' == $_SERVER['REQUEST_URI'] ) {
126 header('Content-Type: image/vnd.microsoft.icon');
127 header('Content-Length: 0');
133 * Dies with a maintenance message when conditions are met.
135 * Checks for a file in the WordPress root directory named ".maintenance".
136 * This file will contain the variable $upgrading, set to the time the file
137 * was created. If the file was created less than 10 minutes ago, WordPress
138 * enters maintenance mode and displays a message.
140 * The default message can be replaced by using a drop-in (maintenance.php in
141 * the wp-content directory).
146 function wp_maintenance() {
147 if ( !file_exists( ABSPATH . '.maintenance' ) || defined( 'WP_INSTALLING' ) )
152 include( ABSPATH . '.maintenance' );
153 // If the $upgrading timestamp is older than 10 minutes, don't die.
154 if ( ( time() - $upgrading ) >= 600 )
157 if ( file_exists( WP_CONTENT_DIR . '/maintenance.php' ) ) {
158 require_once( WP_CONTENT_DIR . '/maintenance.php' );
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' );
169 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
170 <html xmlns="http://www.w3.org/1999/xhtml">
172 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
173 <title><?php echo /*WP_I18N_MAINTENANCE*/'Maintenance'/*/WP_I18N_MAINTENANCE*/; ?></title>
177 <h1><?php echo /*WP_I18N_MAINT_MSG*/'Briefly unavailable for scheduled maintenance. Check back in a minute.'/*/WP_I18N_MAINT_MSG*/; ?></h1>
185 * PHP 4 standard microtime start capture.
189 * @global int $timestart Seconds and Microseconds added together from when function is called.
190 * @return bool Always returns true.
192 function timer_start() {
194 $mtime = explode( ' ', microtime() );
195 $timestart = $mtime[1] + $mtime[0];
200 * Return and/or display the time from the page start to when function is called.
202 * You can get the results and print them by doing:
204 * $nTimePageTookToExecute = timer_stop();
205 * echo $nTimePageTookToExecute;
208 * Or instead, you can do:
212 * which will do what the above does. If you need the result, you can assign it to a variable, but
213 * most cases, you only need to echo it.
216 * @global int $timestart Seconds and Microseconds added together from when timer_start() is called
217 * @global int $timeend Seconds and Microseconds added together from when function is called
219 * @param int $display Use '0' or null to not echo anything and 1 to echo the total time
220 * @param int $precision The amount of digits from the right of the decimal to display. Default is 3.
221 * @return float The "second.microsecond" finished time calculation
223 function timer_stop( $display = 0, $precision = 3 ) { // if called like timer_stop(1), will echo $timetotal
224 global $timestart, $timeend;
225 $mtime = microtime();
226 $mtime = explode( ' ', $mtime );
227 $timeend = $mtime[1] + $mtime[0];
228 $timetotal = $timeend - $timestart;
229 $r = ( function_exists( 'number_format_i18n' ) ) ? number_format_i18n( $timetotal, $precision ) : number_format( $timetotal, $precision );
236 * Sets PHP error handling and handles WordPress debug mode.
238 * Uses three constants: WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. All three can be
239 * defined in wp-config.php. Example: <code> define( 'WP_DEBUG', true ); </code>
241 * WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.
242 * WP_DEBUG defaults to false.
244 * When WP_DEBUG is true, all PHP notices are reported. WordPress will also display
245 * notices, including one when a deprecated WordPress function, function argument,
246 * or file is used. Deprecated code may be removed from a later version.
248 * It is strongly recommended that plugin and theme developers use WP_DEBUG in their
249 * development environments.
251 * When WP_DEBUG_DISPLAY is true, WordPress will force errors to be displayed.
252 * WP_DEBUG_DISPLAY defaults to true. Defining it as false prevents WordPress from
253 * changing the global configuration setting. (Defining WP_DEBUG_DISPLAY as false
254 * will never force errors to be hidden.)
256 * When WP_DEBUG_LOG is true, errors will be logged to wp-content/debug.log.
257 * WP_DEBUG_LOG defaults to false.
262 function wp_debug_mode() {
264 // E_DEPRECATED is a core PHP constant in PHP 5.3. Don't define this yourself.
265 // The two statements are equivalent, just one is for 5.3+ and for less than 5.3.
266 if ( defined( 'E_DEPRECATED' ) )
267 error_reporting( E_ALL & ~E_DEPRECATED & ~E_STRICT );
269 error_reporting( E_ALL );
271 if ( WP_DEBUG_DISPLAY )
272 ini_set( 'display_errors', 1 );
274 if ( WP_DEBUG_LOG ) {
275 ini_set( 'log_errors', 1 );
276 ini_set( 'error_log', WP_CONTENT_DIR . '/debug.log' );
279 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 );
284 * Sets the location of the language directory.
286 * To set directory manually, define <code>WP_LANG_DIR</code> in wp-config.php.
288 * If the language directory exists within WP_CONTENT_DIR that is used
289 * Otherwise if the language directory exists within WPINC, that's used
290 * Finally, If neither of the preceeding directories is found,
291 * WP_CONTENT_DIR/languages is used.
293 * The WP_LANG_DIR constant was introduced in 2.1.0.
298 function wp_set_lang_dir() {
299 if ( !defined( 'WP_LANG_DIR' ) ) {
300 if ( file_exists( WP_CONTENT_DIR . '/languages' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) || !@is_dir(ABSPATH . WPINC . '/languages') ) {
301 define( 'WP_LANG_DIR', WP_CONTENT_DIR . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH
302 if ( !defined( 'LANGDIR' ) ) {
303 // Old static relative path maintained for limited backwards compatibility - won't work in some cases
304 define( 'LANGDIR', 'wp-content/languages' );
307 define( 'WP_LANG_DIR', ABSPATH . WPINC . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH
308 if ( !defined( 'LANGDIR' ) ) {
309 // Old relative path maintained for backwards compatibility
310 define( 'LANGDIR', WPINC . '/languages' );
317 * Load the correct database class file.
319 * This function is used to load the database class file either at runtime or by
320 * wp-admin/setup-config.php. We must globalize $wpdb to ensure that it is
321 * defined globally by the inline code in wp-db.php.
324 * @global $wpdb WordPress Database Object
326 function require_wp_db() {
329 require_once( ABSPATH . WPINC . '/wp-db.php' );
330 if ( file_exists( WP_CONTENT_DIR . '/db.php' ) )
331 require_once( WP_CONTENT_DIR . '/db.php' );
333 if ( isset( $wpdb ) )
336 $wpdb = new wpdb( DB_USER, DB_PASSWORD, DB_NAME, DB_HOST );
340 * Sets the database table prefix and the format specifiers for database table columns.
342 * Columns not listed here default to %s.
344 * @see wpdb::$field_types Since 2.8.0
345 * @see wpdb::prepare()
346 * @see wpdb::insert()
347 * @see wpdb::update()
348 * @see wpdb::set_prefix()
353 function wp_set_wpdb_vars() {
354 global $wpdb, $table_prefix;
355 if ( !empty( $wpdb->error ) )
358 $wpdb->field_types = array( 'post_author' => '%d', 'post_parent' => '%d', 'menu_order' => '%d', 'term_id' => '%d', 'term_group' => '%d', 'term_taxonomy_id' => '%d',
359 'parent' => '%d', 'count' => '%d','object_id' => '%d', 'term_order' => '%d', 'ID' => '%d', 'commment_ID' => '%d', 'comment_post_ID' => '%d', 'comment_parent' => '%d',
360 'user_id' => '%d', 'link_id' => '%d', 'link_owner' => '%d', 'link_rating' => '%d', 'option_id' => '%d', 'blog_id' => '%d', 'meta_id' => '%d', 'post_id' => '%d',
361 'user_status' => '%d', 'umeta_id' => '%d', 'comment_karma' => '%d', 'comment_count' => '%d',
363 'active' => '%d', 'cat_id' => '%d', 'deleted' => '%d', 'lang_id' => '%d', 'mature' => '%d', 'public' => '%d', 'site_id' => '%d', 'spam' => '%d',
366 $prefix = $wpdb->set_prefix( $table_prefix );
368 if ( is_wp_error( $prefix ) )
369 wp_die( /*WP_I18N_BAD_PREFIX*/'<strong>ERROR</strong>: <code>$table_prefix</code> in <code>wp-config.php</code> can only contain numbers, letters, and underscores.'/*/WP_I18N_BAD_PREFIX*/ );
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;
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_reset') )
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' ) );
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 if ( !@mb_internal_encoding( get_option( 'blog_charset' ) ) )
516 mb_internal_encoding( 'UTF-8' );
521 * Add magic quotes to $_GET, $_POST, $_COOKIE, and $_SERVER.
523 * Also forces $_REQUEST to be $_GET + $_POST. If $_SERVER, $_COOKIE,
524 * or $_ENV are needed, use those superglobals directly.
529 function wp_magic_quotes() {
530 // If already slashed, strip.
531 if ( get_magic_quotes_gpc() ) {
532 $_GET = stripslashes_deep( $_GET );
533 $_POST = stripslashes_deep( $_POST );
534 $_COOKIE = stripslashes_deep( $_COOKIE );
538 $_GET = add_magic_quotes( $_GET );
539 $_POST = add_magic_quotes( $_POST );
540 $_COOKIE = add_magic_quotes( $_COOKIE );
541 $_SERVER = add_magic_quotes( $_SERVER );
543 // Force REQUEST to be GET + POST.
544 $_REQUEST = array_merge( $_GET, $_POST );
548 * Runs just before PHP shuts down execution.
553 function shutdown_action_hook() {
554 do_action( 'shutdown' );
564 * @param object $object The object to clone
565 * @return object The cloned object
568 function wp_clone( $object ) {
569 // Use parens for clone to accommodate PHP 4. See #17880
570 return clone( $object );
574 * Whether the current request is for a network or blog admin page
576 * Does not inform on whether the user is an admin! Use capability checks to
577 * tell if the user should be accessing a section or not.
581 * @return bool True if inside WordPress administration pages.
583 function is_admin() {
584 if ( defined( 'WP_ADMIN' ) )
590 * Whether the current request is for a blog admin screen /wp-admin/
592 * Does not inform on whether the user is a blog admin! Use capability checks to
593 * tell if the user should be accessing a section or not.
597 * @return bool True if inside WordPress network administration pages.
599 function is_blog_admin() {
600 if ( defined( 'WP_BLOG_ADMIN' ) )
601 return WP_BLOG_ADMIN;
606 * Whether the current request is for a network admin screen /wp-admin/network/
608 * Does not inform on whether the user is a network admin! Use capability checks to
609 * tell if the user should be accessing a section or not.
613 * @return bool True if inside WordPress network administration pages.
615 function is_network_admin() {
616 if ( defined( 'WP_NETWORK_ADMIN' ) )
617 return WP_NETWORK_ADMIN;
622 * Whether the current request is for a user admin screen /wp-admin/user/
624 * Does not inform on whether the user is an admin! Use capability checks to
625 * tell if the user should be accessing a section or not.
629 * @return bool True if inside WordPress user administration pages.
631 function is_user_admin() {
632 if ( defined( 'WP_USER_ADMIN' ) )
633 return WP_USER_ADMIN;
638 * Whether Multisite support is enabled
642 * @return bool True if multisite is enabled, false otherwise.
644 function is_multisite() {
645 if ( defined( 'MULTISITE' ) )
648 if ( defined( 'SUBDOMAIN_INSTALL' ) || defined( 'VHOST' ) || defined( 'SUNRISE' ) )