W3cubDocs

/WordPress

wp_admin_canonical_url()

Remove single-use URL parameters and create canonical link based on new URL.

Description

Remove specific query string parameters from a URL, create the canonical link, put it in the admin header, and change the current URL to match.

Source

File: wp-admin/includes/misc.php 

function wp_admin_canonical_url() {
	$removable_query_args = wp_removable_query_args();

	if ( empty( $removable_query_args ) ) {
		return;
	}

	// Ensure we're using an absolute URL.
	$current_url  = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] );
	$filtered_url = remove_query_arg( $removable_query_args, $current_url );
	?>
	<link id="wp-admin-canonical" rel="canonical" href="<?php echo esc_url( $filtered_url ); ?>" />
	<script>
		if ( window.history.replaceState ) {
			window.history.replaceState( null, null, document.getElementById( 'wp-admin-canonical' ).href + window.location.hash );
		}
	</script>
	<?php
}

Uses

Uses Description
wp-includes/functions.php: wp_removable_query_args()

Returns an array of single-use query variable names that can be removed from a URL.
wp-includes/formatting.php: esc_url()

Checks and cleans a URL.
wp-includes/functions.php: remove_query_arg()

Removes an item or items from a query string.
wp-includes/link-template.php: set_url_scheme()

Sets the scheme for a URL.

Changelog

Version Description
4.2.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_admin_canonical_url