Changeset 47122 for trunk/src/wp-includes/load.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-includes/load.php (modified) (11 diffs)

trunk/src/wp-includes/load.php

@@ -36 +36 @@
     }
 
-    // Variables that shouldn't be unset
+    // Variables that shouldn't be unset.
     $no_unset = array( 'GLOBALS', '_GET', '_POST', '_COOKIE', '_REQUEST', '_SERVER', '_ENV', '_FILES', 'table_prefix' );
 
@@ -66 +66 @@
     $_SERVER = array_merge( $default_server_values, $_SERVER );
 
-    // Fix for IIS when running with PHP ISAPI
+    // Fix for IIS when running with PHP ISAPI.
     if ( empty( $_SERVER['REQUEST_URI'] ) || ( PHP_SAPI != 'cgi-fcgi' && preg_match( '/^Microsoft-IIS\//', $_SERVER['SERVER_SOFTWARE'] ) ) ) {
 
         if ( isset( $_SERVER['HTTP_X_ORIGINAL_URL'] ) ) {
-            // IIS Mod-Rewrite
+            // IIS Mod-Rewrite.
             $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_ORIGINAL_URL'];
         } elseif ( isset( $_SERVER['HTTP_X_REWRITE_URL'] ) ) {
-            // IIS Isapi_Rewrite
+            // IIS Isapi_Rewrite.
             $_SERVER['REQUEST_URI'] = $_SERVER['HTTP_X_REWRITE_URL'];
         } else {
-            // Use ORIG_PATH_INFO if there is no PATH_INFO
+            // 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'];
             }
 
-            // Some IIS + PHP configurations puts the script-name in the path-info (No need to append it twice)
+            // Some IIS + PHP configurations put the script-name in the path-info (no need to append it twice).
             if ( isset( $_SERVER['PATH_INFO'] ) ) {
                 if ( $_SERVER['PATH_INFO'] == $_SERVER['SCRIPT_NAME'] ) {
@@ -90 +90 @@
             }
 
-            // Append the query string if it exists and isn't null
+            // Append the query string if it exists and isn't null.
             if ( ! empty( $_SERVER['QUERY_STRING'] ) ) {
                 $_SERVER['REQUEST_URI'] .= '?' . $_SERVER['QUERY_STRING'];
@@ -97 +97 @@
     }
 
-    // Fix for PHP as CGI hosts that set SCRIPT_FILENAME to something ending in php.cgi for all requests
+    // 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 ) ) {
         $_SERVER['SCRIPT_FILENAME'] = $_SERVER['PATH_TRANSLATED'];
     }
 
-    // Fix for Dreamhost and other PHP as CGI hosts
+    // Fix for Dreamhost and other PHP as CGI hosts.
     if ( strpos( $_SERVER['SCRIPT_NAME'], 'php.cgi' ) !== false ) {
         unset( $_SERVER['PATH_INFO'] );
     }
 
-    // Fix empty PHP_SELF
+    // Fix empty PHP_SELF.
     $PHP_SELF = $_SERVER['PHP_SELF'];
     if ( empty( $PHP_SELF ) ) {
@@ -472 +472 @@
         'comment_karma'    => '%d',
         'comment_count'    => '%d',
-        // multisite:
+        // Multisite:
         'active'           => '%d',
         'cat_id'           => '%d',
@@ -550 +550 @@
                 }
 
-                // Re-initialize any hooks added manually by object-cache.php
+                // Re-initialize any hooks added manually by object-cache.php.
                 if ( $wp_filter ) {
                     $wp_filter = WP_Hook::build_preinitialized_hooks( $wp_filter );
@@ -667 +667 @@
     $active_plugins = (array) get_option( 'active_plugins', array() );
 
-    // Check for hacks file if the option is enabled
+    // Check for hacks file if the option is enabled.
     if ( get_option( 'hack_file' ) && file_exists( ABSPATH . 'my-hacks.php' ) ) {
         _deprecated_file( 'my-hacks.php', '1.5.0' );
@@ -680 +680 @@
 
     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
-            // not already included as a network 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.
+            // Not already included as a network plugin.
             && ( ! $network_plugins || ! in_array( WP_PLUGIN_DIR . '/' . $plugin, $network_plugins ) )
             ) {
@@ -961 +961 @@
  */
 function wp_clone( $object ) {
-    // Use parens for clone to accommodate PHP 4. See #17880
+    // Use parens for clone to accommodate PHP 4. See #17880.
     return clone( $object );
 }
@@ -1150 +1150 @@
     }
 
-    // We need $wp_local_package
+    // We need $wp_local_package.
     require ABSPATH . WPINC . '/version.php';
 
-    // Translation and localization
+    // Translation and localization.
     require_once ABSPATH . WPINC . '/pomo/mo.php';
     require_once ABSPATH . WPINC . '/l10n.php';
@@ -1159 +1159 @@
     require_once ABSPATH . WPINC . '/class-wp-locale-switcher.php';
 
-    // General libraries
+    // General libraries.
     require_once ABSPATH . WPINC . '/plugin.php';