apply_filters( 'redirect_canonical', string $redirect_url, string $requested_url )
- Since
- 2.3.0
Filters the canonical redirect URL.
Description
Returning false to this filter will cancel the redirect.
Compatibility
- WordPress
- since 2.3.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$redirect_urlstring- The redirect URL.
$requested_urlstring- The requested URL.
Where this hook fires · 1
wp-includes/canonical.php:830redirect_canonical()
Source code
* * @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 ); // Yes, again -- in case the filter aborted the request. if ( ! $redirect_url || strip_fragment_from_url( $redirect_url ) === strip_fragment_from_url( $requested_url ) ) { return null; }Changelog
Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.