From 34fb70014e53adf771a4a9bcbcd4c3158484fdb6 Mon Sep 17 00:00:00 2001 From: Pascal Birchler Date: Thu, 22 Feb 2024 10:56:26 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@57693 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/pluggable.php | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php index c0bbcfe02e..03bae13ac9 100644 --- a/src/wp-includes/pluggable.php +++ b/src/wp-includes/pluggable.php @@ -1377,9 +1377,9 @@ if ( ! function_exists( 'wp_redirect' ) ) : * * @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. */ function wp_redirect( $location, $status = 302, $x_redirect_by = 'WordPress' ) { @@ -1426,9 +1426,9 @@ if ( ! function_exists( 'wp_redirect' ) ) : * * @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 ); if ( is_string( $x_redirect_by ) ) { @@ -1520,9 +1520,9 @@ if ( ! function_exists( 'wp_safe_redirect' ) ) : * @since 2.3.0 * @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. */ function wp_safe_redirect( $location, $status = 302, $x_redirect_by = 'WordPress' ) {