Changeset 42647

Timestamp:

02/04/2018 04:04:10 PM (7 years ago)

Author:

johnbillion

Message:

Canonical: Add $x_redirect_by parameter to wp_safe_redirect().

See [42633] and [42408].

Fixes #42313.

Location:

trunk

Files:

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

trunk/src/wp-includes/pluggable.php

@@ -1187 +1187 @@
      *
      * @since 1.5.1
+     * @since 5.0.0 The `$x_redirect_by` parameter was added.
      *
      * @global bool $is_IIS
@@ -1324 +1325 @@
      *
      * @since 2.3.0
-     * @since 5.0.0 The return value from wp_redirect() is now passed on.
-     *
-     * @param string $location The path or URL to redirect to.
-     * @param int    $status   Optional. HTTP response status code to use. Default '302' (Moved Temporarily).
-     * @return bool  $redirect False if the redirect was cancelled, true otherwise.
-     */
-    function wp_safe_redirect( $location, $status = 302 ) {
+     * @since 5.0.0 The return value from wp_redirect() is now passed on, and the `$x_redirect_by` parameter was added.
+     *
+     * @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  $redirect False if the redirect was cancelled, true otherwise.
+     */
+    function wp_safe_redirect( $location, $status = 302, $x_redirect_by = 'WordPress' ) {
 
         // Need to look at the URL the way it will end up in wp_redirect()
@@ -1345 +1347 @@
         $location = wp_validate_redirect( $location, apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status ) );
 
-        return wp_redirect( $location, $status );
+        return wp_redirect( $location, $status, $x_redirect_by );
     }
 endif;

trunk/tests/phpunit/tests/pluggable.php

@@ -184 +184 @@
             'wp_safe_redirect'                => array(
                 'location',
-                'status' => 302,
+                'status'        => 302,
+                'x_redirect_by' => 'WordPress',
             ),
             'wp_validate_redirect'            => array(