Get Query String Parameters with JavaScript

By  on  

Query string parameters have been incredibly useful on the server side since the internet took liftoff, but it wasn't until AJAX-driven web apps became popular that we relied too much on them on the client side. Not only do we grab parameter values but we also modify them dynamically with the History API, so these parameters play a major role outside of the initial page load.

We've always been able to get the full query string via the window.location.search property:

console.log(window.location.search);
// "?post=1234&action=edit"

...but in a world of setters, getters, and JSON, there must be a better way to get values than parsing a string, right? After years of ugly string parsing, there's a better way: URLSearchParams Let's have a look at how we can use this new API to get values from the location!

// Assuming "?post=1234&action=edit"

var urlParams = new URLSearchParams(window.location.search);

console.log(urlParams.has('post')); // true
console.log(urlParams.get('action')); // "edit"
console.log(urlParams.getAll('action')); // ["edit"]
console.log(urlParams.toString()); // "?post=1234&action=edit"
console.log(urlParams.append('active', '1')); // "?post=1234&action=edit&active=1"

URLSearchParams also provides familiar Object methods like keys(), values(), and entries():

var keys = urlParams.keys();
for(key of keys) { 
  console.log(key); 
}
// post
// action

var entries = urlParams.entries();
for(pair of entries) { 
  console.log(pair[0], pair[1]); 
}

URLSearchParams reminds me a lot of the classList API -- very simple methods yet very useful.

JavaScript Fallback

While URLSearchParams is ideal, not all browsers support that API. There's a polyfill available but if you want a tiny function for basic query string parsing, the following is a function stolen from the A-Frame VR toolkit which parses the query string to get the key's value you'd like:

function getUrlParameter(name) {
    name = name.replace(/[\[]/, '\\[').replace(/[\]]/, '\\]');
    var regex = new RegExp('[\\?&]' + name + '=([^&#]*)');
    var results = regex.exec(location.search);
    return results === null ? '' : decodeURIComponent(results[1].replace(/\+/g, ' '));
};

With the function above, you can get individual parameter values:

getUrlParameter('post'); // "1234"
getUrlParameter('action'); // "edit"

Anyways, enjoy this function -- you'll find yourself needing it more than you think!

Recent Features

  • By
    From Webcam to Animated GIF: the Secret Behind chat.meatspac.es!

    My team mate Edna Piranha is not only an awesome hacker; she's also a fantastic philosopher! Communication and online interactions is a subject that has kept her mind busy for a long time, and it has also resulted in a bunch of interesting experimental projects...

  • By
    Create a CSS Flipping Animation

    CSS animations are a lot of fun; the beauty of them is that through many simple properties, you can create anything from an elegant fade in to a WTF-Pixar-would-be-proud effect. One CSS effect somewhere in between is the CSS flip effect, whereby there's...

Incredible Demos

  • By
    HTML5 Input Types Alternative

    As you may know, HTML5 has introduced several new input types: number, date, color, range, etc. The question is: should you start using these controls or not? As much as I want to say "Yes", I think they are not yet ready for any real life...

  • By
    Rotate Elements with CSS Transformations

    I've gone on a million rants about the lack of progress with CSS and how I'm happy that both JavaScript and browser-specific CSS have tried to push web design forward. One of those browser-specific CSS properties we love is CSS transformations. CSS transformations...

Discussion

  1. So on a tiny snippet like this, I wonder if caching the generated RegExp would help or hurt perf:

    https://jsfiddle.net/0p17799t/

    • MaxArt

      Honestly, why are you even thinking about performance for something like that? It’s not like something you need to do hundreds of times every second.

  2. MaxArt

    > I’d much rather the search property be a key: value object.

    Well, while something like PHP’s $_GET would be useful, it’s also true that query strings aren’t alwas URL-encoded maps.
    I’d love to have an additional property in location for that, though.

  3. I’ve been using the following snippet for a while:

    function getQueryVariable(variable) {
    	var query = window.location.search.substring(1);
    	var vars = query.split("&");
    	for (var i=0;i<vars.length;i++) {
    		var pair = vars[i].split("=");
    		if(pair[0] == variable){return pair[1];}
    	}
    	return(false);
    }
    
  4. Tim Snadden

    lil’-uri does this quite nicely https://github.com/lil-js/uri

  5. I built a tiny function to do this: https://github.com/travishorn/qs

    Include qs.js in your HTML file, then call

    qs.get()

    . The output is:

    {
      post: "1234",
      action: "edit"
    }
  6. Too bad you can’t get object, with all parameters, with this API and you need to know what parameter to get.

  7. Forgive me if I am wrong, but i am fairy certain the .exec method is not the way to do this anymore.

  8. Tbox

    I am using AddToAny for referral program.
    I can’t figure how to custom a specific url.

    The

    window.location.href

    url is : https://www.mywebsite.com/bravo/?r=number
    (number is variable but always a number)

    I would like to use this

    window.location.href

    url to custom the AddToAny share link. What I need as a restult is:
    https://www.mywebsite.com/?r=number

    Do you think it is possible using Javascript

  9. Steve

    In my case I can’t use window.location.search because
    I am doing an ajax load into div.

    $( "#result" ).load( "service.html?param1=1&param2=2");
    

    In this case how can I read the param1 and 2 values when I am inside service.html?

  10. Kim Damsleth

    Thank you for this function. I really enjoy using it! I would like to use it even more when time allows.

  11. Brandon

    Joe’s code
    (found here & above in his comment) seems to be better for performance from what I can see.

    function getQueryVariable(variable) {
    	var query = window.location.search.substring(1);
    	var vars = query.split("&");
    	for (var i=0;i<vars.length;i++) {
    		var pair = vars[i].split("=");
    		if(pair[0] == variable){return pair[1];}
    	}
    	return(false);
    }

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!