wpseek.com
A WordPress-centric search engine for devs and theme authors



remove_query_arg › WordPress Function

Since1.5.0
Deprecatedn/a
› remove_query_arg ( $key, $query = false )
Parameters: (2)
  • (string|string[]) $key Query key or keys to remove.
    Required: Yes
  • (false|string) $query Optional. When false uses the current URL. Default false.
    Required: No
    Default: false
Returns:
  • (string) New URL query string.
Defined at:
Codex:

Removes an item or items from a query string.

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.


Related Functions: wp_removable_query_args, remove_user_from_blog, add_query_arg, get_query_var, set_query_var

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 );
}