Changeset 32529

Timestamp:

05/21/2015 08:29:19 PM (10 years ago)

Author:

wonderboymusic

Message:

In canonical.php:

• Clarify some docs
• redirect_canonical() inconsistently returns null or false when bailing - can simply return.

See #32444.

File:

• trunk/src/wp-includes/canonical.php (modified) (5 diffs)

trunk/src/wp-includes/canonical.php

@@ -34 +34 @@
  *      figure if redirect is needed.
  * @param bool $do_redirect Optional. Redirect to the new URL.
- * @return null|false|string Null, if redirect not needed. False, if redirect
- *      not needed or the string of the URL
+ * @return null|string Null, if redirect not needed, or the string of the URL
  */
 function redirect_canonical( $requested_url = null, $do_redirect = true ) {
@@ -448 +447 @@
     }
 
-    if ( !$redirect_url || $redirect_url == $requested_url )
-        return false;
+    if ( ! $redirect_url || $redirect_url == $requested_url ) {
+        return;
+    }
 
     // Hex encoded octets are case-insensitive.
@@ -473 +473 @@
     $redirect_url = apply_filters( 'redirect_canonical', $redirect_url, $requested_url );
 
-    if ( !$redirect_url || $redirect_url == $requested_url ) // yes, again -- in case the filter aborted the request
-        return false;
+    // yes, again -- in case the filter aborted the request
+    if ( ! $redirect_url || $redirect_url == $requested_url ) {
+        return;
+    }
 
     if ( $do_redirect ) {
@@ -484 +486 @@
             // Debug
             // die("1: $redirect_url<br />2: " . redirect_canonical( $redirect_url, false ) );
-            return false;
+            return;
         }
     } else {
@@ -524 +526 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @return bool|string The correct URL if one is found. False on failure.
+ * @return false|string The correct URL if one is found. False on failure.
  */
 function redirect_guess_404_permalink() {