remove_query_arg( string|string[] $key, false|string $query = false )

Removes an item or items from a query string.

Parameters

$key

(string|string[]) (Required) Query key or keys to remove.

$query

(false|string) (Optional) When false uses the current URL.

Default value: false

Return

(string) New URL query string.

Source

File: wp-includes/functions.php

function remove_query_arg( $key, $query = false ) {
	if ( is_array( $key ) ) { // Removing multiple keys.
		foreach ( $key as $k ) {
			$query = add_query_arg( $k, false, $query );
		}
		return $query;
	}
	return add_query_arg( $key, false, $query );
}

Changelog

Version Description
1.5.0 Introduced.

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