Changeset 57693 for trunk/src/wp-includes/pluggable.php

Timestamp:

02/22/2024 10:56:26 AM (10 months ago)

Author:

swissspidy

Message:

Docs: Improve docblock for $x_redirect_by param in wp_redirect().

The $x_redirect_by parameter is supported by wp_redirect() and wp_safe_redirect() to set the X-Redirect-By header.
It can be modified via the x_redirect_by filter.

This updates the docblock to clarify that false can be passed to disable sending the header, which was previously undocumented behavior.

Props kkmuffme, swissspidy.
Fixes #60209.

File:

• trunk/src/wp-includes/pluggable.php (modified) (3 diffs)

trunk/src/wp-includes/pluggable.php

@@ -1378 +1378 @@
      * @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 $x_redirect_by Optional. The application doing the redirect. Default 'WordPress'.
+     * @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|false $x_redirect_by Optional. The application doing the redirect or false to omit. Default 'WordPress'.
      * @return bool False if the redirect was canceled, true otherwise.
      */
@@ -1427 +1427 @@
          * @since 5.1.0
          *
-         * @param string $x_redirect_by The application doing the redirect.
-         * @param int    $status        Status code to use.
-         * @param string $location      The path to redirect to.
+         * @param string|false $x_redirect_by The application doing the redirect or false to omit the header.
+         * @param int          $status        Status code to use.
+         * @param string       $location      The path to redirect to.
          */
         $x_redirect_by = apply_filters( 'x_redirect_by', $x_redirect_by, $status, $location );
@@ -1521 +1521 @@
      * @since 5.1.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'.
+     * @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|false $x_redirect_by Optional. The application doing the redirect or false to omit. Default 'WordPress'.
      * @return bool False if the redirect was canceled, true otherwise.
      */