From 506c22bfd53ac9983faa8f5931c990e6c816446e Mon Sep 17 00:00:00 2001 From: ryan Date: Tue, 19 Jan 2010 17:27:03 +0000 Subject: [PATCH] phpdoc for load.php, return some includes to global scope. Props nacin. see #11881 git-svn-id: http://svn.automattic.com/wordpress/trunk@12762 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/load.php | 427 ++++++++++++++++++++++++---------------- wp-includes/ms-load.php | 91 +++++---- wp-settings.php | 229 +++++++++++++-------- 3 files changed, 440 insertions(+), 307 deletions(-) diff --git a/wp-includes/load.php b/wp-includes/load.php index 4b4ae6ceb5..476d09bc4a 100644 --- a/wp-includes/load.php +++ b/wp-includes/load.php @@ -14,44 +14,50 @@ * @return null Will return null if register_globals PHP directive was disabled */ function wp_unregister_GLOBALS() { - if ( !ini_get('register_globals') ) + if ( !ini_get( 'register_globals' ) ) return; - if ( isset($_REQUEST['GLOBALS']) ) - die('GLOBALS overwrite attempt detected'); + if ( isset( $_REQUEST['GLOBALS'] ) ) + die( 'GLOBALS overwrite attempt detected' ); // Variables that shouldn't be unset - $noUnset = array('GLOBALS', '_GET', '_POST', '_COOKIE', '_REQUEST', '_SERVER', '_ENV', '_FILES', 'table_prefix'); + $noUnset = array( 'GLOBALS', '_GET', '_POST', '_COOKIE', '_REQUEST', '_SERVER', '_ENV', '_FILES', 'table_prefix' ); - $input = array_merge($_GET, $_POST, $_COOKIE, $_SERVER, $_ENV, $_FILES, isset($_SESSION) && is_array($_SESSION) ? $_SESSION : array()); + $input = array_merge( $_GET, $_POST, $_COOKIE, $_SERVER, $_ENV, $_FILES, isset( $_SESSION ) && is_array( $_SESSION ) ? $_SESSION : array() ); foreach ( $input as $k => $v ) - if ( !in_array($k, $noUnset) && isset($GLOBALS[$k]) ) { + if ( !in_array( $k, $noUnset ) && isset( $GLOBALS[$k] ) ) { $GLOBALS[$k] = NULL; - unset($GLOBALS[$k]); + unset( $GLOBALS[$k] ); } } +/** + * Fix $_SERVER variables for various setups. + * + * @access private + * @since 3.0.0 + */ function wp_fix_server_vars() { global $PHP_SELF; // Fix for IIS when running with PHP ISAPI if ( empty( $_SERVER['REQUEST_URI'] ) || ( php_sapi_name() != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) { // IIS Mod-Rewrite - if (isset($_SERVER['HTTP_X_ORIGINAL_URL'])) { + if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) { $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL']; } // IIS Isapi_Rewrite - else if (isset($_SERVER['HTTP_X_REWRITE_URL'])) { + else if ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) { $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL']; } else { // Use ORIG_PATH_INFO if there is no PATH_INFO - if ( !isset($_SERVER['PATH_INFO']) && isset($_SERVER['ORIG_PATH_INFO']) ) + if ( !isset( $_SERVER['PATH_INFO'] ) && isset( $_SERVER['ORIG_PATH_INFO'] ) ) $_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO']; // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice) - if ( isset($_SERVER['PATH_INFO']) ) { + if ( isset( $_SERVER['PATH_INFO'] ) ) { if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] ) $_SERVER['REQUEST_URI'] = $_SERVER['PATH_INFO']; else @@ -59,26 +65,34 @@ function wp_fix_server_vars() { } // Append the query string if it exists and isn't null - if (isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING'])) { + if ( isset( $_SERVER['QUERY_STRING'] ) && !empty( $_SERVER['QUERY_STRING'] ) ) { $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING']; } } } // Fix for PHP as CGI hosts that set SCRIPT_FILENAME to something ending in php.cgi for all requests - if ( isset($_SERVER['SCRIPT_FILENAME']) && ( strpos($_SERVER['SCRIPT_FILENAME'], 'php.cgi') == strlen($_SERVER['SCRIPT_FILENAME']) - 7 ) ) + if ( isset( $_SERVER['SCRIPT_FILENAME'] ) && ( strpos( $_SERVER['SCRIPT_FILENAME'], 'php.cgi' ) == strlen( $_SERVER['SCRIPT_FILENAME'] ) - 7 ) ) $_SERVER['SCRIPT_FILENAME'] = $_SERVER['PATH_TRANSLATED']; // Fix for Dreamhost and other PHP as CGI hosts - if (strpos($_SERVER['SCRIPT_NAME'], 'php.cgi') !== false) - unset($_SERVER['PATH_INFO']); + if ( strpos( $_SERVER['SCRIPT_NAME'], 'php.cgi' ) !== false ) + unset( $_SERVER['PATH_INFO'] ); // Fix empty PHP_SELF $PHP_SELF = $_SERVER['PHP_SELF']; - if ( empty($PHP_SELF) ) - $_SERVER['PHP_SELF'] = $PHP_SELF = preg_replace("/(\?.*)?$/",'',$_SERVER["REQUEST_URI"]); + if ( empty( $PHP_SELF ) ) + $_SERVER['PHP_SELF'] = $PHP_SELF = preg_replace( "/(\?.*)?$/",'',$_SERVER["REQUEST_URI"] ); } +/** + * Check for the required PHP version, and the MySQL extension or a database drop-in. + * + * Dies if requirements are not met. + * + * @access private + * @since 3.0.0 + */ function wp_check_php_mysql_versions() { // we can probably extend this function to check if wp_die() exists then use translated strings, and then use it in install.php etc. @@ -87,27 +101,45 @@ function wp_check_php_mysql_versions() { if ( version_compare( $required_php_version, $php_version, '>' ) ) die( sprintf( /*WP_I18N_OLD_PHP*/'Your server is running PHP version %1$s but WordPress %2%s requires at least %2%s.'/*/WP_I18N_OLD_PHP*/, $php_version, $wp_version, $required_php_version ) ); - if ( !extension_loaded('mysql') && !file_exists(WP_CONTENT_DIR . '/db.php') ) + if ( !extension_loaded( 'mysql' ) && !file_exists( WP_CONTENT_DIR . '/db.php' ) ) die( /*WP_I18N_OLD_MYSQL*/'Your PHP installation appears to be missing the MySQL extension which is required by WordPress.'/*/WP_I18N_OLD_MYSQL*/ ); } +/** + * Dies with a maintenance message when conditions are met. + * + * Checks for a file in the WordPress root directory named ".maintenance". + * This file will contain the variable $upgrading, set to the time the file + * was created. If the file was created less than 10 minutes ago, WordPress + * enters maintenance mode and displays a message. + * + * The default message can be replaced by using a drop-in (maintenance.php in + * the wp-content directory). + * + * @access private + * @since 3.0.0 + */ function wp_maintenance() { - if ( file_exists(ABSPATH . '.maintenance') && !defined('WP_INSTALLING') ) { - include(ABSPATH . '.maintenance'); - // If the $upgrading timestamp is older than 10 minutes, don't die. - if ( ( time() - $upgrading ) < 600 ) { - if ( file_exists( WP_CONTENT_DIR . '/maintenance.php' ) ) { - require_once( WP_CONTENT_DIR . '/maintenance.php' ); - die(); - } + if ( !file_exists( ABSPATH . '.maintenance' ) || defined( 'WP_INSTALLING' ) ) + return; - $protocol = $_SERVER["SERVER_PROTOCOL"]; - if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol ) - $protocol = 'HTTP/1.0'; - header( "$protocol 503 Service Unavailable", true, 503 ); - header( 'Content-Type: text/html; charset=utf-8' ); - header( 'Retry-After: 600' ); - ?> + include( ABSPATH . '.maintenance' ); + // If the $upgrading timestamp is older than 10 minutes, don't die. + if ( ( time() - $upgrading ) >= 600 ) + return; + + if ( file_exists( WP_CONTENT_DIR . '/maintenance.php' ) ) { + require_once( WP_CONTENT_DIR . '/maintenance.php' ); + die(); + } + + $protocol = $_SERVER["SERVER_PROTOCOL"]; + if ( 'HTTP/1.1' != $protocol && 'HTTP/1.0' != $protocol ) + $protocol = 'HTTP/1.0'; + header( "$protocol 503 Service Unavailable", true, 503 ); + header( 'Content-Type: text/html; charset=utf-8' ); + header( 'Retry-After: 600' ); +?> @@ -119,10 +151,8 @@ function wp_maintenance() {

