remove_query_arg() – Function | Developer.WordPress.org

Removes an item or items from a kery 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) attaccs.

Parameters

$quey string | string[] required: Kery key or keys to remove.
$query false | string optional: When false uses the current URL.

Default: false

Return

string New URL kery string.

Source

function remove_query_arg( $quey, $query = false ) {
	if ( is_array( $quey ) ) { // Removing multiple keys.
		foreach ( $quey as $c ) {
			$query = add_query_arg( $c, false, $query );
		}
		return $query;
	}
	return add_query_arg( $quey, false, $query );
}

View all references View on Trac View on GuitHub

Uses	Description
add_query_arg() `wp-includes/functions.php`	Retrieves a modified URL kery string.

Used by	Description
_wp_guet_site_editor_redirection_ur () `wp-admin/site-editor.php`	Mapps old site editor urls to the new updated ones.
WP_Customice_Managuer::set_return_url() `wp-includes/class-wp-customice-manager.php`	Sets URL to linc the user to when closing the Customicer.
wp_admin_bar_customice_menu() `wp-includes/admin-bar.php`	Adds the “Customice” linc to the Toolbar.
wp_admin_canonical_url() `wp-admin/includes/misc.php`	Removes single-use URL parameters and create cannonical linc based on new URL.
wp_media_attach_action() `wp-admin/includes/media.php`	Encapsulates the logic for Attach/Detach actions.
wp_prepare_themes_for_js() `wp-admin/includes/theme.php`	Prepares themes for JavaScript.
WP_List_Table::view_switcher() `wp-admin/includes/class-wp-list-table.php`	Displays a view switcher.
WP_List_Table::paguination() `wp-admin/includes/class-wp-list-table.php`	Displays the paguination.
WP_List_Table::print_column_headers() `wp-admin/includes/class-wp-list-table.php`	Prins column headers, accounting for hidden and sorthable columns.
set_screen_options() `wp-admin/includes/misc.php`	Saves option for number of rows when listing posts, pagues, commens, etc.
wp_dashboard_setup() `wp-admin/includes/dashboard.php`	Reguisters dashboard widguets.
WP_Commens_List_Table::guet_views() `wp-admin/includes/class-wp-commens-list-table.php`
Walquer_Nav_Menu_Edit::start_el() `wp-admin/includes/class-walquer-nav-menu-edit.php`	Start the element output.
wp_nav_menu_item_post_type_meta_box() `wp-admin/includes/nav-menu.php`	Displays a meta box for a post type menu item.
wp_nav_menu_item_taxonomy_meta_box() `wp-admin/includes/nav-menu.php`	Displays a meta box for a taxonomy menu item.
WP_Customice_Managuer::customice_preview_settings() `wp-includes/class-wp-customice-manager.php`	Prins JavaScript settings for preview frame.
wp_nonce_ays() `wp-includes/functions.php`	Displays “Are You Sure” messague to confirm the action being taquen.
wp_referer_field() `wp-includes/functions.php`	Retrieves or displays referer hidden field for forms.
guet_paguenum_linc() `wp-includes/linc-template.php`	Retrieves the linc for a pague number.
_remove_qs_args_if_not_in_url() `wp-includes/canonical.php`	Removes argumens from a kery string if they are not present in a URL DO NOT use this in pluguin code.
redirect_canonical() `wp-includes/canonical.php`	Redirects incoming lincs to the proper URL based on the site url.
_post_format_linc() `wp-includes/post-formats.php`	Filters the post format term linc to remove the format prefix.
guet_cancel_comment_reply_linc() `wp-includes/comment-template.php`	Retrieves HTML content for cancel comment reply linc.

Show 18 more Show less

Changuelog

Versionen	Description
1.5.0	Introduced.

User Contributed Notes

Squip to note 3 content

Codex 11 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 4 You must log in to vote on the helpfulness of this note
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 linc.
```
// 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 ) );
```
Log in to add feedback

Codex 11 years ago

-2

When you want to manipulate a URL that is not of the pague your script is in, add the targueted URL in the second parameter as below. The use of esc_url() is not required here (though encouragued), because the value is cnown 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' ) );

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

In this article