<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[28656] trunk/src/wp-includes/load.php: Improve inline documentation for wp-includes/load.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/28656">28656</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-06-04 04:11:21 +0000 (Wed, 04 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline documentation for wp-includes/load.php.
Props ericlewis, DrewAPicture.
Fixes <a href="http://core.trac.wordpress.org/ticket/24886">#24886</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesloadphp">trunk/src/wp-includes/load.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesloadphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/load.php (28655 => 28656)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/load.php 2014-06-03 04:51:05 UTC (rev 28655)
+++ trunk/src/wp-includes/load.php 2014-06-04 04:11:21 UTC (rev 28656)
</span><span class="lines">@@ -10,9 +10,10 @@
</span><span class="cx"> /**
</span><span class="cx"> * Turn register globals off.
</span><span class="cx"> *
</span><ins>+ * @since 2.1.0
</ins><span class="cx"> * @access private
</span><del>- * @since 2.1.0
- * @return null Will return null if register_globals PHP directive was disabled
</del><ins>+ *
+ * @return null Will return null if register_globals PHP directive was disabled.
</ins><span class="cx"> */
</span><span class="cx"> function wp_unregister_GLOBALS() {
</span><span class="cx"> if ( !ini_get( 'register_globals' ) )
</span><span class="lines">@@ -32,10 +33,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Fix $_SERVER variables for various setups.
</del><ins>+ * Fix `$_SERVER` variables for various setups.
</ins><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><ins>+ *
+ * @global string $PHP_SELF The filename of the currently executing script,
+ * relative to the document root.
</ins><span class="cx"> */
</span><span class="cx"> function wp_fix_server_vars() {
</span><span class="cx"> global $PHP_SELF;
</span><span class="lines">@@ -92,16 +96,21 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check for the required PHP version, and the MySQL extension or a database drop-in.
</del><ins>+ * Check for the required PHP version, and the MySQL extension or
+ * a database drop-in.
</ins><span class="cx"> *
</span><span class="cx"> * Dies if requirements are not met.
</span><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><ins>+ *
+ * @global string $required_php_version The required PHP version string.
+ * @global string $wp_version The WordPress version string.
</ins><span class="cx"> */
</span><span class="cx"> function wp_check_php_mysql_versions() {
</span><span class="cx"> global $required_php_version, $wp_version;
</span><span class="cx"> $php_version = phpversion();
</span><ins>+
</ins><span class="cx"> if ( version_compare( $required_php_version, $php_version, '>' ) ) {
</span><span class="cx"> wp_load_translations_early();
</span><span class="cx"> header( 'Content-Type: text/html; charset=utf-8' );
</span><span class="lines">@@ -117,6 +126,7 @@
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Don't load all of WordPress when handling a favicon.ico request.
</span><ins>+ *
</ins><span class="cx"> * Instead, send the headers for a zero-length favicon and bail.
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="lines">@@ -130,7 +140,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Dies with a maintenance message when conditions are met.
</del><ins>+ * Die with a maintenance message when conditions are met.
</ins><span class="cx"> *
</span><span class="cx"> * Checks for a file in the WordPress root directory named ".maintenance".
</span><span class="cx"> * This file will contain the variable $upgrading, set to the time the file
</span><span class="lines">@@ -140,8 +150,10 @@
</span><span class="cx"> * The default message can be replaced by using a drop-in (maintenance.php in
</span><span class="cx"> * the wp-content directory).
</span><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><ins>+ *
+ * @global int $upgrading the unix timestamp marking when upgrading WordPress began.
</ins><span class="cx"> */
</span><span class="cx"> function wp_maintenance() {
</span><span class="cx"> if ( !file_exists( ABSPATH . '.maintenance' ) || defined( 'WP_INSTALLING' ) )
</span><span class="lines">@@ -184,11 +196,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * PHP 5 standard microtime start capture.
</del><ins>+ * Start the WordPress micro-timer.
</ins><span class="cx"> *
</span><ins>+ * @since 0.71
</ins><span class="cx"> * @access private
</span><del>- * @since 0.71
- * @global float $timestart Seconds from when function is called.
</del><ins>+ *
+ * @global float $timestart Unix timestamp set at the beginning of the page load.
+ * @see timer_stop()
+ *
</ins><span class="cx"> * @return bool Always returns true.
</span><span class="cx"> */
</span><span class="cx"> function timer_start() {
</span><span class="lines">@@ -223,33 +238,34 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets PHP error handling and handles WordPress debug mode.
</del><ins>+ * Set PHP error reporting based on WordPress debug settings.
</ins><span class="cx"> *
</span><del>- * Uses three constants: WP_DEBUG, WP_DEBUG_DISPLAY, and WP_DEBUG_LOG. All three can be
- * defined in wp-config.php. Example: <code> define( 'WP_DEBUG', true ); </code>
</del><ins>+ * Uses three constants: `WP_DEBUG`, `WP_DEBUG_DISPLAY`, and `WP_DEBUG_LOG`.
+ * All three can be defined in wp-config.php, and by default are set to false.
</ins><span class="cx"> *
</span><del>- * WP_DEBUG_DISPLAY and WP_DEBUG_LOG perform no function unless WP_DEBUG is true.
- * WP_DEBUG defaults to false.
</del><ins>+ * When `WP_DEBUG` is true, all PHP notices are reported. WordPress will also
+ * display internal notices: when a deprecated WordPress function, function
+ * argument, or file is used. Deprecated code may be removed from a later
+ * version.
</ins><span class="cx"> *
</span><del>- * When WP_DEBUG is true, all PHP notices are reported. WordPress will also display
- * notices, including one when a deprecated WordPress function, function argument,
- * or file is used. Deprecated code may be removed from a later version.
</del><ins>+ * It is strongly recommended that plugin and theme developers use `WP_DEBUG`
+ * in their development environments.
</ins><span class="cx"> *
</span><del>- * It is strongly recommended that plugin and theme developers use WP_DEBUG in their
- * development environments.
</del><ins>+ * `WP_DEBUG_DISPLAY` and `WP_DEBUG_LOG` perform no function unless `WP_DEBUG`
+ * is true.
</ins><span class="cx"> *
</span><del>- * 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
- * changing the global configuration setting. Defining WP_DEBUG_DISPLAY as false
- * will force errors to be hidden.
</del><ins>+ * 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 changing the global configuration setting. Defining `WP_DEBUG_DISPLAY`
+ * as false will force errors to be hidden.
</ins><span class="cx"> *
</span><del>- * When WP_DEBUG_LOG is true, errors will be logged to wp-content/debug.log.
- * WP_DEBUG_LOG defaults to false.
</del><ins>+ * When `WP_DEBUG_LOG` is true, errors will be logged to debug.log in the content
+ * directory.
</ins><span class="cx"> *
</span><span class="cx"> * Errors are never displayed for XML-RPC requests.
</span><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><span class="cx"> */
</span><span class="cx"> function wp_debug_mode() {
</span><span class="cx"> if ( WP_DEBUG ) {
</span><span class="lines">@@ -272,30 +288,42 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets the location of the language directory.
</del><ins>+ * Set the location of the language directory.
</ins><span class="cx"> *
</span><del>- * To set directory manually, define <code>WP_LANG_DIR</code> in wp-config.php.
</del><ins>+ * To set directory manually, define the `WP_LANG_DIR` constant
+ * in wp-config.php.
</ins><span class="cx"> *
</span><del>- * If the language directory exists within WP_CONTENT_DIR, that is used.
- * Otherwise if the language directory exists within WPINC, that's used.
- * Finally, if neither of the preceding directories are found,
- * WP_CONTENT_DIR/languages is used.
</del><ins>+ * If the language directory exists within `WP_CONTENT_DIR`, it
+ * is used. Otherwise the language directory is assumed to live
+ * in `WPINC`.
</ins><span class="cx"> *
</span><del>- * The WP_LANG_DIR constant was introduced in 2.1.0.
- *
</del><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><span class="cx"> */
</span><span class="cx"> function wp_set_lang_dir() {
</span><span class="cx"> if ( !defined( 'WP_LANG_DIR' ) ) {
</span><span class="cx"> if ( file_exists( WP_CONTENT_DIR . '/languages' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) || !@is_dir(ABSPATH . WPINC . '/languages') ) {
</span><del>- define( 'WP_LANG_DIR', WP_CONTENT_DIR . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH
</del><ins>+ /**
+ * 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' );
</ins><span class="cx"> if ( !defined( 'LANGDIR' ) ) {
</span><span class="cx"> // Old static relative path maintained for limited backwards compatibility - won't work in some cases
</span><span class="cx"> define( 'LANGDIR', 'wp-content/languages' );
</span><span class="cx"> }
</span><span class="cx"> } else {
</span><del>- define( 'WP_LANG_DIR', ABSPATH . WPINC . '/languages' ); // no leading slash, no trailing slash, full path, not relative to ABSPATH
</del><ins>+ /**
+ * 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' );
</ins><span class="cx"> if ( !defined( 'LANGDIR' ) ) {
</span><span class="cx"> // Old relative path maintained for backwards compatibility
</span><span class="cx"> define( 'LANGDIR', WPINC . '/languages' );
</span><span class="lines">@@ -305,14 +333,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Load the correct database class file.
</del><ins>+ * Load the database class file and instantiate the `$wpdb` global.
</ins><span class="cx"> *
</span><del>- * 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.
</del><ins>+ * @since 2.5.0
</ins><span class="cx"> *
</span><del>- * @since 2.5.0
- * @global $wpdb WordPress Database Object
</del><ins>+ * @global wpdb $wpdb The WordPress database class.
</ins><span class="cx"> */
</span><span class="cx"> function require_wp_db() {
</span><span class="cx"> global $wpdb;
</span><span class="lines">@@ -328,18 +353,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets the database table prefix and the format specifiers for database table columns.
</del><ins>+ * Set the database table prefix and the format specifiers for database
+ * table columns.
</ins><span class="cx"> *
</span><del>- * Columns not listed here default to %s.
</del><ins>+ * Columns not listed here default to `%s`.
</ins><span class="cx"> *
</span><del>- * @see wpdb::$field_types Since 2.8.0
- * @see wpdb::prepare()
- * @see wpdb::insert()
- * @see wpdb::update()
- * @see wpdb::set_prefix()
</del><ins>+ * @since 3.0.0
+ * @access private
</ins><span class="cx"> *
</span><del>- * @access private
- * @since 3.0.0
</del><ins>+ * @global wpdb $wpdb The WordPress database class.
+ * @global string $table_prefix The database table prefix.
</ins><span class="cx"> */
</span><span class="cx"> function wp_set_wpdb_vars() {
</span><span class="cx"> global $wpdb, $table_prefix;
</span><span class="lines">@@ -363,14 +386,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Access/Modify private global variable $_wp_using_ext_object_cache
</del><ins>+ * Access/Modify private global variable `$_wp_using_ext_object_cache`.
</ins><span class="cx"> *
</span><del>- * Toggle $_wp_using_ext_object_cache on and off without directly touching global
</del><ins>+ * Toggle `$_wp_using_ext_object_cache` on and off without directly
+ * touching global.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.7.0
</span><span class="cx"> *
</span><del>- * @param bool $using Whether external object cache is being used
- * @return bool The current 'using' setting
</del><ins>+ * @param bool $using Whether external object cache is being used.
+ * @return bool The current 'using' setting.
</ins><span class="cx"> */
</span><span class="cx"> function wp_using_ext_object_cache( $using = null ) {
</span><span class="cx"> global $_wp_using_ext_object_cache;
</span><span class="lines">@@ -381,13 +405,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Starts the WordPress object cache.
</del><ins>+ * Start the WordPress object cache.
</ins><span class="cx"> *
</span><span class="cx"> * If an object-cache.php file exists in the wp-content directory,
</span><span class="cx"> * it uses that drop-in as an external object cache.
</span><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><ins>+ *
+ * @global int $blog_id Blog ID.
</ins><span class="cx"> */
</span><span class="cx"> function wp_start_object_cache() {
</span><span class="cx"> global $blog_id;
</span><span class="lines">@@ -402,18 +428,23 @@
</span><span class="cx">
</span><span class="cx"> $first_init = true;
</span><span class="cx"> } else if ( ! wp_using_ext_object_cache() && file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
</span><del>- // 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
- // being set incorrectly. Double check if an external cache exists.
</del><ins>+ /*
+ * 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` being set
+ * incorrectly. Double check if an external cache exists.
+ */
</ins><span class="cx"> wp_using_ext_object_cache( true );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> if ( ! wp_using_ext_object_cache() )
</span><span class="cx"> require_once ( ABSPATH . WPINC . '/cache.php' );
</span><span class="cx">
</span><del>- // 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
- // and cleanup caches.
</del><ins>+ /*
+ * 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 and cleanup caches.
+ */
</ins><span class="cx"> if ( ! $first_init && function_exists( 'wp_cache_switch_to_blog' ) )
</span><span class="cx"> wp_cache_switch_to_blog( $blog_id );
</span><span class="cx"> elseif ( function_exists( 'wp_cache_init' ) )
</span><span class="lines">@@ -426,12 +457,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Redirects to the installer if WordPress is not installed.
</del><ins>+ * Redirect to the installer if WordPress is not installed.
</ins><span class="cx"> *
</span><del>- * Dies with an error message when multisite is enabled.
</del><ins>+ * Dies with an error message when Multisite is enabled.
</ins><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><span class="cx"> */
</span><span class="cx"> function wp_not_installed() {
</span><span class="cx"> if ( is_multisite() ) {
</span><span class="lines">@@ -450,15 +481,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns array of must-use plugin files to be included in global scope.
</del><ins>+ * Retrieve an array of must-use plugin files.
</ins><span class="cx"> *
</span><del>- * 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>
</del><ins>+ * The default directory is wp-content/mu-plugins. To change the default
+ * directory manually, define `WPMU_PLUGIN_DIR` and `WPMU_PLUGIN_URL`
</ins><span class="cx"> * in wp-config.php.
</span><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
- * @return array Files to include
</del><ins>+ *
+ * @return array Files to include.
</ins><span class="cx"> */
</span><span class="cx"> function wp_get_mu_plugins() {
</span><span class="cx"> $mu_plugins = array();
</span><span class="lines">@@ -477,15 +509,18 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns array of plugin files to be included in global scope.
</del><ins>+ * Retrieve an array of active and valid plugin files.
</ins><span class="cx"> *
</span><del>- * 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>
</del><ins>+ * While upgrading or installing WordPress, no plugins are returned.
+ *
+ * The default directory is wp-content/plugins. To change the default
+ * directory manually, define `WP_PLUGIN_DIR` and `WP_PLUGIN_URL`
</ins><span class="cx"> * in wp-config.php.
</span><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
- * @return array Files to include
</del><ins>+ *
+ * @return array Files.
</ins><span class="cx"> */
</span><span class="cx"> function wp_get_active_and_valid_plugins() {
</span><span class="cx"> $plugins = array();
</span><span class="lines">@@ -515,13 +550,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Sets internal encoding using mb_internal_encoding().
</del><ins>+ * Set internal encoding.
</ins><span class="cx"> *
</span><del>- * 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.
</del><ins>+ * 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.
</ins><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><span class="cx"> */
</span><span class="cx"> function wp_set_internal_encoding() {
</span><span class="cx"> if ( function_exists( 'mb_internal_encoding' ) ) {
</span><span class="lines">@@ -532,13 +567,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Add magic quotes to $_GET, $_POST, $_COOKIE, and $_SERVER.
</del><ins>+ * Add magic quotes to `$_GET`, `$_POST`, `$_COOKIE`, and `$_SERVER`.
</ins><span class="cx"> *
</span><del>- * Also forces $_REQUEST to be $_GET + $_POST. If $_SERVER, $_COOKIE,
- * or $_ENV are needed, use those superglobals directly.
</del><ins>+ * Also forces `$_REQUEST` to be `$_GET + $_POST`. If `$_SERVER`,
+ * `$_COOKIE`, or `$_ENV` are needed, use those superglobals directly.
</ins><span class="cx"> *
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> * @access private
</span><del>- * @since 3.0.0
</del><span class="cx"> */
</span><span class="cx"> function wp_magic_quotes() {
</span><span class="cx"> // If already slashed, strip.
</span><span class="lines">@@ -561,8 +596,8 @@
</span><span class="cx"> /**
</span><span class="cx"> * Runs just before PHP shuts down execution.
</span><span class="cx"> *
</span><ins>+ * @since 1.2.0
</ins><span class="cx"> * @access private
</span><del>- * @since 1.2.0
</del><span class="cx"> */
</span><span class="cx"> function shutdown_action_hook() {
</span><span class="cx"> /**
</span><span class="lines">@@ -571,6 +606,7 @@
</span><span class="cx"> * @since 1.2.0
</span><span class="cx"> */
</span><span class="cx"> do_action( 'shutdown' );
</span><ins>+
</ins><span class="cx"> wp_cache_close();
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -578,26 +614,25 @@
</span><span class="cx"> * Copy an object.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.7.0
</span><del>- * @deprecated 3.2
</del><ins>+ * @deprecated 3.2.0
</ins><span class="cx"> *
</span><del>- * @param object $object The object to clone
- * @return object The cloned object
</del><ins>+ * @param object $object The object to clone.
+ * @return object The cloned object.
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> function wp_clone( $object ) {
</span><span class="cx"> // Use parens for clone to accommodate PHP 4. See #17880
</span><span class="cx"> return clone( $object );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Whether the current request is for a network or blog admin page
</del><ins>+ * Whether the current request is for an administrative interface page.
</ins><span class="cx"> *
</span><del>- * 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.
</del><ins>+ * Does not check if the user is an administrator; {@see current_user_can()}
+ * for checking roles and capabilities.
</ins><span class="cx"> *
</span><span class="cx"> * @since 1.5.1
</span><span class="cx"> *
</span><del>- * @return bool True if inside WordPress administration pages.
</del><ins>+ * @return bool True if inside WordPress administration interface, false otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function is_admin() {
</span><span class="cx"> if ( isset( $GLOBALS['current_screen'] ) )
</span><span class="lines">@@ -609,14 +644,16 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Whether the current request is for a blog admin screen /wp-admin/
</del><ins>+ * Whether the current request is for a site's admininstrative interface.
</ins><span class="cx"> *
</span><del>- * Does not inform on whether the user is a blog admin! Use capability checks to
- * tell if the user should be accessing a section or not.
</del><ins>+ * e.g. `/wp-admin/`
</ins><span class="cx"> *
</span><ins>+ * Does not check if the user is an administrator; {@see current_user_can()}
+ * for checking roles and capabilities.
+ *
</ins><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><del>- * @return bool True if inside WordPress network administration pages.
</del><ins>+ * @return bool True if inside WordPress blog administration pages.
</ins><span class="cx"> */
</span><span class="cx"> function is_blog_admin() {
</span><span class="cx"> if ( isset( $GLOBALS['current_screen'] ) )
</span><span class="lines">@@ -628,11 +665,13 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Whether the current request is for a network admin screen /wp-admin/network/
</del><ins>+ * Whether the current request is for the network administrative interface.
</ins><span class="cx"> *
</span><del>- * Does not inform on whether the user is a network admin! Use capability checks to
- * tell if the user should be accessing a section or not.
</del><ins>+ * e.g. `/wp-admin/network/`
</ins><span class="cx"> *
</span><ins>+ * Does not check if the user is an administrator; {@see current_user_can()}
+ * for checking roles and capabilities.
+ *
</ins><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="cx"> * @return bool True if inside WordPress network administration pages.
</span><span class="lines">@@ -647,11 +686,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Whether the current request is for a user admin screen /wp-admin/user/
</del><ins>+ * Whether the current request is for a user admin screen.
</ins><span class="cx"> *
</span><del>- * 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.
</del><ins>+ * e.g. `/wp-admin/user/`
</ins><span class="cx"> *
</span><ins>+ * 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()}.
+ *
</ins><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="cx"> * @return bool True if inside WordPress user administration pages.
</span><span class="lines">@@ -666,11 +708,11 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Whether Multisite support is enabled
</del><ins>+ * If Multisite is enabled.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><del>- * @return bool True if multisite is enabled, false otherwise.
</del><ins>+ * @return bool True if Multisite is enabled, false otherwise.
</ins><span class="cx"> */
</span><span class="cx"> function is_multisite() {
</span><span class="cx"> if ( defined( 'MULTISITE' ) )
</span><span class="lines">@@ -683,7 +725,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Retrieve the current blog id
</del><ins>+ * Retrieve the current blog ID.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="lines">@@ -695,16 +737,19 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Attempts an early load of translations.
</del><ins>+ * Attempt an early load of translations.
</ins><span class="cx"> *
</span><del>- * Used for errors encountered during the initial loading process, before the locale has been
- * properly detected and loaded.
</del><ins>+ * Used for errors encountered during the initial loading process, before
+ * the locale has been properly detected and loaded.
</ins><span class="cx"> *
</span><del>- * Designed for unusual load sequences (like setup-config.php) or for when the script will then
- * terminate with an error, otherwise there is a risk that a file can be double-included.
</del><ins>+ * Designed for unusual load sequences (like setup-config.php) or for when
+ * the script will then terminate with an error, otherwise there is a risk
+ * that a file can be double-included.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.4.0
</span><span class="cx"> * @access private
</span><ins>+ *
+ * @global $wp_locale The WordPress date and time locale object.
</ins><span class="cx"> */
</span><span class="cx"> function wp_load_translations_early() {
</span><span class="cx"> global $text_direction, $wp_locale;
</span></span></pre>
</div>
</div>
</body>
</html>