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

Timestamp:

01/29/2020 12:43:23 AM (6 months 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/rewrite.php (modified) (12 diffs)

trunk/src/wp-includes/rewrite.php

@@ -158 +158 @@
  */
 function add_rewrite_tag( $tag, $regex, $query = '' ) {
-    // validate the tag's name
+    // Validate the tag's name.
     if ( strlen( $tag ) < 3 || $tag[0] != '%' || $tag[ strlen( $tag ) - 1 ] != '%' ) {
         return;
@@ -254 +254 @@
     $hook = 'do_feed_' . $feedname;
 
-    // Remove default function hook
+    // Remove default function hook.
     remove_action( $hook, $hook );
 
@@ -421 +421 @@
         $maybe_page = $query_vars['day'];
     }
-    // Bug found in #11694 - 'page' was returning '/4'
+    // Bug found in #11694 - 'page' was returning '/4'.
     $maybe_page = (int) trim( $maybe_page, '/' );
 
@@ -486 +486 @@
     }
 
-    // First, check to see if there is a 'p=N' or 'page_id=N' to match against
+    // First, check to see if there is a 'p=N' or 'page_id=N' to match against.
     if ( preg_match( '#[?&](p|page_id|attachment_id)=(\d+)#', $url, $values ) ) {
         $id = absint( $values[2] );
@@ -494 +494 @@
     }
 
-    // Get rid of the #anchor
+    // Get rid of the #anchor.
     $url_split = explode( '#', $url );
     $url       = $url_split[0];
 
-    // Get rid of URL ?query=string
+    // Get rid of URL ?query=string.
     $url_split = explode( '?', $url );
     $url       = $url_split[0];
@@ -506 +506 @@
     $url    = set_url_scheme( $url, $scheme );
 
-    // Add 'www.' if it is absent and should be there
+    // Add 'www.' if it is absent and should be there.
     if ( false !== strpos( home_url(), '://www.' ) && false === strpos( $url, '://www.' ) ) {
         $url = str_replace( '://', '://www.', $url );
     }
 
-    // Strip 'www.' if it is present and shouldn't be
+    // Strip 'www.' if it is present and shouldn't be.
     if ( false === strpos( home_url(), '://www.' ) ) {
         $url = str_replace( '://www.', '://', $url );
@@ -524 +524 @@
     }
 
-    // Check to see if we are using rewrite rules
+    // Check to see if we are using rewrite rules.
     $rewrite = $wp_rewrite->wp_rewrite_rules();
 
-    // Not using rewrite rules, and 'p=N' and 'page_id=N' methods failed, so we're out of options
+    // Not using rewrite rules, and 'p=N' and 'page_id=N' methods failed, so we're out of options.
     if ( empty( $rewrite ) ) {
         return 0;
     }
 
-    // Strip 'index.php/' if we're not using path info permalinks
+    // Strip 'index.php/' if we're not using path info permalinks.
     if ( ! $wp_rewrite->using_index_permalinks() ) {
         $url = str_replace( $wp_rewrite->index . '/', '', $url );
@@ -538 +538 @@
 
     if ( false !== strpos( trailingslashit( $url ), home_url( '/' ) ) ) {
-        // Chop off http://domain.com/[path]
+        // Chop off http://domain.com/[path].
         $url = str_replace( home_url(), '', $url );
     } else {
-        // Chop off /path/to/blog
+        // Chop off /path/to/blog.
         $home_path = parse_url( home_url( '/' ) );
         $home_path = isset( $home_path['path'] ) ? $home_path['path'] : '';
@@ -547 +547 @@
     }
 
-    // Trim leading and lagging slashes
+    // Trim leading and lagging slashes.
     $url = trim( $url, '/' );
 
@@ -563 +563 @@
     foreach ( (array) $rewrite as $match => $query ) {
 
-        // If the requesting file is the anchor of the match, prepend it
-        // to the path info.
+        // If the requesting file is the anchor of the match,
+        // prepend it to the path info.
         if ( ! empty( $url ) && ( $url != $request ) && ( strpos( $match, $url ) === 0 ) ) {
             $request_match = $url . '/' . $request;
@@ -592 +592 @@
             $query = addslashes( WP_MatchesMapRegex::apply( $query, $matches ) );
 
-            // Filter out non-public query vars
+            // Filter out non-public query vars.
             global $wp;
             parse_str( $query, $query_vars );
@@ -609 +609 @@
             $query = wp_resolve_numeric_slug_conflicts( $query );
 
-            // Do the query
+            // Do the query.
             $query = new WP_Query( $query );
             if ( ! empty( $query->posts ) && $query->is_singular ) {