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

Description

Parameters

$keystring|string[]

Query key or keys to remove.

$queryfalse|stringoptional

When false uses the current URL. Default false.Default: false

Return

string

New URL query string.

Uses · 1

• add_query_arg()Retrieves a modified URL query string.

Used by · 25

• WP_Comments_List_Table::get_views()
• WP_Customize_Manager::customize_preview_settings()Prints JavaScript settings for preview frame.
• WP_Customize_Manager::set_return_url()Sets URL to link the user to when closing the Customizer.
• WP_List_Table::pagination()Displays the pagination.
• WP_List_Table::print_column_headers()Prints column headers, accounting for hidden and sortable columns.
• WP_List_Table::view_switcher()Displays a view switcher.
• Walker_Nav_Menu_Edit::start_el()Start the element output.
• _post_format_link()Filters the post format term link to remove the format prefix.
• _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_get_site_editor_redirection_url()Maps old site editor urls to the new updated ones.
• get_cancel_comment_reply_link()Retrieves HTML content for cancel comment reply link.
• get_pagenum_link()Retrieves the link for a page number.

Source

View on Trac ↗View on GitHub ↗

1219function remove_query_arg( $key, $query = false ) {1220	if ( is_array( $key ) ) { // Removing multiple keys.1221		foreach ( $key as $k ) {1222			$query = add_query_arg( $k, false, $query );1223		}1224		return $query;1225	}1226	return add_query_arg( $key, false, $query );1227}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.