Changeset 42633

Timestamp:

02/01/2018 03:05:50 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Canonical: Add $x_redirect_by parameter to wp_redirect() that allows applications doing the redirect to identify themselves.

This complements the x_redirect_by filter added in [42408].

Props NathanAtmoz, johnbillion.
Fixes #42313.

Location:

trunk

Files:

• src/wp-includes/pluggable.php (modified) (2 diffs)
• tests/phpunit/tests/pluggable.php (modified) (1 diff)

trunk/src/wp-includes/pluggable.php

@@ -1190 +1190 @@
      * @global bool $is_IIS
      *
-     * @param string $location The path or URL to redirect to.
-     * @param int    $status   Optional. HTTP response status code to use. Default '302' (Moved Temporarily).
+     * @param string $location      The path or URL to redirect to.
+     * @param int    $status        Optional. HTTP response status code to use. Default '302' (Moved Temporarily).
+     * @param string $x_redirect_by Optional. The application doing the redirect. Default 'WordPress'.
      * @return bool False if the redirect was cancelled, true otherwise.
      */
-    function wp_redirect( $location, $status = 302 ) {
+    function wp_redirect( $location, $status = 302, $x_redirect_by = 'WordPress' ) {
         global $is_IIS;
 
@@ -1238 +1239 @@
          * @param string $location      The path to redirect to.
          */
-        $x_redirect_by = apply_filters( 'x_redirect_by', 'WordPress', $status, $location );
+        $x_redirect_by = apply_filters( 'x_redirect_by', $x_redirect_by, $status, $location );
         if ( is_string( $x_redirect_by ) ) {
             header( "X-Redirect-By: $x_redirect_by" );

trunk/tests/phpunit/tests/pluggable.php

@@ -177 +177 @@
             'wp_redirect'                     => array(
                 'location',
-                'status' => 302,
+                'status'        => 302,
+                'x_redirect_by' => 'WordPress',
             ),
             'wp_sanitize_redirect'            => array( 'location' ),