enmi-conf.org: comparison wp/wp-includes/load.php

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 */
 /**
 * Turn register globals off.
 *
-* @access private
 * @since 2.1.0
-* @return null Will return null if register_globals PHP directive was disabled
+* @access private
+*
+* @return null Will return null if register_globals PHP directive was disabled.
 */
 function wp_unregister_GLOBALS() {
 	if ( !ini_get( 'register_globals' ) )
 		return;
 			unset( $GLOBALS[$k] );
 		}
 }
 /**
-* Fix $_SERVER variables for various setups.
+* Fix `$_SERVER` variables for various setups.
 *
-* @access private
+* @since 3.0.0
-* @since 3.0.0
+* @access private
+*
+* @global string $PHP_SELF The filename of the currently executing script,
+*                          relative to the document root.
 */
 function wp_fix_server_vars() {
 	global $PHP_SELF;
 	$default_server_values = array(
 	);
 	$_SERVER = array_merge( $default_server_values, $_SERVER );
 	// 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'] ) ) ) {
+	if ( empty( $_SERVER['REQUEST_URI'] ) || ( PHP_SAPI != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
 		// IIS Mod-Rewrite
 		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'] ) ) {
+		elseif ( 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'] ) )
 				$_SERVER['PATH_INFO'] = $_SERVER['ORIG_PATH_INFO'];
 	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.
+* 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
-* @since 3.0.0
+* @access private
+*
+* @global string $required_php_version The required PHP version string.
+* @global string $wp_version           The WordPress version string.
 */
 function wp_check_php_mysql_versions() {
 	global $required_php_version, $wp_version;
 	$php_version = phpversion();
 	if ( version_compare( $required_php_version, $php_version, '>' ) ) {
 		wp_load_translations_early();
+		header( 'Content-Type: text/html; charset=utf-8' );
 		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 ) );
 	}
-	if ( ! extension_loaded( 'mysql' ) && ! file_exists( WP_CONTENT_DIR . '/db.php' ) ) {
+	if ( ! extension_loaded( 'mysql' ) && ! extension_loaded( 'mysqli' ) && ! file_exists( WP_CONTENT_DIR . '/db.php' ) ) {
 		wp_load_translations_early();
+		 header( 'Content-Type: text/html; charset=utf-8' );
 		die( __( 'Your PHP installation appears to be missing the MySQL extension which is required by WordPress.' ) );
 	}
 }
 /**
 * Don't load all of WordPress when handling a favicon.ico request.
+*
 * Instead, send the headers for a zero-length favicon and bail.
 *
 * @since 3.0.0
 */
 function wp_favicon_request() {
 		exit;
 	}
 }
 /**
-* Dies with a maintenance message when conditions are met.
+* Die 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
-* @since 3.0.0
+* @access private
+*
+* @global int $upgrading the unix timestamp marking when upgrading WordPress began.
 */
 function wp_maintenance() {
 	if ( !file_exists( ABSPATH . '.maintenance' ) || defined( 'WP_INSTALLING' ) )
 		return;
 <?php
 	die();
 }
 /**
-* PHP 5 standard microtime start capture.
+* Start the WordPress micro-timer.
 *
-* @access private
 * @since 0.71
-* @global float $timestart Seconds from when function is called.
+* @access private
+*
+* @global float $timestart Unix timestamp set at the beginning of the page load.
+* @see timer_stop()
+*
 * @return bool Always returns true.
 */
 function timer_start() {
 	global $timestart;
 	$timestart = microtime( true );
 	return true;
 }
 /**
-* Return and/or display the time from the page start to when function is called.
+* Retrieve or display the time from the page start to when function is called.
-*
-* You can get the results and print them by doing:
-* <code>
-* $nTimePageTookToExecute = timer_stop();
-* echo $nTimePageTookToExecute;
-* </code>
-*
-* Or instead, you can do:
-* <code>
-* timer_stop(1);
-* </code>
-* which will do what the above does. If you need the result, you can assign it to a variable, but
-* in most cases, you only need to echo it.
 *
 * @since 0.71
-* @global float $timestart Seconds from when timer_start() is called
+*
-* @global float $timeend Seconds from when function is called
+* @global float   $timestart Seconds from when timer_start() is called.
-*
+* @global float   $timeend   Seconds from when function is called.
-* @param int $display Use '0' or null to not echo anything and 1 to echo the total time
+*
-* @param int $precision The amount of digits from the right of the decimal to display. Default is 3.
+* @param int|bool $display   Whether to echo or return the results. Accepts 0|false for return,
-* @return float The "second.microsecond" finished time calculation
+*                            1|true for echo. Default 0|false.
-*/
+* @param int      $precision The number of digits from the right of the decimal to display.
-function timer_stop( $display = 0, $precision = 3 ) { // if called like timer_stop(1), will echo $timetotal
+*                            Default 3.
+* @return string The "second.microsecond" finished time calculation. The number is formatted
+*                for human consumption, both localized and rounded.
+*/
+function timer_stop( $display = 0, $precision = 3 ) {
 	global $timestart, $timeend;
 	$timeend = microtime( true );
 	$timetotal = $timeend - $timestart;
 	$r = ( function_exists( 'number_format_i18n' ) ) ? number_format_i18n( $timetotal, $precision ) : number_format( $timetotal, $precision );
 	if ( $display )
 		echo $r;
 	return $r;
 }
 /**
-* Sets PHP error handling and handles WordPress debug mode.
+* Set PHP error reporting based on WordPress debug settings.
 *
-* Uses three constants: WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. All three can be
+* Uses three constants: `WP_DEBUG`, `WP_DEBUG_DISPLAY`, and `WP_DEBUG_LOG`.
-* defined in wp-config.php. Example: <code> define( 'WP_DEBUG', true ); </code>
+* All three can be defined in wp-config.php, and by default are set to false.
 *
-* WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.
+* When `WP_DEBUG` is true, all PHP notices are reported. WordPress will also
-* WP_DEBUG defaults to false.
+* display internal notices: when a deprecated WordPress function, function
-*
+* argument, or file is used. Deprecated code may be removed from a later
-* When WP_DEBUG is true, all PHP notices are reported. WordPress will also display
+* version.
-* notices, including one when a deprecated WordPress function, function argument,
+*
-* or file is used. Deprecated code may be removed from a later version.
+* It is strongly recommended that plugin and theme developers use `WP_DEBUG`
-*
+* in their development environments.
-* It is strongly recommended that plugin and theme developers use WP_DEBUG in their
+*
-* development environments.
+* `WP_DEBUG_DISPLAY` and `WP_DEBUG_LOG` perform no function unless `WP_DEBUG`
-*
+* is true.
-* When WP_DEBUG_DISPLAY is true, WordPress will force errors to be displayed.
+*
-* WP_DEBUG_DISPLAY defaults to true. Defining it as null prevents WordPress from
+* When `WP_DEBUG_DISPLAY` is true, WordPress will force errors to be displayed.
-* changing the global configuration setting. Defining WP_DEBUG_DISPLAY as false
+* `WP_DEBUG_DISPLAY` defaults to true. Defining it as null prevents WordPress
-* will force errors to be hidden.
+* from changing the global configuration setting. Defining `WP_DEBUG_DISPLAY`
-*
+* as false will force errors to be hidden.
-* When WP_DEBUG_LOG is true, errors will be logged to wp-content/debug.log.
+*
-* WP_DEBUG_LOG defaults to false.
+* When `WP_DEBUG_LOG` is true, errors will be logged to debug.log in the content
+* directory.
 *
 * Errors are never displayed for XML-RPC requests.
 *
-* @access private
+* @since 3.0.0
-* @since 3.0.0
+* @access private
 */
 function wp_debug_mode() {
 	if ( WP_DEBUG ) {
 		error_reporting( E_ALL );
 	if ( defined( 'XMLRPC_REQUEST' ) )
 		ini_set( 'display_errors', 0 );
 }
 /**
-* Sets the location of the language directory.
+* Set the location of the language directory.
 *
-* To set directory manually, define <code>WP_LANG_DIR</code> in wp-config.php.
+* To set directory manually, define the `WP_LANG_DIR` constant
-*
+* in wp-config.php.
-* If the language directory exists within WP_CONTENT_DIR, that is used.
+*
-* Otherwise if the language directory exists within WPINC, that's used.
+* If the language directory exists within `WP_CONTENT_DIR`, it
-* Finally, if neither of the preceding directories are found,
+* is used. Otherwise the language directory is assumed to live
-* WP_CONTENT_DIR/languages is used.
+* in `WPINC`.
 *
-* The WP_LANG_DIR constant was introduced in 2.1.0.
+* @since 3.0.0
-*
+* @access private
-* @access private
-* @since 3.0.0
 */
 function wp_set_lang_dir() {
 	if ( !defined( 'WP_LANG_DIR' ) ) {
 		if ( file_exists( WP_CONTENT_DIR . '/languages' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) || !@is_dir(ABSPATH . WPINC . '/languages') ) {
-			define( 'WP_LANG_DIR', WP_CONTENT_DIR . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH
+			/**
+			 * Server path of the language directory.
+			 *
+			 * No leading slash, no trailing slash, full path, not relative to ABSPATH
+			 *
+			 * @since 2.1.0
+			 */
+			define( 'WP_LANG_DIR', WP_CONTENT_DIR . '/languages' );
 			if ( !defined( 'LANGDIR' ) ) {
 				// Old static relative path maintained for limited backwards compatibility - won't work in some cases
 				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
+			/**
+			 * Server path of the language directory.
+			 *
+			 * No leading slash, no trailing slash, full path, not relative to `ABSPATH`.
+			 *
+			 * @since 2.1.0
+			 */
+			define( 'WP_LANG_DIR', ABSPATH . WPINC . '/languages' );
 			if ( !defined( 'LANGDIR' ) ) {
 				// Old relative path maintained for backwards compatibility
 				define( 'LANGDIR', WPINC . '/languages' );
 			}
 		}
 	}
 }
 /**
-* Load the correct database class file.
+* Load the database class file and instantiate the `$wpdb` global.
-*
-* This function is used to load the database class file either at runtime or by
-* wp-admin/setup-config.php. We must globalize $wpdb to ensure that it is
-* defined globally by the inline code in wp-db.php.
 *
 * @since 2.5.0
-* @global $wpdb WordPress Database Object
+*
+* @global wpdb $wpdb The WordPress database class.
 */
 function require_wp_db() {
 	global $wpdb;
 	require_once( ABSPATH . WPINC . '/wp-db.php' );
 	$wpdb = new wpdb( DB_USER, DB_PASSWORD, DB_NAME, DB_HOST );
 }
 /**
-* Sets the database table prefix and the format specifiers for database table columns.
+* Set the database table prefix and the format specifiers for database
-*
+* table columns.
-* Columns not listed here default to %s.
+*
-*
+* Columns not listed here default to `%s`.
-* @see wpdb::$field_types Since 2.8.0
+*
-* @see wpdb::prepare()
+* @since 3.0.0
-* @see wpdb::insert()
+* @access private
-* @see wpdb::update()
+*
-* @see wpdb::set_prefix()
+* @global wpdb   $wpdb         The WordPress database class.
-*
+* @global string $table_prefix The database table prefix.
-* @access private
-* @since 3.0.0
 */
 function wp_set_wpdb_vars() {
 	global $wpdb, $table_prefix;
 	if ( !empty( $wpdb->error ) )
 		dead_db();
 		wp_die( __( '<strong>ERROR</strong>: <code>$table_prefix</code> in <code>wp-config.php</code> can only contain numbers, letters, and underscores.' ) );
 	}
 }
 /**
-* Access/Modify private global variable $_wp_using_ext_object_cache
+* Access/Modify private global variable `$_wp_using_ext_object_cache`.
 *
-* Toggle $_wp_using_ext_object_cache on and off without directly touching global
+* Toggle `$_wp_using_ext_object_cache` on and off without directly
+* touching global.
 *
 * @since 3.7.0
 *
-* @param bool $using Whether external object cache is being used
+* @param bool $using Whether external object cache is being used.
-* @return bool The current 'using' setting
+* @return bool The current 'using' setting.
 */
 function wp_using_ext_object_cache( $using = null ) {
 	global $_wp_using_ext_object_cache;
 	$current_using = $_wp_using_ext_object_cache;
 	if ( null !== $using )
 		$_wp_using_ext_object_cache = $using;
 	return $current_using;
 }
 /**
-* Starts the WordPress object cache.
+* Start 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
-* @since 3.0.0
+* @access private
+*
+* @global int $blog_id Blog ID.
 */
 function wp_start_object_cache() {
 	global $blog_id;
 	$first_init = false;
 			if ( function_exists( 'wp_cache_init' ) )
 				wp_using_ext_object_cache( true );
 		}
 		$first_init = true;
-	} else if ( ! wp_using_ext_object_cache() && file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
+	} elseif ( ! wp_using_ext_object_cache() && file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
-		// Sometimes advanced-cache.php can load object-cache.php before it is loaded here.
+		/*
-		// This breaks the function_exists check above and can result in $_wp_using_ext_object_cache
+		 * Sometimes advanced-cache.php can load object-cache.php before
-		// being set incorrectly. Double check if an external cache exists.
+		 * it is loaded here. This breaks the function_exists check above
+		 * and can result in `$_wp_using_ext_object_cache` being set
+		 * incorrectly. Double check if an external cache exists.
+		 */
 		wp_using_ext_object_cache( true );
 	}
 	if ( ! wp_using_ext_object_cache() )
 		require_once ( ABSPATH . WPINC . '/cache.php' );
-	// If cache supports reset, reset instead of init if already initialized.
+	/*
-	// Reset signals to the cache that global IDs have changed and it may need to update keys
+	 * If cache supports reset, reset instead of init if already
-	// and cleanup caches.
+	 * initialized. Reset signals to the cache that global IDs
+	 * have changed and it may need to update keys and cleanup caches.
+	 */
 	if ( ! $first_init && function_exists( 'wp_cache_switch_to_blog' ) )
 		wp_cache_switch_to_blog( $blog_id );
 	elseif ( function_exists( 'wp_cache_init' ) )
 		wp_cache_init();
 	if ( function_exists( 'wp_cache_add_global_groups' ) ) {
-		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' ) );
+		wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'site-lookup', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache' ) );
 		wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) );
 	}
 }
 /**
-* Redirects to the installer if WordPress is not installed.
+* Redirect to the installer if WordPress is not installed.
 *
-* Dies with an error message when multisite is enabled.
+* Dies with an error message when Multisite is enabled.
 *
-* @access private
+* @since 3.0.0
-* @since 3.0.0
+* @access private
 */
 function wp_not_installed() {
 	if ( is_multisite() ) {
-		if ( ! is_blog_installed() && ! defined( 'WP_INSTALLING' ) )
+		if ( ! is_blog_installed() && ! defined( 'WP_INSTALLING' ) ) {
+			nocache_headers();
 			wp_die( __( 'The site you have requested is not installed properly. Please contact the system administrator.' ) );
-	} elseif ( ! is_blog_installed() && false === strpos( $_SERVER['PHP_SELF'], 'install.php' ) && !defined( 'WP_INSTALLING' ) ) {
+		}
+	} elseif ( ! is_blog_installed() && ! defined( 'WP_INSTALLING' ) ) {
+		nocache_headers();
 		require( ABSPATH . WPINC . '/kses.php' );
 		require( ABSPATH . WPINC . '/pluggable.php' );
 		require( ABSPATH . WPINC . '/formatting.php' );
 		$link = wp_guess_url() . '/wp-admin/install.php';
 		die();
 	}
 }
 /**
-* Returns array of must-use plugin files to be included in global scope.
+* Retrieve an array of must-use plugin files.
 *
-* The default directory is wp-content/mu-plugins. To change the default directory
+* The default directory is wp-content/mu-plugins. To change the default
-* manually, define <code>WPMU_PLUGIN_DIR</code> and <code>WPMU_PLUGIN_URL</code>
+* directory manually, define `WPMU_PLUGIN_DIR` and `WPMU_PLUGIN_URL`
 * in wp-config.php.
 *
-* @access private
+* @since 3.0.0
-* @since 3.0.0
+* @access private
-* @return array Files to include
+*
+* @return array Files to include.
 */
 function wp_get_mu_plugins() {
 	$mu_plugins = array();
 	if ( !is_dir( WPMU_PLUGIN_DIR ) )
 		return $mu_plugins;
 	return $mu_plugins;
 }
 /**
-* Returns array of plugin files to be included in global scope.
+* Retrieve an array of active and valid plugin files.
 *
-* The default directory is wp-content/plugins. To change the default directory
+* While upgrading or installing WordPress, no plugins are returned.
-* manually, define <code>WP_PLUGIN_DIR</code> and <code>WP_PLUGIN_URL</code>
+*
+* 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
-* @since 3.0.0
+* @access private
-* @return array Files to include
+*
+* @return array Files.
 */
 function wp_get_active_and_valid_plugins() {
 	$plugins = array();
 	$active_plugins = (array) get_option( 'active_plugins', array() );
 	}
 	return $plugins;
 }
 /**
-* Sets internal encoding using mb_internal_encoding().
+* Set internal encoding.
 *
-* In most cases the default internal encoding is latin1, which is of no use,
+* In most cases the default internal encoding is latin1, which is
-* since we want to use the mb_ functions for utf-8 strings.
+* of no use, since we want to use the `mb_` functions for `utf-8` strings.
 *
-* @access private
+* @since 3.0.0
-* @since 3.0.0
+* @access private
 */
 function wp_set_internal_encoding() {
 	if ( function_exists( 'mb_internal_encoding' ) ) {
 		$charset = get_option( 'blog_charset' );
 		if ( ! $charset || ! @mb_internal_encoding( $charset ) )
 			mb_internal_encoding( 'UTF-8' );
 	}
 }
 /**
-* Add magic quotes to $_GET, $_POST, $_COOKIE, and $_SERVER.
+* Add magic quotes to `$_GET`, `$_POST`, `$_COOKIE`, and `$_SERVER`.
 *
-* Also forces $_REQUEST to be $_GET + $_POST. If $_SERVER, $_COOKIE,
+* Also forces `$_REQUEST` to be `$_GET + $_POST`. If `$_SERVER`,
-* or $_ENV are needed, use those superglobals directly.
+* `$_COOKIE`, or `$_ENV` are needed, use those superglobals directly.
 *
-* @access private
+* @since 3.0.0
-* @since 3.0.0
+* @access private
 */
 function wp_magic_quotes() {
 	// If already slashed, strip.
 	if ( get_magic_quotes_gpc() ) {
 		$_GET    = stripslashes_deep( $_GET    );
 }
 /**
 * Runs just before PHP shuts down execution.
 *
-* @access private
 * @since 1.2.0
+* @access private
 */
 function shutdown_action_hook() {
 	/**
 	 * Fires just before PHP shuts down execution.
 	 *
 	 * @since 1.2.0
 	 */
 	do_action( 'shutdown' );
 	wp_cache_close();
 }
 /**
 * Copy an object.
 *
 * @since 2.7.0
-* @deprecated 3.2
+* @deprecated 3.2.0
 *
-* @param object $object The object to clone
+* @param object $object The object to clone.
-* @return object The cloned object
+* @return object The cloned object.
 */
 function wp_clone( $object ) {
 	// Use parens for clone to accommodate PHP 4. See #17880
 	return clone( $object );
 }
 /**
-* Whether the current request is for a network or blog admin page
+* Whether the current request is for an administrative interface page.
 *
-* Does not inform on whether the user is an admin! Use capability checks to
+* Does not check if the user is an administrator; {@see current_user_can()}
-* tell if the user should be accessing a section or not.
+* for checking roles and capabilities.
 *
 * @since 1.5.1
 *
-* @return bool True if inside WordPress administration pages.
+* @return bool True if inside WordPress administration interface, false otherwise.
 */
 function is_admin() {
 	if ( isset( $GLOBALS['current_screen'] ) )
 		return $GLOBALS['current_screen']->in_admin();
 	elseif ( defined( 'WP_ADMIN' ) )
 	return false;
 }
 /**
-* Whether the current request is for a blog admin screen /wp-admin/
+* Whether the current request is for a site's admininstrative interface.
 *
-* Does not inform on whether the user is a blog admin! Use capability checks to
+* e.g. `/wp-admin/`
-* tell if the user should be accessing a section or not.
+*
+* Does not check if the user is an administrator; {@see current_user_can()}
+* for checking roles and capabilities.
 *
 * @since 3.1.0
 *
-* @return bool True if inside WordPress network administration pages.
+* @return bool True if inside WordPress blog administration pages.
 */
 function is_blog_admin() {
 	if ( isset( $GLOBALS['current_screen'] ) )
 		return $GLOBALS['current_screen']->in_admin( 'site' );
 	elseif ( defined( 'WP_BLOG_ADMIN' ) )
 	return false;
 }
 /**
-* Whether the current request is for a network admin screen /wp-admin/network/
+* Whether the current request is for the network administrative interface.
 *
-* Does not inform on whether the user is a network admin! Use capability checks to
+* e.g. `/wp-admin/network/`
-* tell if the user should be accessing a section or not.
+*
+* Does not check if the user is an administrator; {@see current_user_can()}
+* for checking roles and capabilities.
 *
 * @since 3.1.0
 *
 * @return bool True if inside WordPress network administration pages.
 */
 	return false;
 }
 /**
-* Whether the current request is for a user admin screen /wp-admin/user/
+* Whether the current request is for a user admin screen.
 *
-* Does not inform on whether the user is an admin! Use capability checks to
+* e.g. `/wp-admin/user/`
-* tell if the user should be accessing a section or not.
+*
+* Does not inform on whether the user is an admin! Use capability
+* checks to tell if the user should be accessing a section or not
+* {@see current_user_can()}.
 *
 * @since 3.1.0
 *
 * @return bool True if inside WordPress user administration pages.
 */
 	return false;
 }
 /**
-* Whether Multisite support is enabled
+* If Multisite is enabled.
 *
 * @since 3.0.0
 *
-* @return bool True if multisite is enabled, false otherwise.
+* @return bool True if Multisite is enabled, false otherwise.
 */
 function is_multisite() {
 	if ( defined( 'MULTISITE' ) )
 		return MULTISITE;
 	return false;
 }
 /**
-* Retrieve the current blog id
+* Retrieve the current blog ID.
 *
 * @since 3.1.0
 *
 * @return int Blog id
 */
 	global $blog_id;
 	return absint($blog_id);
 }
 /**
-* Attempts an early load of translations.
+* Attempt an early load of translations.
 *
-* Used for errors encountered during the initial loading process, before the locale has been
+* Used for errors encountered during the initial loading process, before
-* properly detected and loaded.
+* the locale has been properly detected and loaded.
 *
-* Designed for unusual load sequences (like setup-config.php) or for when the script will then
+* Designed for unusual load sequences (like setup-config.php) or for when
-* terminate with an error, otherwise there is a risk that a file can be double-included.
+* the script will then terminate with an error, otherwise there is a risk
+* that a file can be double-included.
 *
 * @since 3.4.0
 * @access private
+*
+* @global $wp_locale The WordPress date and time locale object.
 */
 function wp_load_translations_early() {
 	global $text_direction, $wp_locale;
 	static $loaded = false;

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001