Changeset 34958

Timestamp:

10/08/2015 09:23:31 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Improve more formatting and syntax for inline comments in WP_Rewrite.

See #34218.

File:

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

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

@@ -1243 +1243 @@
         $robots_rewrite = ( empty( $home_path['path'] ) || '/' == $home_path['path'] ) ? array( 'robots\.txt$' => $this->index . '?robots=1' ) : array();
 
-        // Old feed and service files
+        // Old feed and service files.
         $deprecated_files = array(
             '.*wp-(atom|rdf|rss|rss2|feed|commentsrss2)\.php$' => $this->index . '?feed=old',
@@ -1249 +1249 @@
         );
 
-        // Registration rules
+        // Registration rules.
         $registration_pages = array();
         if ( is_multisite() && is_main_site() ) {
@@ -1255 +1255 @@
             $registration_pages['.*wp-activate.php$'] = $this->index . '?activate=true';
         }
-        $registration_pages['.*wp-register.php$'] = $this->index . '?register=true'; // Deprecated
+
+        // Deprecated.
+        $registration_pages['.*wp-register.php$'] = $this->index . '?register=true';
 
         // Post rewrite rules.
@@ -1476 +1478 @@
         $rules .= "RewriteEngine On\n";
         $rules .= "RewriteBase $home_root\n";
-        $rules .= "RewriteRule ^index\.php$ - [L]\n"; // Prevent -f checks on index.php.
-
-        //add in the rules that don't redirect to WP's index.php (and thus shouldn't be handled by WP at all)
+
+        // Prevent -f checks on index.php.
+        $rules .= "RewriteRule ^index\.php$ - [L]\n";
+
+        // Add in the rules that don't redirect to WP's index.php (and thus shouldn't be handled by WP at all).
         foreach ( (array) $this->non_wp_rules as $match => $query) {
             // Apache 1.3 does not support the reluctant (non-greedy) modifier.
             $match = str_replace('.+?', '.+', $match);
-
-            // If the match is unanchored and greedy, prepend rewrite conditions
-            // to avoid infinite redirects and eclipsing of real files.
-            //if ($match == '(.+)/?$' || $match == '([^/]+)/?$' ) {
-                //nada.
-            //}
 
             $rules .= 'RewriteRule ^' . $match . ' ' . $home_root . $query . " [QSA,L]\n";
@@ -1503 +1501 @@
                 // Apache 1.3 does not support the reluctant (non-greedy) modifier.
                 $match = str_replace('.+?', '.+', $match);
-
-                // If the match is unanchored and greedy, prepend rewrite conditions
-                // to avoid infinite redirects and eclipsing of real files.
-                //if ($match == '(.+)/?$' || $match == '([^/]+)/?$' ) {
-                    //nada.
-                //}
 
                 if ( strpos($query, $this->index) !== false )
@@ -1524 +1516 @@
 
         /**
-         *
          * Filter the list of rewrite rules formatted for output to an .htaccess file.
          *
@@ -1620 +1611 @@
         }
 
-        // "external" = it doesn't correspond to index.php
+        // "external" = it doesn't correspond to index.php.
         if ( $external ) {
             $this->add_external_rule( $regex, $query );
@@ -1665 +1656 @@
         global $wp;
 
-        // For backward compatibility, if `null` has explicitly been passed as `$query_var`, assume `true`.
+        // For backward compatibility, if null has explicitly been passed as `$query_var`, assume `true`.
         if ( true === $query_var || null === func_get_arg( 2 ) ) {
             $query_var = $name;
@@ -1705 +1696 @@
      */
     public function add_permastruct( $name, $struct, $args = array() ) {
-        // backwards compatibility for the old parameters: $with_front and $ep_mask
+        // Backwards compatibility for the old parameters: $with_front and $ep_mask.
         if ( ! is_array( $args ) )
             $args = array( 'with_front' => $args );
@@ -1748 +1739 @@
         static $do_hard_later = null;
 
-        // Prevent this action from running before everyone has registered their rewrites
+        // Prevent this action from running before everyone has registered their rewrites.
         if ( ! did_action( 'wp_loaded' ) ) {
             add_action( 'wp_loaded', array( $this, 'flush_rules' ) );
@@ -1762 +1753 @@
         delete_option('rewrite_rules');
         $this->wp_rewrite_rules();
+
         /**
          * Filter whether a "hard" rewrite rule flush should be performed when requested.