Changeset 25535

Timestamp:

09/20/2013 11:30:37 PM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-includes/canonical.php.

Props dustyf for the initial patch.
See #25229.

File:

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

trunk/src/wp-includes/canonical.php

@@ -297 +297 @@
                 if ( 'wp-register.php' == basename( $redirect['path'] ) ) {
                         if ( is_multisite() )
+                                //duplicate_hook
                                 $redirect_url = apply_filters( 'wp_signup_location', network_site_url( 'wp-signup.php' ) );
                         else
@@ -433 +434 @@
         }
 
-        // Note that you can use the "redirect_canonical" filter to cancel a canonical redirect for whatever reason by returning false
-        $redirect_url = apply_filters('redirect_canonical', $redirect_url, $requested_url);
+        /**
+         * Filter the canonical redirect URL.
+         *
+         * Returning false to this filter will cancel the redirect.
+         *
+         * @since 2.3.0
+         *
+         * @param string $redirect_url  The redirect URL.
+         * @param string $requested_url The requested URL.
+         */
+        $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