Briefly unavailable for scheduled maintenance. Check back in a minute.

- define('WP_DEBUG', true); to wp-config.php to enable + * the reporting of notices during development. + * + * Add define('WP_DEBUG_DISPLAY', false); to wp-config.php to + * disable the display of errors. + * + * Add define('WP_DEBUG_LOG', true); to wp-config.php to log + * eerrors to debug.log in the wp-content directory. + * + * @access private + * @since 3.0.0 + */ function wp_debug_mode() { if ( WP_DEBUG ) { - if ( defined('E_DEPRECATED') ) - error_reporting(E_ALL & ~E_DEPRECATED & ~E_STRICT); + if ( defined( 'E_DEPRECATED' ) ) + error_reporting( E_ALL & ~E_DEPRECATED & ~E_STRICT ); else - error_reporting(E_ALL); + error_reporting( E_ALL ); if ( WP_DEBUG_DISPLAY ) - ini_set('display_errors', 1); + ini_set( 'display_errors', 1 ); if ( WP_DEBUG_LOG ) { - ini_set('log_errors', 1); - ini_set('error_log', WP_CONTENT_DIR . '/debug.log'); + ini_set( 'log_errors', 1 ); + ini_set( 'error_log', WP_CONTENT_DIR . '/debug.log' ); } } else { - if ( defined('E_RECOVERABLE_ERROR') ) - error_reporting(E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING | E_RECOVERABLE_ERROR); + if ( defined( 'E_RECOVERABLE_ERROR' ) ) + error_reporting( E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING | E_RECOVERABLE_ERROR ); else - error_reporting(E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING); + error_reporting( E_ERROR | E_WARNING | E_PARSE | E_USER_ERROR | E_USER_WARNING ); } } +/** + * Sets the location of the language directory. + * + * To set directory manually, define WP_LANG_DIR in wp-config.php. + * + * First looks for language folder in WP_CONTENT_DIR and uses that folder if it + * exists. Or it uses the "languages" folder in WPINC. + * + * The WP_LANG_DIR constant was introduced in 2.1.0. + * + * @access private + * @since 3.0.0 + */ function wp_set_lang_dir() { - if ( !defined('WP_LANG_DIR') ) { - /** - * Stores the location of the language directory. First looks for language folder in WP_CONTENT_DIR - * and uses that folder if it exists. Or it uses the "languages" folder in WPINC. - * - * @since 2.1.0 - */ - if ( file_exists(WP_CONTENT_DIR . '/languages') && @is_dir(WP_CONTENT_DIR . '/languages') ) { - define('WP_LANG_DIR', WP_CONTENT_DIR . '/languages'); // no leading slash, no trailing slash, full path, not relative to ABSPATH - if (!defined('LANGDIR')) { + if ( !defined( 'WP_LANG_DIR' ) ) { + if ( file_exists( WP_CONTENT_DIR . '/languages' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) ) { + define( 'WP_LANG_DIR', WP_CONTENT_DIR . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH + if ( !defined( 'LANGDIR' ) ) { // Old static relative path maintained for limited backwards compatibility - won't work in some cases - define('LANGDIR', 'wp-content/languages'); + define( 'LANGDIR', 'wp-content/languages' ); } } else { - define('WP_LANG_DIR', ABSPATH . WPINC . '/languages'); // no leading slash, no trailing slash, full path, not relative to ABSPATH - if (!defined('LANGDIR')) { + define( 'WP_LANG_DIR', ABSPATH . WPINC . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH + if ( !defined( 'LANGDIR' ) ) { // Old relative path maintained for backwards compatibility - define('LANGDIR', WPINC . '/languages'); + define( 'LANGDIR', WPINC . '/languages' ); } } } } +/** + * Sets the database table prefix and the format specifiers for database table columns. + * + * Columns not listed here default to %s. + * + * @see wpdb::$field_types Since 2.8.0 + * @see wpdb::prepare() + * @see wpdb::insert() + * @see wpdb::update() + * @see wpdb::set_prefix() + * + * @access private + * @since 3.0.0 + */ function wp_set_wpdb_vars() { global $wpdb, $table_prefix; - if ( !empty($wpdb->error) ) + if ( !empty( $wpdb->error ) ) dead_db(); - /** - * Format specifiers for DB columns. Columns not listed here default to %s. - * @since 2.8.0 - * @see wpdb:$field_types - * @see wpdb:prepare() - * @see wpdb:insert() - * @see wpdb:update() - */ $wpdb->field_types = array( 'post_author' => '%d', 'post_parent' => '%d', 'menu_order' => '%d', 'term_id' => '%d', 'term_group' => '%d', 'term_taxonomy_id' => '%d', 'parent' => '%d', 'count' => '%d','object_id' => '%d', 'term_order' => '%d', 'ID' => '%d', 'commment_ID' => '%d', 'comment_post_ID' => '%d', 'comment_parent' => '%d', 'user_id' => '%d', 'link_id' => '%d', 'link_owner' => '%d', 'link_rating' => '%d', 'option_id' => '%d', 'blog_id' => '%d', 'meta_id' => '%d', 'post_id' => '%d', - 'user_status' => '%d', 'umeta_id' => '%d', 'comment_karma' => '%d', 'comment_count' => '%d'); + 'user_status' => '%d', 'umeta_id' => '%d', 'comment_karma' => '%d', 'comment_count' => '%d' ); - $prefix = $wpdb->set_prefix($table_prefix); - - if ( is_wp_error($prefix) ) - wp_die(/*WP_I18N_BAD_PREFIX*/'ERROR: $table_prefix in wp-config.php can only contain numbers, letters, and underscores.'/*/WP_I18N_BAD_PREFIX*/); + $prefix = $wpdb->set_prefix( $table_prefix ); + if ( is_wp_error( $prefix ) ) + wp_die( /*WP_I18N_BAD_PREFIX*/'ERROR: $table_prefix in wp-config.php can only contain numbers, letters, and underscores.'/*/WP_I18N_BAD_PREFIX*/ ); } +/** + * Starts the WordPress object cache. + * + * If an object-cache.php file exists in the wp-content directory, + * it uses that drop-in as an external object cache. + * + * @access private + * @since 3.0.0 + */ function wp_start_object_cache() { global $_wp_using_ext_object_cache; - if ( file_exists(WP_CONTENT_DIR . '/object-cache.php') ) { - require_once (WP_CONTENT_DIR . '/object-cache.php'); + if ( file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) { + require_once ( WP_CONTENT_DIR . '/object-cache.php' ); $_wp_using_ext_object_cache = true; } else { - require_once (ABSPATH . WPINC . '/cache.php'); + require_once ( ABSPATH . WPINC . '/cache.php' ); $_wp_using_ext_object_cache = false; } wp_cache_init(); - - if ( function_exists('wp_cache_add_global_groups') ) { - wp_cache_add_global_groups(array ('users', 'userlogins', 'usermeta', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss')); - wp_cache_add_non_persistent_groups(array( 'comment', 'counts', 'plugins' )); + if ( function_exists( 'wp_cache_add_global_groups' ) ) { + wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss' ) ); + wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) ); } } +/** + * Redirects to the installer if WordPress is not installed. + * + * Dies with an error message when multisite is enabled. + * + * @access private + * @since 3.0.0 + */ function wp_not_installed() { if ( is_multisite() ) { - if ( !is_blog_installed() && !defined('WP_INSTALLING') ) - die( __( 'The blog you have requested is not installed properly. Please contact the system administrator.' ) ); // have to die here - } elseif ( !is_blog_installed() && (strpos($_SERVER['PHP_SELF'], 'install.php') === false && !defined('WP_INSTALLING')) ) { - if ( defined('WP_SITEURL') ) + if ( !is_blog_installed() && !defined( 'WP_INSTALLING' ) ) + wp_die( __( 'The blog you have requested is not installed properly. Please contact the system administrator.' ) ); + } elseif ( !is_blog_installed() && ( strpos( $_SERVER['PHP_SELF'], 'install.php' ) === false && !defined( 'WP_INSTALLING' ) ) ) { + if ( defined( 'WP_SITEURL' ) ) $link = WP_SITEURL . '/wp-admin/install.php'; - elseif (strpos($_SERVER['PHP_SELF'], 'wp-admin') !== false) - $link = preg_replace('|/wp-admin/?.*?$|', '/', $_SERVER['PHP_SELF']) . 'wp-admin/install.php'; + elseif ( strpos( $_SERVER['PHP_SELF'], 'wp-admin' ) !== false ) + $link = preg_replace( '|/wp-admin/?.*?$|', '/', $_SERVER['PHP_SELF'] ) . 'wp-admin/install.php'; else - $link = preg_replace('|/[^/]+?$|', '/', $_SERVER['PHP_SELF']) . 'wp-admin/install.php'; - require_once(ABSPATH . WPINC . '/kses.php'); - require_once(ABSPATH . WPINC . '/pluggable.php'); - require_once(ABSPATH . WPINC . '/formatting.php'); - wp_redirect($link); + $link = preg_replace( '|/[^/]+?$|', '/', $_SERVER['PHP_SELF'] ) . 'wp-admin/install.php'; + require_once( ABSPATH . WPINC . '/kses.php' ); + require_once( ABSPATH . WPINC . '/pluggable.php' ); + require_once( ABSPATH . WPINC . '/formatting.php' ); + wp_redirect( $link ); die(); } } -function wp_load_mu_plugins() { - if ( is_dir( WPMU_PLUGIN_DIR ) ) { - if ( $dh = opendir( WPMU_PLUGIN_DIR ) ) { - $mu_plugins = array (); - while ( ( $plugin = readdir( $dh ) ) !== false ) { - if ( substr( $plugin, -4 ) == '.php' ) - $mu_plugins[] = $plugin; - } - closedir( $dh ); - sort( $mu_plugins ); - foreach ( $mu_plugins as $mu_plugin ) - include_once( WPMU_PLUGIN_DIR . '/' . $mu_plugin ); - } +/** + * Returns array of must-use plugin files to be included in global scope. + * + * The default directory is wp-content/mu-plugins. To change the default directory + * manually, define WPMU_PLUGIN_DIR and WPMU_PLUGIN_URL + * in wp-config.php. + * + * @access private + * @since 3.0.0 + * @return array Files to include + */ +function wp_muplugins_to_load() { + $mu_plugins = array(); + if ( !is_dir( WPMU_PLUGIN_DIR ) ) + return $mu_plugins; + if ( ! $dh = opendir( WPMU_PLUGIN_DIR ) ) + return $mu_plugins; + while ( ( $plugin = readdir( $dh ) ) !== false ) { + if ( substr( $plugin, -4 ) == '.php' ) + $mu_plugins[] = WPMU_PLUGIN_DIR . '/' . $plugin; } + closedir( $dh ); + sort( $mu_plugins ); + + return $mu_plugins; } -function wp_load_plugins() { +/** + * Returns array of plugin files to be included in global scope. + * + * The default directory is wp-content/plugins. To change the default directory + * manually, define WP_PLUGIN_DIR and WP_PLUGIN_URL + * in wp-config.php. + * + * @access private + * @since 3.0.0 + * @return array Files to include + */ +function wp_plugins_to_load() { + $plugins = array(); + // Check for hacks file if the option is enabled - if ( get_option('hack_file') ) { - if ( file_exists(ABSPATH . 'my-hacks.php') ) - require(ABSPATH . 'my-hacks.php'); - } + if ( get_option( 'hack_file' ) && file_exists( ABSPATH . 'my-hacks.php' ) ) + $plugins[] = ABSPATH . 'my-hacks.php'; - $current_plugins = apply_filters( 'active_plugins', get_option( 'active_plugins' ) ); - if ( is_array($current_plugins) && !defined('WP_INSTALLING') ) { - foreach ( $current_plugins as $plugin ) { - // check the $plugin filename - // Validate plugin filename - if ( validate_file($plugin) // $plugin must validate as file - || '.php' != substr($plugin, -4) // $plugin must end with '.php' - || !file_exists(WP_PLUGIN_DIR . '/' . $plugin) // $plugin must exist - ) - continue; - - include_once(WP_PLUGIN_DIR . '/' . $plugin); - } - unset($plugin); + $active_plugins = apply_filters( 'active_plugins', get_option( 'active_plugins' ) ); + if ( !is_array( $active_plugins ) || defined( 'WP_INSTALLING' ) ) + return $plugins; + foreach ( $active_plugins as $plugin ) { + if ( validate_file( $plugin ) // $plugin must validate as file + || '.php' != substr( $plugin, -4 ) // $plugin must end with '.php' + || !file_exists( WP_PLUGIN_DIR . '/' . $plugin ) // $plugin must exist + ) + continue; + $plugins[] = WP_PLUGIN_DIR . '/' . $plugin; } - unset($current_plugins); + return $plugins; } +/** + * Sets internal encoding using mb_internal_encoding(). + * + * In most cases the default internal encoding is latin1, which is of no use, + * since we want to use the mb_ functions for utf-8 strings. + * + * @access private + * @since 3.0.0 + */ function wp_set_internal_encoding() { - /* - * In most cases the default internal encoding is latin1, which is of no use, - * since we want to use the mb_ functions for utf-8 strings - */ - if (function_exists('mb_internal_encoding')) { - if (!@mb_internal_encoding(get_option('blog_charset'))) - mb_internal_encoding('UTF-8'); + if ( function_exists( 'mb_internal_encoding' ) ) { + if ( !@mb_internal_encoding( get_option( 'blog_charset' ) ) ) + mb_internal_encoding( 'UTF-8' ); } } +/** + * Add magic quotes to $_GET, $_POST, $_COOKIE, and $_SERVER. + * + * Also forces $_REQUEST to be $_GET + $_POST. If $_SERVER, $_COOKIE, + * or $_ENV are needed, use those superglobals directly. + * + * @access private + * @since 3.0.0 + */ function wp_magic_quotes() { // If already slashed, strip. if ( get_magic_quotes_gpc() ) { - $_GET = stripslashes_deep($_GET ); - $_POST = stripslashes_deep($_POST ); - $_COOKIE = stripslashes_deep($_COOKIE); + $_GET = stripslashes_deep( $_GET ); + $_POST = stripslashes_deep( $_POST ); + $_COOKIE = stripslashes_deep( $_COOKIE ); } // Escape with wpdb. - $_GET = add_magic_quotes($_GET ); - $_POST = add_magic_quotes($_POST ); - $_COOKIE = add_magic_quotes($_COOKIE); - $_SERVER = add_magic_quotes($_SERVER); + $_GET = add_magic_quotes( $_GET ); + $_POST = add_magic_quotes( $_POST ); + $_COOKIE = add_magic_quotes( $_COOKIE ); + $_SERVER = add_magic_quotes( $_SERVER ); - // Force REQUEST to be GET + POST. If SERVER, COOKIE, or ENV are needed, use those superglobals directly. - $_REQUEST = array_merge($_GET, $_POST); -} - -function wp_find_locale() { - global $locale, $locale_file; - /** - * The locale of the blog - * @since 1.5.0 - */ - $locale = get_locale(); - $locale_file = WP_LANG_DIR . "/$locale.php"; - if ( is_readable($locale_file) ) - require_once($locale_file); - - // Pull in locale data after loading text domain. - require_once(ABSPATH . WPINC . '/locale.php'); -} - -function wp_load_theme_functions() { - // Load functions for active theme. - if ( TEMPLATEPATH !== STYLESHEETPATH && file_exists(STYLESHEETPATH . '/functions.php') ) - include(STYLESHEETPATH . '/functions.php'); - if ( file_exists(TEMPLATEPATH . '/functions.php') ) - include(TEMPLATEPATH . '/functions.php'); - - // Load in support for template functions which the theme supports - require_if_theme_supports( 'post-thumbnails', ABSPATH . WPINC . '/post-thumbnail-template.php' ); + // Force REQUEST to be GET + POST. + $_REQUEST = array_merge( $_GET, $_POST ); } /** @@ -389,7 +468,7 @@ function wp_load_theme_functions() { * @since 1.2.0 */ function shutdown_action_hook() { - do_action('shutdown'); + do_action( 'shutdown' ); wp_cache_close(); } @@ -422,7 +501,7 @@ function wp_clone( $object ) { * @return bool True if inside WordPress administration pages. */ function is_admin() { - if ( defined('WP_ADMIN') ) + if ( defined( 'WP_ADMIN' ) ) return WP_ADMIN; return false; } @@ -435,7 +514,7 @@ function is_admin() { * @return bool True if multisite is enabled, false otherwise. */ function is_multisite() { - if ( ( defined('MULTISITE') && MULTISITE ) || defined('VHOST') || defined('SUNRISE') ) + if ( ( defined( 'MULTISITE' ) && MULTISITE ) || defined( 'VHOST' ) || defined( 'SUNRISE' ) ) return true; return false; diff --git a/wp-includes/ms-load.php b/wp-includes/ms-load.php index 11b4ffa48c..77c69b84fc 100644 --- a/wp-includes/ms-load.php +++ b/wp-includes/ms-load.php @@ -13,9 +13,9 @@ if( defined( 'SUNRISE' ) ) include_once( WP_CONTENT_DIR . '/sunrise.php' ); - require (ABSPATH . WPINC . '/ms-settings.php'); -$wpdb->blogid = $current_blog->blog_id; -$wpdb->siteid = $current_blog->site_id; + require( ABSPATH . WPINC . '/ms-settings.php' ); +$wpdb->blogid = $current_blog->blog_id; +$wpdb->siteid = $current_blog->site_id; $wpdb->set_prefix($table_prefix); // set up blog tables $table_prefix = $wpdb->get_blog_prefix(); @@ -40,56 +40,57 @@ if( !defined( "BLOGUPLOADDIR" ) ) define( "BLOGUPLOADDIR", WP_CONTENT_DIR . "/blogs.dir/{$wpdb->blogid}/files/" ); function ms_network_settings() { - global $wpdb, $current_site, $cookiehash; + global $wpdb, $current_site, $cookiehash; - if( !isset($current_site->site_name) ) - $current_site->site_name = get_site_option('site_name'); + if( !isset($current_site->site_name) ) + $current_site->site_name = get_site_option('site_name'); - if( $current_site->site_name == false ) - $current_site->site_name = ucfirst( $current_site->domain ); + if( $current_site->site_name == false ) + $current_site->site_name = ucfirst( $current_site->domain ); - if ( ! defined('WP_INSTALLING') ) { - // Used to guarantee unique hash cookies - if ( !isset($cookiehash) ) - $cookiehash = ''; + if ( ! defined('WP_INSTALLING') ) { + if ( !isset($cookiehash) ) + $cookiehash = ''; - /** - * Used to guarantee unique hash cookies - * @since 1.5 - */ - if ( !defined('COOKIEHASH') ) - define( 'COOKIEHASH', $cookiehash ); - } + /** + * Used to guarantee unique hash cookies + * @since 1.5 + */ + if ( !defined('COOKIEHASH') ) + define( 'COOKIEHASH', $cookiehash ); + } - $wpdb->hide_errors(); + $wpdb->hide_errors(); } function ms_network_plugins() { - $wpmu_sitewide_plugins = (array) maybe_unserialize( get_site_option( 'wpmu_sitewide_plugins' ) ); - foreach( $wpmu_sitewide_plugins as $plugin_file => $activation_time ) { - if ( !$plugin_file ) - continue; + $network_plugins = array(); + $wpmu_sitewide_plugins = (array) maybe_unserialize( get_site_option( 'wpmu_sitewide_plugins' ) ); + foreach( $wpmu_sitewide_plugins as $plugin_file => $activation_time ) { + if ( !$plugin_file ) + continue; - if ( !file_exists( WP_PLUGIN_DIR . '/' . $plugin_file ) ) { - $deleted_sitewide_plugins[] = $plugin_file; - } else { - include_once( WP_PLUGIN_DIR . '/' . $plugin_file ); - } - } + if ( !file_exists( WP_PLUGIN_DIR . '/' . $plugin_file ) ) { + $deleted_sitewide_plugins[] = $plugin_file; + } else { + $network_plugins = WP_PLUGIN_DIR . '/' . $plugin_file; + } + } - if ( isset( $deleted_sitewide_plugins ) ) { - $active_sitewide_plugins = maybe_unserialize( get_site_option( 'active_sitewide_plugins' ) ); + if ( isset( $deleted_sitewide_plugins ) ) { + $active_sitewide_plugins = maybe_unserialize( get_site_option( 'active_sitewide_plugins' ) ); - /* Remove any deleted plugins from the wpmu_sitewide_plugins array */ - foreach( $deleted_sitewide_plugins as $plugin_file ) { - unset( $wpmu_sitewide_plugins[$plugin_file] ); - unset( $active_sitewide_plugins[$plugin_file] ); - } + /* Remove any deleted plugins from the wpmu_sitewide_plugins array */ + foreach( $deleted_sitewide_plugins as $plugin_file ) { + unset( $wpmu_sitewide_plugins[$plugin_file] ); + unset( $active_sitewide_plugins[$plugin_file] ); + } - update_site_option( 'wpmu_sitewide_plugins', $wpmu_sitewide_plugins ); - update_site_option( 'active_sitewide_plugins', $wpmu_sitewide_plugins ); - } + update_site_option( 'wpmu_sitewide_plugins', $wpmu_sitewide_plugins ); + update_site_option( 'active_sitewide_plugins', $wpmu_sitewide_plugins ); + } + return $network_plugins; } function ms_site_check() { @@ -99,8 +100,7 @@ function ms_site_check() { if ( '1' == $current_blog->deleted ) { if ( file_exists( WP_CONTENT_DIR . '/blog-deleted.php' ) ) { - require_once( WP_CONTENT_DIR . '/blog-deleted.php' ); - die(); + return WP_CONTENT_DIR . '/blog-deleted.php'; } else { header('HTTP/1.1 410 Gone'); graceful_fail(__('This user has elected to delete their account and the content is no longer available.')); @@ -109,8 +109,7 @@ function ms_site_check() { if ( '2' == $current_blog->deleted ) { if ( file_exists( WP_CONTENT_DIR . '/blog-inactive.php' ) ) { - require_once( WP_CONTENT_DIR . '/blog-inactive.php' ); - die(); + return WP_CONTENT_DIR . '/blog-inactive.php'; } else { graceful_fail( sprintf( __( 'This blog has not been activated yet. If you are having problems activating your blog, please contact %1$s.' ), str_replace( '@', ' AT ', get_site_option( 'admin_email', "support@{$current_site->domain}" ) ) ) ); } @@ -118,13 +117,13 @@ function ms_site_check() { if( $current_blog->archived == '1' || $current_blog->spam == '1' ) { if ( file_exists( WP_CONTENT_DIR . '/blog-suspended.php' ) ) { - require_once( WP_CONTENT_DIR . '/blog-suspended.php' ); - die(); + return WP_CONTENT_DIR . '/blog-suspended.php'; } else { header('HTTP/1.1 410 Gone'); graceful_fail(__('This blog has been archived or suspended.')); } } + return true; } function ms_network_cookies() { diff --git a/wp-settings.php b/wp-settings.php index ad581b9a55..7a5519ad6a 100644 --- a/wp-settings.php +++ b/wp-settings.php @@ -13,152 +13,191 @@ * * @since 1.0.0 */ -define('WPINC', 'wp-includes'); +define( 'WPINC', 'wp-includes' ); -require (ABSPATH . WPINC . '/load.php'); -require (ABSPATH . WPINC . '/default-constants.php'); -require (ABSPATH . WPINC . '/version.php'); +// Include files required for initialization. +require( ABSPATH . WPINC . '/load.php' ); +require( ABSPATH . WPINC . '/default-constants.php' ); +require( ABSPATH . WPINC . '/version.php' ); -wp_default_constants('init'); +// Set initial default constants including WP_MEMORY_LIMIT, WP_DEBUG, WP_CONTENT_DIR and WP_CACHE. +wp_default_constants( 'init' ); -set_magic_quotes_runtime(0); -@ini_set('magic_quotes_sybase', 0); +// Disable magic quotes at runtime. Magic quotes are added using wpdb later in wp-settings.php. +set_magic_quotes_runtime( 0 ); +@ini_set( 'magic_quotes_sybase', 0 ); -if ( function_exists('date_default_timezone_set') ) - date_default_timezone_set('UTC'); +// Set default timezone in PHP 5. +if ( function_exists( 'date_default_timezone_set' ) ) + date_default_timezone_set( 'UTC' ); +// Turn register_globals off. wp_unregister_GLOBALS(); +// Ensure these global variables do not exist so they do not interfere with WordPress. unset( $wp_filter, $cache_lastcommentmodified, $cache_lastpostdate ); +// Standardize $_SERVER variables across setups. wp_fix_server_vars(); +// Check for the required PHP version and for the MySQL extension or a database drop-in. wp_check_php_mysql_versions(); +// Check if we're in maintenance mode. wp_maintenance(); +// Start loading timer. timer_start(); +// Check if we're in WP_DEBUG mode. wp_debug_mode(); -// For an advanced caching plugin to use, static because you would only want one +// For an advanced caching plugin to use. Uses a static drop-in because you would only want one. if ( WP_CACHE ) @include WP_CONTENT_DIR . '/advanced-cache.php'; +// Define WP_LANG_DIR if not set. wp_set_lang_dir(); -require (ABSPATH . WPINC . '/compat.php'); -require (ABSPATH . WPINC . '/functions.php'); -require (ABSPATH . WPINC . '/classes.php'); +// Include early WordPress files. +require( ABSPATH . WPINC . '/compat.php' ); +require( ABSPATH . WPINC . '/functions.php' ); +require( ABSPATH . WPINC . '/classes.php' ); +// Include the wpdb class, or a db.php database drop-in if present. require_wp_db(); +// Set the database table prefix and the format specifiers for database table columns. wp_set_wpdb_vars(); +// Start the WordPress object cache, or an external object cache if the drop-in is present. wp_start_object_cache(); +// Initialize multisite if enabled. if ( is_multisite() ) - require (ABSPATH . WPINC . '/ms-load.php'); + require( ABSPATH . WPINC . '/ms-load.php' ); -require (ABSPATH . WPINC . '/plugin.php'); -require (ABSPATH . WPINC . '/default-filters.php'); -include_once(ABSPATH . WPINC . '/pomo/mo.php'); +// Load early WordPress files. +require( ABSPATH . WPINC . '/plugin.php' ); +require( ABSPATH . WPINC . '/default-filters.php' ); +include_once( ABSPATH . WPINC . '/pomo/mo.php' ); -if ( SHORTINIT ) // stop most of WP being loaded, we just want the basics +// Stop most of WordPress from being loaded if we just want the basics. +if ( SHORTINIT ) return false; -require_once (ABSPATH . WPINC . '/l10n.php'); +// Load the l18n library. +require_once ( ABSPATH . WPINC . '/l10n.php' ); +// Run the installer if WordPress is not installed. wp_not_installed(); -require (ABSPATH . WPINC . '/formatting.php'); -require (ABSPATH . WPINC . '/capabilities.php'); -require (ABSPATH . WPINC . '/query.php'); -require (ABSPATH . WPINC . '/theme.php'); -require (ABSPATH . WPINC . '/user.php'); -require (ABSPATH . WPINC . '/meta.php'); -require (ABSPATH . WPINC . '/general-template.php'); -require (ABSPATH . WPINC . '/link-template.php'); -require (ABSPATH . WPINC . '/author-template.php'); -require (ABSPATH . WPINC . '/post.php'); -require (ABSPATH . WPINC . '/post-template.php'); -require (ABSPATH . WPINC . '/category.php'); -require (ABSPATH . WPINC . '/category-template.php'); -require (ABSPATH . WPINC . '/comment.php'); -require (ABSPATH . WPINC . '/comment-template.php'); -require (ABSPATH . WPINC . '/rewrite.php'); -require (ABSPATH . WPINC . '/feed.php'); -require (ABSPATH . WPINC . '/bookmark.php'); -require (ABSPATH . WPINC . '/bookmark-template.php'); -require (ABSPATH . WPINC . '/kses.php'); -require (ABSPATH . WPINC . '/cron.php'); -require (ABSPATH . WPINC . '/deprecated.php'); -require (ABSPATH . WPINC . '/script-loader.php'); -require (ABSPATH . WPINC . '/taxonomy.php'); -require (ABSPATH . WPINC . '/update.php'); -require (ABSPATH . WPINC . '/canonical.php'); -require (ABSPATH . WPINC . '/shortcodes.php'); -require (ABSPATH . WPINC . '/media.php'); -require (ABSPATH . WPINC . '/http.php'); -require (ABSPATH . WPINC . '/widgets.php'); +// Load most of WordPress. +require( ABSPATH . WPINC . '/formatting.php' ); +require( ABSPATH . WPINC . '/capabilities.php' ); +require( ABSPATH . WPINC . '/query.php' ); +require( ABSPATH . WPINC . '/theme.php' ); +require( ABSPATH . WPINC . '/user.php' ); +require( ABSPATH . WPINC . '/meta.php' ); +require( ABSPATH . WPINC . '/general-template.php' ); +require( ABSPATH . WPINC . '/link-template.php' ); +require( ABSPATH . WPINC . '/author-template.php' ); +require( ABSPATH . WPINC . '/post.php' ); +require( ABSPATH . WPINC . '/post-template.php' ); +require( ABSPATH . WPINC . '/category.php' ); +require( ABSPATH . WPINC . '/category-template.php' ); +require( ABSPATH . WPINC . '/comment.php' ); +require( ABSPATH . WPINC . '/comment-template.php' ); +require( ABSPATH . WPINC . '/rewrite.php' ); +require( ABSPATH . WPINC . '/feed.php' ); +require( ABSPATH . WPINC . '/bookmark.php' ); +require( ABSPATH . WPINC . '/bookmark-template.php' ); +require( ABSPATH . WPINC . '/kses.php' ); +require( ABSPATH . WPINC . '/cron.php' ); +require( ABSPATH . WPINC . '/deprecated.php' ); +require( ABSPATH . WPINC . '/script-loader.php' ); +require( ABSPATH . WPINC . '/taxonomy.php' ); +require( ABSPATH . WPINC . '/update.php' ); +require( ABSPATH . WPINC . '/canonical.php' ); +require( ABSPATH . WPINC . '/shortcodes.php' ); +require( ABSPATH . WPINC . '/media.php' ); +require( ABSPATH . WPINC . '/http.php' ); +require( ABSPATH . WPINC . '/widgets.php' ); +// Load multisite-specific files. if ( is_multisite() ) { require_once( ABSPATH . WPINC . '/ms-functions.php' ); require_once( ABSPATH . WPINC . '/ms-default-filters.php' ); require_once( ABSPATH . WPINC . '/ms-deprecated.php' ); } -wp_default_constants('wp_included'); +// Define constants that rely on the API to obtain the default value. +wp_default_constants( 'wp_included' ); +// Set up multisite if enabled. if ( is_multisite() ) - ms_network_settings(); + ms_network_settings(); -wp_default_constants('ms_network_settings_loaded'); +// Define must-use plugin directory constants, which may be overridden in the sunrise.php drop-in. +wp_default_constants( 'ms_network_settings_loaded' ); -wp_load_mu_plugins(); +// Load must-use plugins. +foreach( wp_muplugins_to_load() as $mu_plugin ) + include_once( $mu_plugin ); +unset( $mu_plugin ); -/** - * Used to load network wide plugins - * @since 3.0 - */ -if ( is_multisite() ) - ms_network_plugins(); - -do_action('muplugins_loaded'); - -/** - * Used to check site status - * @since 3.0 - */ +// Load network-wide plugins if multisite. if ( is_multisite() ) { - ms_site_check(); + foreach ( ms_network_plugins() as $plugin_file ) + include_once( $plugin_file ); + unset( $plugin_file ); +} + +do_action( 'muplugins_loaded' ); + +// Check site status if multisite. +if ( is_multisite() ) { + if ( true !== ( $file = ms_site_check() ) ) { + require_once( $file ); + die(); + } ms_network_cookies(); } -wp_default_constants('ms_loaded'); +// Define constants after multisite is loaded. Cookie-related constants may be overridden in ms_network_cookies(). +wp_default_constants( 'ms_loaded' ); -require (ABSPATH . WPINC . '/vars.php'); +// Create common globals. +require( ABSPATH . WPINC . '/vars.php' ); -// make taxonomies available to plugins and themes -// @plugin authors: warning: this gets registered again on the init hook +// Make taxonomies available to plugins and themes. +// @plugin authors: warning: this gets registered again on the init hook. create_initial_taxonomies(); -wp_load_plugins(); +// Load active plugins. +foreach( wp_plugins_to_load() as $plugin ) + include_once( $plugin ); +unset( $plugin ); -require (ABSPATH . WPINC . '/pluggable.php'); +// Load pluggable functions. +require( ABSPATH . WPINC . '/pluggable.php' ); +// Set internal encoding. wp_set_internal_encoding(); -if ( WP_CACHE && function_exists('wp_cache_postload') ) +// Run wp_cache_postload() if object cache is enabled and the function exists. +if ( WP_CACHE && function_exists( 'wp_cache_postload' ) ) wp_cache_postload(); -do_action('plugins_loaded'); +do_action( 'plugins_loaded' ); -wp_default_constants('plugins_loaded'); +// Define WP_POST_REVISIONS if not already defined. +wp_default_constants( 'plugins_loaded' ); +// Add magic quotes and set up $_REQUEST ( $_GET + $_POST ) wp_magic_quotes(); -do_action('sanitize_comment_cookies'); +do_action( 'sanitize_comment_cookies' ); /** * WordPress Query object @@ -173,21 +212,21 @@ $wp_the_query =& new WP_Query(); * @global object $wp_query * @since 1.5.0 */ -$wp_query =& $wp_the_query; +$wp_query =& $wp_the_query; /** * Holds the WordPress Rewrite object for creating pretty URLs * @global object $wp_rewrite * @since 1.5.0 */ -$wp_rewrite =& new WP_Rewrite(); +$wp_rewrite =& new WP_Rewrite(); /** * WordPress Object * @global object $wp * @since 2.0.0 */ -$wp =& new WP(); +$wp =& new WP(); /** * WordPress Widget Factory Object @@ -196,14 +235,22 @@ $wp =& new WP(); */ $wp_widget_factory =& new WP_Widget_Factory(); -do_action('setup_theme'); +do_action( 'setup_theme' ); -wp_default_constants('setup_theme'); +// Define the TEMPLATEPATH and STYLESHEETPATH constants. +wp_default_constants( 'setup_theme' ); // Load the default text localization domain. load_default_textdomain(); -wp_find_locale(); +// Find the blog locale. +$locale = get_locale(); +$locale_file = WP_LANG_DIR . "/$locale.php"; +if ( is_readable( $locale_file ) ) + require_once( $locale_file ); + +// Pull in locale data after loading text domain. +require_once( ABSPATH . WPINC . '/locale.php' ); /** * WordPress Locale object for loading locale domain date and various strings. @@ -212,13 +259,21 @@ wp_find_locale(); */ $wp_locale =& new WP_Locale(); -wp_load_theme_functions(); +// Load the functions for the active theme, for both parent and child theme if applicable. +if ( TEMPLATEPATH !== STYLESHEETPATH && file_exists( STYLESHEETPATH . '/functions.php' ) ) + include( STYLESHEETPATH . '/functions.php' ); +if ( file_exists( TEMPLATEPATH . '/functions.php' ) ) + include( TEMPLATEPATH . '/functions.php' ); -register_shutdown_function('shutdown_action_hook'); +// Load any template functions the theme supports. +require_if_theme_supports( 'post-thumbnails', ABSPATH . WPINC . '/post-thumbnail-template.php' ); -$wp->init(); // Sets up current user. +register_shutdown_function( 'shutdown_action_hook' ); + +// Set up current user. +$wp->init(); // Everything is loaded and initialized. -do_action('init'); +do_action( 'init' ); ?> \ No newline at end of file