Changeset 31160

Timestamp:

01/12/2015 04:32:35 AM (12 years ago)

Author:

dd32

Message:

More concise documentation for wp_install_maybe_enable_pretty_permalinks()
See #6481. Props ericlewis.

File:

• trunk/src/wp-admin/includes/upgrade.php (modified) (7 diffs)

trunk/src/wp-admin/includes/upgrade.php

@@ -264 +264 @@
 
 /**
- * Enable pretty permalinks if available.
- *
- * This function will enable pretty permalinks if it can verify they work.
- * If all pretty permalinks formats fail to work, WordPress will fall back
- * to ugly permalinks by setting an empty permalink structure.
+ * Enable pretty permalinks.
+ *
+ * If after enabling pretty permalinks don't work, fallback to query-string permalinks.
  *
  * @since 4.2.0
@@ -277 +275 @@
         global $wp_rewrite;
 
-        // Bail if we alredy have permalinks enabled (Multisite)
+        // Bail if a permalink structure is already enabled.
         if ( get_option( 'permalink_structure' ) ) {
                 return;
@@ -283 +281 @@
 
         /*
-         * The Permalink structures which WordPress should attempt to use.
+         * The Permalink structures to attempt.
+         *
          * The first is designed for mod_rewrite or nginx rewriting.
-         * The second is PATHINFO based permalinks offered under configurations 
-         * without rewrites enabled.
+         *
+         * The second is PATHINFO-based permalinks for web server configurations
+         * without a true rewrite module enabled.
          */
         $permalink_structures = array(
@@ -294 +294 @@
 
         foreach ( (array) $permalink_structures as $permalink_structure ) {
-                // Set the desired Permalink structure to try
                 $wp_rewrite->set_permalink_structure( $permalink_structure );
 
@@ -303 +302 @@
                 $wp_rewrite->flush_rules( true );
 
-                // Test against a real WordPress Post, or if none were created, a Page URI
+                // Test against a real WordPress Post, or if none were created, a random 404 page.
                 $test_url = get_permalink( 1 );
                 if ( ! $test_url ) {
@@ -310 +309 @@
 
                 /*
-                 * Send a HEAD request to a random page on the site, and check whether
+                 * Send a request to the site, and check whether
                  * the 'x-pingback' header is returned as expected.
+                 *
+                 * Uses wp_remote_get() instead of wp_remote_head() because web servers
+                 * can block head requests.
                  */
                 $response          = wp_remote_get( $test_url, array( 'timeout' => 5 ) );
@@ -323 +325 @@
 
         /*
-         * If it makes it this far, Pretty Permalinks failed to activate.
-         * Reset and allow the user to select it themselves.
+         * If it makes it this far, pretty permalinks failed.
+         * Fallback to query-string permalinks.
          */
         $wp_rewrite->set_permalink_structure( '' );