golem
/
twentyGOLEM
9
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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
This commit is contained in:
ryan 2010-01-19 17:27:03 +00:00
parent 7e294fd282
commit 506c22bfd5
3 changed files with 440 additions and 307 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

227
wp-includes/load.php
View File

@ -31,6 +31,12 @@ function wp_unregister_GLOBALS() {
}
}
/**
* 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
@ -79,6 +85,14 @@ function wp_fix_server_vars() {
$_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.
@ -91,11 +105,29 @@ function wp_check_php_mysql_versions() {
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') ) {
if ( !file_exists( ABSPATH . '.maintenance' ) || defined( 'WP_INSTALLING' ) )
return;
include( ABSPATH . '.maintenance' );
// If the $upgrading timestamp is older than 10 minutes, don't die.
if ( ( time() - $upgrading ) < 600 ) {
if ( ( time() - $upgrading ) >= 600 )
return;
if ( file_exists( WP_CONTENT_DIR . '/maintenance.php' ) ) {
require_once( WP_CONTENT_DIR . '/maintenance.php' );
die();
@ -122,8 +154,6 @@ function wp_maintenance() {
<?php
die();
}
}
}
/**
* PHP 4 standard microtime start capture.
@ -178,6 +208,21 @@ function timer_stop($display = 0, $precision = 3) { //if called like timer_stop(
return $r;
}
/**
* Sets PHP error handling.
*
* Add <code>define('WP_DEBUG', true);</code> to wp-config.php to enable
* the reporting of notices during development.
*
* Add <code>define('WP_DEBUG_DISPLAY', false);</code> to wp-config.php to
* disable the display of errors.
*
* Add <code>define('WP_DEBUG_LOG', true);</code> 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' ) )
@ -200,14 +245,21 @@ function wp_debug_mode() {
}
}
/**
* Sets the location of the language directory.
*
* To set directory manually, define <code>WP_LANG_DIR</code> 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' ) ) {
@ -224,19 +276,25 @@ function wp_set_lang_dir() {
}
}
/**
* 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 ) )
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',
@ -246,9 +304,17 @@ function wp_set_wpdb_vars() {
if ( is_wp_error( $prefix ) )
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*/ );
}
/**
* 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' ) ) {
@ -260,17 +326,24 @@ function wp_start_object_cache() {
}
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' ) );
}
}
/**
* 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
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';
@ -286,58 +359,90 @@ function wp_not_installed() {
}
}
function wp_load_mu_plugins() {
if ( is_dir( WPMU_PLUGIN_DIR ) ) {
if ( $dh = opendir( WPMU_PLUGIN_DIR ) ) {
/**
* 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 <code>WPMU_PLUGIN_DIR</code> and <code>WPMU_PLUGIN_URL</code>
* 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[] = $plugin;
$mu_plugins[] = WPMU_PLUGIN_DIR . '/' . $plugin;
}
closedir( $dh );
sort( $mu_plugins );
foreach ( $mu_plugins as $mu_plugin )
include_once( WPMU_PLUGIN_DIR . '/' . $mu_plugin );
}
}
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 <code>WP_PLUGIN_DIR</code> and <code>WP_PLUGIN_URL</code>
* 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
$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;
include_once(WP_PLUGIN_DIR . '/' . $plugin);
$plugins[] = WP_PLUGIN_DIR . '/' . $plugin;
}
unset($plugin);
}
unset($current_plugins);
return $plugins;
}
function wp_set_internal_encoding() {
/*
/**
* 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
* since we want to use the mb_ functions for utf-8 strings.
*
* @access private
* @since 3.0.0
*/
function wp_set_internal_encoding() {
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() ) {
@ -352,36 +457,10 @@ function wp_magic_quotes() {
$_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.
// Force REQUEST to be GET + POST.
$_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' );
}
/**
* Runs just before PHP shuts down execution.
*

15
wp-includes/ms-load.php
View File

@ -49,7 +49,6 @@ function ms_network_settings() {
$current_site->site_name = ucfirst( $current_site->domain );
if ( ! defined('WP_INSTALLING') ) {
// Used to guarantee unique hash cookies
if ( !isset($cookiehash) )
$cookiehash = '';
@ -65,6 +64,7 @@ function ms_network_settings() {
}
function ms_network_plugins() {
$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 )
@ -73,7 +73,7 @@ function ms_network_plugins() {
if ( !file_exists( WP_PLUGIN_DIR . '/' . $plugin_file ) ) {
$deleted_sitewide_plugins[] = $plugin_file;
} else {
include_once( WP_PLUGIN_DIR . '/' . $plugin_file );
$network_plugins = WP_PLUGIN_DIR . '/' . $plugin_file;
}
}
@ -90,6 +90,7 @@ function ms_network_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 <a href="mailto:%1$s">%1$s</a>.' ), 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() {

95
wp-settings.php
View File

@ -15,62 +15,84 @@
*/
define( 'WPINC', 'wp-includes' );
// Include files required for initialization.
require( ABSPATH . WPINC . '/load.php' );
require( ABSPATH . WPINC . '/default-constants.php' );
require( ABSPATH . WPINC . '/version.php' );
// Set initial default constants including WP_MEMORY_LIMIT, WP_DEBUG, WP_CONTENT_DIR and WP_CACHE.
wp_default_constants( 'init' );
// 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 );
// 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();
// 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' );
// 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;
// Load the l18n library.
require_once ( ABSPATH . WPINC . '/l10n.php' );
// Run the installer if WordPress is not installed.
wp_not_installed();
// Load most of WordPress.
require( ABSPATH . WPINC . '/formatting.php' );
require( ABSPATH . WPINC . '/capabilities.php' );
require( ABSPATH . WPINC . '/query.php' );
@ -102,60 +124,77 @@ 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' );
}
// 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();
// 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();
// Load network-wide plugins if multisite.
if ( is_multisite() ) {
foreach ( ms_network_plugins() as $plugin_file )
include_once( $plugin_file );
unset( $plugin_file );
}
do_action( 'muplugins_loaded' );
/**
* Used to check site status
* @since 3.0
*/
// Check site status if multisite.
if ( is_multisite() ) {
ms_site_check();
if ( true !== ( $file = ms_site_check() ) ) {
require_once( $file );
die();
}
ms_network_cookies();
}
// Define constants after multisite is loaded. Cookie-related constants may be overridden in ms_network_cookies().
wp_default_constants( 'ms_loaded' );
// 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 );
// Load pluggable functions.
require( ABSPATH . WPINC . '/pluggable.php' );
// Set internal encoding.
wp_set_internal_encoding();
// 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' );
// 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' );
@ -198,12 +237,20 @@ $wp_widget_factory =& new WP_Widget_Factory();
do_action( '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,11 +259,19 @@ 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' );
// Load any template functions the theme supports.
require_if_theme_supports( 'post-thumbnails', ABSPATH . WPINC . '/post-thumbnail-template.php' );
register_shutdown_function( 'shutdown_action_hook' );
$wp->init(); // Sets up current user.
// Set up current user.
$wp->init();
// Everything is loaded and initialized.
do_action( 'init' );