redirect_canonical( string $requested_url = null, bool $do_redirect = true ): string|null

Description

Parameters

$requested_urlstringoptional

The URL that was requested, used to figure if redirect is needed.Default: null

$do_redirectbooloptional

Redirect to the new URL.Default: true

Return

string|null

The string of the URL, if redirect needed. Never returns if a redirect occurs, depending on $do_redirect.

Hooks fired · 2

2 hooks fire while redirect_canonical() runs, in this order:

1. 1
   apply_filters( wp_signup_location )filterline 541 (+498 into the body)

   Filters the Multisite sign up URL.

2. 2
   apply_filters( redirect_canonical )filterline 830 (+787 into the body)

   Filters the canonical redirect URL.

Uses · 69

• is_preview()Determines whether the query is for a post or page preview.
• get_query_var()Retrieves the value of a query variable in the WP_Query class.
• get_post_status()Retrieves the post status based on the post ID.
• wp_verify_nonce()Verifies that a correct security nonce was used with time limit.
• is_admin()Determines whether the current request is for an administrative interface page.
• is_search()Determines whether the query is for a search.
• is_trackback()Determines whether the query is for a trackback endpoint call.
• is_favicon()Is the query for the favicon.ico file?
• iis7_supports_permalinks()Checks if IIS 7+ supports pretty permalinks.
• is_ssl()Determines if SSL is used.
• remove_query_arg()Removes an item or items from a query string.
• is_feed()Determines whether the query is for a feed.

Used by · 1

• redirect_canonical()Redirects incoming links to the proper URL based on the site url.

Source

View on Trac ↗View on GitHub ↗

43function redirect_canonical( $requested_url = null, $do_redirect = true ) {44	global $wp_rewrite, $is_IIS, $wp_query, $wpdb, $wp;45 46	if ( isset( $_SERVER['REQUEST_METHOD'] ) && ! in_array( strtoupper( $_SERVER['REQUEST_METHOD'] ), array( 'GET', 'HEAD' ), true ) ) {47		return null;48	}49 50	/*51	 * If we're not in wp-admin and the post has been published and preview nonce52	 * is non-existent or invalid then no need for preview in query.53	 */54	if ( is_preview() && get_query_var( 'p' ) && 'publish' === get_post_status( get_query_var( 'p' ) ) ) {55		if ( ! isset( $_GET['preview_id'] )56			|| ! isset( $_GET['preview_nonce'] )57			|| ! wp_verify_nonce( $_GET['preview_nonce'], 'post_preview_' . (int) $_GET['preview_id'] )58		) {59			$wp_query->is_preview = false;60		}61	}62 63	if ( is_admin() || is_search() || is_preview() || is_trackback() || is_favicon()64		|| ( $is_IIS && ! iis7_supports_permalinks() )65	) {66		return null;67	}68 69	if ( ! $requested_url && isset( $_SERVER['HTTP_HOST'] ) ) {70		// Build the URL in the address bar.71		$requested_url  = is_ssl() ? 'https://' : 'http://';72		$requested_url .= $_SERVER['HTTP_HOST'];73		$requested_url .= $_SERVER['REQUEST_URI'];74	}75 76	$original = parse_url( $requested_url );77	if ( false === $original ) {78		return null;79	}80 81	// Notice fixing.82	$original += array(83		'host'   => '',84		'path'   => '',85		'query'  => '',86		'scheme' => '',87	);88 89	$redirect     = $original;90	$redirect_url = false;91	$redirect_obj = false;92 93	/*94	 * If the original URL ended with non-breaking spaces, they were almost95	 * certainly inserted by accident. Let's remove them, so the reader doesn't96	 * see a 404 error with no obvious cause.97	 */98	$redirect['path'] = preg_replace( '|(%C2%A0)+$|i', '', $redirect['path'] );99 100	// It's not a preview, so remove it from URL.101	if ( get_query_var( 'preview' ) ) {102		$redirect['query'] = remove_query_arg( 'preview', $redirect['query'] );103	}104 105	$post_id = get_query_var( 'p' );106 107	if ( is_feed() && $post_id ) {108		$redirect_url = get_post_comments_feed_link( $post_id, get_query_var( 'feed' ) );109		$redirect_obj = get_post( $post_id );110 111		if ( $redirect_url ) {112			$redirect['query'] = _remove_qs_args_if_not_in_url(113				$redirect['query'],114				array( 'p', 'page_id', 'attachment_id', 'pagename', 'name', 'post_type', 'feed' ),115				$redirect_url116			);117 118			$redirect['path'] = parse_url( $redirect_url, PHP_URL_PATH );119		}120	}121 122	if ( is_singular() && $wp_query->post_count < 1 && $post_id ) {

History

Introduced in 2.3.0. One change between 6.7.7 and 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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, from src/wp-includes/canonical.php, 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.