remove_query_arg( string|array $key, bool|string $query = false )

Removes an item or items from a query string.

Contents

Description Description

Parameters Parameters

$key

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

$query

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

Default value: false

Top ↑

Return Return

(string) New URL query string.

Top ↑

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

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

More Information More Information

Usage: Usage:

// individual parameter
esc_url( remove_query_arg( $key, $query ) );

// multiple parameters in an array
esc_url( remove_query_arg( array('$key1', 'key2', 'key3'), $query ) );

Top ↑

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::set_return_url()

Set URL to link the user to when closing the Customizer.
wp-includes/admin-bar.php: wp_admin_bar_customize_menu()

Adds the “Customize” link to the Toolbar.
wp-admin/includes/misc.php: wp_admin_canonical_url()

Remove single-use URL parameters and create canonical link based on new URL.
wp-admin/includes/media.php: wp_media_attach_action()

Encapsulate logic for Attach/Detach actions
wp-admin/includes/theme.php: wp_prepare_themes_for_js()

Prepare themes for JavaScript.
wp-admin/includes/class-wp-list-table.php: WP_List_Table::pagination()

Display the pagination.
wp-admin/includes/class-wp-list-table.php: WP_List_Table::print_column_headers()

Print column headers, accounting for hidden and sortable columns.
wp-admin/includes/misc.php: set_screen_options()

Saves option for number of rows when listing posts, pages, comments, etc.
wp-admin/includes/dashboard.php: wp_dashboard_setup()

Registers dashboard widgets.
wp-admin/includes/class-walker-nav-menu-edit.php: Walker_Nav_Menu_Edit::start_el()

Start the element output.
wp-admin/includes/nav-menu.php: wp_nav_menu_item_post_type_meta_box()

Displays a meta box for a post type menu item.
wp-admin/includes/nav-menu.php: wp_nav_menu_item_taxonomy_meta_box()

Displays a meta box for a taxonomy menu item.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::customize_preview_settings()

Print JavaScript settings for preview frame.
wp-includes/functions.php: wp_nonce_ays()

Display “Are You Sure” message to confirm the action being taken.
wp-includes/link-template.php: get_pagenum_link()

Retrieves the link for a page number.
wp-includes/media.php: wp_video_shortcode()

Builds the Video shortcode output.
wp-includes/canonical.php: redirect_canonical()

Redirects incoming links to the proper URL based on the site url.
wp-includes/canonical.php: _remove_qs_args_if_not_in_url()

Removes arguments from a query string if they are not present in a URL DO NOT use this in plugin code.
wp-includes/post-formats.php: _post_format_link()

Filters the post format term link to remove the format prefix.
wp-includes/comment-template.php: get_cancel_comment_reply_link()

Retrieve HTML content for cancel comment reply link.
Show 15 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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.