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

VersionDescription
1.5.0Introduced.

User Contributed Notes

  1. Skip to note 3 content

    Assuming we’re at the WordPress URL “http://www.example.com/client/?details=value1&type=value2&date=value3″…

    Note the use of esc_url() before outputting the link.

    // This would output '/client/?type=value2&date=value3'
    echo esc_url( remove_query_arg( 'details' ) );
    
    // This would output '/client/'
    $arr_params = array( 'details', 'type', 'date');
    echo esc_url( remove_query_arg( $arr_params ) );
  2. Skip to note 4 content

    When you want to manipulate a URL that is not of the page your script is in, add the targeted URL in the second parameter as below. The use of esc_url() is not required here (though encouraged), because the value is known to be safe:

    // This would output 'http://www.example.com/2014/03/11/'
    echo esc_url( remove_query_arg( 'details',  'http://www.example.com/2014/03/11/?details=value1' ) );
    
    // This would output 'http://www.example.com/2014/03/11/?type=value2&date=value3'
    echo esc_url( remove_query_arg( 'details',  'http://www.example.com/2014/03/11/?details=value1&type=value2&date=value3' ) );
    
    // This would output 'http://www.example.com/2014/03/11/'
    $arr_params = array( 'details', 'type', 'date');
    echo esc_url( remove_query_arg( $arr_params, 'http://www.example.com/2014/03/11/?details=value1&type=value2&date=value3' ) );

You must log in before being able to contribute a note or feedback.