W3cubDocs

/WordPress

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

Removes an item or items from a query string.

Description

Important: The return value of remove_query_arg() is not escaped by default. Output should be late-escaped with esc_url() or similar to help prevent vulnerability to cross-site scripting (XSS) attacks.

Parameters

$keystring|string[]required
Query key or keys to remove.
$queryfalse|stringoptional
When false uses the current URL.

Default:false

Return

string New URL query string.

Source

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–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/remove_query_arg