remove_query_arg( string|string[] $key, false|string $query = false )
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
- $key
-
(Required) Query key or keys to remove.
- $query
-
(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. |