remove( )


Removes query parameters from the current page's URL.

Removes one or more query parameters to the current page's URL.

The remove() function can only be used when browser rendering happens, meaning you can only use it in frontend code after the page is ready.

If a specified key does not exist as a query parameter, it is ignored.

Calling the remove() function triggers the onChange() event handler if it has been registered.

Note: To retrieve the page's current query parameters, use the query property.

Method Declaration
Copy
function remove(toRemove: Array<string>): void;
Method Parameters
toRemoveArray<string>Required

List of keys to remove.

JavaScript
import wixLocationFrontend from "wix-location-frontend"; // ... wixLocationFrontend.queryParams.remove(["key1"]); // URL before removal: // www.mysite.com/page?key1=value1&key2=value2 // URL after removal: // www.mysite.com/page?key2=value2
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?