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

Timestamp:

01/29/2020 12:43:23 AM (7 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/class-wp.php (modified) (9 diffs)

trunk/src/wp-includes/class-wp.php

@@ -174 +174 @@
                         $home_path_regex = sprintf( '|^%s|i', preg_quote( $home_path, '|' ) );
 
-                        // Trim path info from the end and the leading home path from the
-                        // front. For path info requests, this leaves us with the requesting
-                        // filename, if any. For 404 requests, this leaves us with the
-                        // requested permalink.
+                        /*
+                         * Trim path info from the end and the leading home path from the front.
+                         * For path info requests, this leaves us with the requesting filename, if any.
+                         * For 404 requests, this leaves us with the requested permalink.
+                         */
                         $req_uri  = str_replace( $pathinfo, '', $req_uri );
                         $req_uri  = trim( $req_uri, '/' );
@@ -190 +191 @@
 
                         // The requested permalink is in $pathinfo for path info requests and
-                        //  $req_uri for other requests.
+                        // $req_uri for other requests.
                         if ( ! empty( $pathinfo ) && ! preg_match( '|^.*' . $wp_rewrite->index . '$|', $pathinfo ) ) {
                                 $requested_path = $pathinfo;
@@ -207 +208 @@
                         $request_match = $requested_path;
                         if ( empty( $request_match ) ) {
-                                // An empty request could only match against ^$ regex
+                                // An empty request could only match against ^$ regex.
                                 if ( isset( $rewrite['$'] ) ) {
                                         $this->matched_rule = '$';
@@ -324 +325 @@
                 }
 
-                // Convert urldecoded spaces back into +
+                // Convert urldecoded spaces back into '+'.
                 foreach ( get_taxonomies( array(), 'objects' ) as $taxonomy => $t ) {
                         if ( $t->query_var && isset( $this->query_vars[ $t->query_var ] ) ) {
@@ -344 +345 @@
                 }
 
-                // Limit publicly queried post_types to those that are publicly_queryable
+                // Limit publicly queried post_types to those that are 'publicly_queryable'.
                 if ( isset( $this->query_vars['post_type'] ) ) {
                         $queryable_post_types = get_post_types( array( 'publicly_queryable' => true ) );
@@ -418 +419 @@
                         $headers['Content-Type'] = get_option( 'html_type' ) . '; charset=' . get_option( 'blog_charset' );
                 } else {
-                        // Set the correct content type for feeds
+                        // Set the correct content type for feeds.
                         $type = $this->query_vars['feed'];
                         if ( 'feed' == $this->query_vars['feed'] ) {
@@ -453 +454 @@
                         $headers['ETag']          = $wp_etag;
 
-                        // Support for Conditional GET
+                        // Support for conditional GET.
                         if ( isset( $_SERVER['HTTP_IF_NONE_MATCH'] ) ) {
                                 $client_etag = wp_unslash( $_SERVER['HTTP_IF_NONE_MATCH'] );
@@ -461 +462 @@
 
                         $client_last_modified = empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ? '' : trim( $_SERVER['HTTP_IF_MODIFIED_SINCE'] );
-                        // If string is empty, return 0. If not, attempt to parse into a timestamp
+                        // If string is empty, return 0. If not, attempt to parse into a timestamp.
                         $client_modified_timestamp = $client_last_modified ? strtotime( $client_last_modified ) : 0;
 
-                        // Make a timestamp for our most recent modification...
+                        // Make a timestamp for our most recent modification..
                         $wp_modified_timestamp = strtotime( $wp_last_modified );
 
@@ -676 +677 @@
                                 }
 
-                                // check for paged content that exceeds the max number of pages
+                                // Check for paged content that exceeds the max number of pages.
                                 $next = '<!--nextpage-->';
                                 if ( $p && false !== strpos( $p->post_content, $next ) && ! empty( $this->query_vars['page'] ) ) {