Ticket #24886: 24886.diff

wp-includes/load.php

@@ -92 +92 @@
 }
 
 /**
- * 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.
  *
+ * @uses wp_load_translations_early()
  * @access private
  * @since 3.0.0
  */
@@ -114 +115 @@
 }
 
 /**
- * Don't load all of WordPress when handling a favicon.ico request.
+ * 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
@@ -128 +130 @@
 }
 
 /**
- * Dies with a maintenance message when conditions are met.
+ * 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
@@ -138 +140 @@
  * The default message can be replaced by using a drop-in (maintenance.php in
  * the wp-content directory).
  *
+ * @uses wp_load_translations_early()
+ * @uses _e for string translations
+ * @uses is_rtl() to specify text direction in the template output
+ *
  * @access private
  * @since 3.0.0
  */
@@ -182 +188 @@
 }
 
 /**
- * PHP 5 standard microtime start capture.
+ * Starts the WordPress microtimer
  *
  * @access private
+ * @see timer_stop()
  * @since 0.71
- * @global float $timestart Seconds from when function is called.
+ *
  * @return bool Always returns true.
  */
 function timer_start() {
@@ -196 +203 @@
 }
 
 /**
- * Return and/or display the time from the page start to when function is called.
+ * Return and/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.
- *
+ * @uses number_format_i18n() to translate the number format based on the locale
  * @since 0.71
- * @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 $display Whether to output the time; truthy values will output, falsy values will not. Default is 0.
  * @param int $precision The amount of digits from the right of the decimal to display. Default is 3.
- * @return float The "second.microsecond" finished time calculation
+ * @return string The "second.microsecond" finished time calculation
  */
-function timer_stop( $display = 0, $precision = 3 ) { // if called like timer_stop(1), will echo $timetotal
+function timer_stop( $display = 0, $precision = 3 ) {
         global $timestart, $timeend;
         $timeend = microtime( true );
         $timetotal = $timeend - $timestart;
@@ -230 +223 @@
 }
 
 /**
- * Sets PHP error handling and handles WordPress debug mode.
+ * Sets PHP error reporting based on WordPress debug settings
  *
  * 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>
+ * 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.
- * WP_DEBUG defaults to false.
- *
  * When WP_DEBUG is true, all PHP notices are reported. WordPress will also display
- * notices, including one when a deprecated WordPress function, function argument,
+ * internal notices: 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.
  *
+ * 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
  * 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.
  *
@@ -279 +271 @@
 }
 
 /**
- * Sets the location of the language directory.
+ * Sets 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.
- * Finally, if neither of the preceding directories are found,
- * WP_CONTENT_DIR/languages is used.
+ * If the language directory exists within WP_CONTENT_DIR, it is used.
+ * Otherwise the language directory is assumed to live 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' ) ) {
                 if ( file_exists( WP_CONTENT_DIR . '/languages' ) && @is_dir( WP_CONTENT_DIR . '/languages' ) || !@is_dir(ABSPATH . WPINC . '/languages') ) {
+                        /**
+                         * Server path of the language directory
+                         *
+                         * @since 2.1.0
+                         */
                         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' );
                         }
                 } else {
+                        /**
+                         * Server path of the language directory
+                         *
+                         * @since 2.1.0
+                         */
                         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
@@ -312 +310 @@
 }
 
 /**
- * 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
  */
 function require_wp_db() {
         global $wpdb;
@@ -335 +328 @@
 }
 
 /**
- * Sets the database table prefix and the format specifiers for database table columns.
+ * Sets the database table prefix and the format specifiers for database table columns
  *
  * Columns not listed here default to %s.
  *
+ * @uses dead_db() to output a DB error screen if necessary
+ * @uses is_wp_error() to detect errors
+ * @uses wp_load_translations_early() for string translations
+ * @uses wp_die() for failures if necessary
  * @see wpdb::$field_types Since 2.8.0
  * @see wpdb::prepare()
  * @see wpdb::insert()
@@ -370 +367 @@
 }
 
 /**
- * Starts the WordPress object cache.
+ * 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.
  *
+ * @uses wp_cache_switch_to_blog()
+ * @uses wp_cache_init()
+ * @uses wp_cache_add_global_groups()
+ * @uses wp_cache_add_non_persistent_groups()
  * @access private
  * @since 3.0.0
  */
@@ -413 +414 @@
 }
 
 /**
- * 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.
  *
+ * @uses is_multisite()
+ * @uses wp_die()
+ * @uses wp_guess_url()
+ * @uses wp_redirect()
+ *
  * @access private
  * @since 3.0.0
  */
@@ -437 +443 @@
 }
 
 /**
- * Returns array of must-use plugin files to be included in global scope.
+ * Returns array of must-use plugin files
  *
  * 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>
@@ -464 +470 @@
 }
 
 /**
- * Returns array of plugin files to be included in global scope.
+ * Returns array of active and valid plugin files
  *
+ * While upgrading or installing WordPress, no plugins are returned.
+ *
  * 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
+ * @return array Files
  */
 function wp_get_active_and_valid_plugins() {
         $plugins = array();
@@ -502 +510 @@
 }
 
 /**
- * Sets internal encoding using mb_internal_encoding().
+ * Sets 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.
@@ -519 +527 @@
 }
 
 /**
- * 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,
  * or $_ENV are needed, use those superglobals directly.
@@ -572 +580 @@
 }
 
 /**
- * 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
- * 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 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'] ) )
@@ -591 +599 @@
 }
 
 /**
- * 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
- * tell if the user should be accessing a section or not.
+ * e.g. /wp-admin/
  *
+ * 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'] ) )
@@ -610 +620 @@
 }
 
 /**
- * Whether the current request is for a network admin screen /wp-admin/network/
+ * Whether the current request is for the network administrative iterface
  *
- * 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.
+ * e.g. /wp-admin/network/
  *
+ * 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.
@@ -629 +641 @@
 }
 
 /**
- * Whether the current request is for a user admin screen /wp-admin/user/
+ * Whether the current request is for a user admin screen
  *
+ * e.g. /wp-admin/user/
+ *
  * 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.
  *
@@ -648 +662 @@
 }
 
 /**
- * Whether Multisite support is enabled
+ * If multisite is enabled
  *
  * @since 3.0.0
  *