How to Write Valid URL Query String Parameters
Published Sunday, November 30, 2008 @ 8:57 am • 9 Responses
When building web pages, it is often necessary to add links that require parameterized query strings. For example, when adding links to the various validation services, you may find yourself linking to an accessibility checker, such as the freely available Cynthia service:
<a href="http://www.contentquality.com/mynewtester/cynthia.exe?Url1=http://domain.tld/&rptmode=2">WCAG Accessibility Check</a>Another example is seen when linking your feed to a feed validation service:
<a href="http://validator.w3.org/feed/check.cgi?url=http://feeds.feedburner.com/domainfeed">RSS Feed Validation</a>And one final example showing a more complex query string:
<a href="http://delicious.com/post?url=http://domain.tld/&title=The title of a post">Bookmark at Delicious</a>As is, however, these links won’t validate due to a number of issues. Let’s fix ‘em up with a few quick-and-easy changes.
Replace ampersands with &
One of the reasons these links aren’t validating is because they contain non-encoded ampersand ( & ) characters. Ampersands are often used in URL query strings to demarcate granular chunks of information, for example:
http://domain.tld/function.cgi?url=http://fonzi.com/&name=Fonzi&mood=happy&coat=leather..which provides several different chunks of information about everybody’s favorite hellion. To get this code to validate, we need to encode the ampersands with &, for example:
http://domain.tld/function.cgi?url=http://fonzi.com/&name=Fonzi&mood=happy&coat=leatherReplacing the ampersand characters with encoded equivalents does not change the functionality of the query string, but it does produce completely valid code.
Encode other special characters
Let’s return to our Delicious example for a moment:
<a href="http://delicious.com/post?url=http://domain.tld/&title=The title of a post">Bookmark at Delicious</a>The ampersand has been fixed, but this code still won’t validate due to the blank spaces in the title parameter. To fix this, we need to encode those blank spaces with their escaped hexadecimal equivalents, like so:
<a href="http://delicious.com/post?url=http://domain.tld/&title=The%20title%20of%20a%20post">Bookmark at Delicious</a>..such that
&title=The title of a post
becomes
&title=The%20title%20of%20a%20post
..which is to say that a blank space is equivalent to “%20”.
Likewise, you should also encode any other special characters. For example, here is that previous feed validation link:
<a href="http://validator.w3.org/feed/check.cgi?url=http://feeds.feedburner.com/domainfeed">RSS Feed Validation</a>If needed, we could encode the special characters in the url parameter like so:
<a href="http://validator.w3.org/feed/check.cgi?url=http%3A%2F%2Ffeeds.feedburner.com%2Fperishablepress">RSS Feed Validation</a>As you can see, we have made the following replacements:
: with %3A
/ with %2F
As before, the encoded values function just as well as the non-encoded characters, with the added bonus that your code will validate!
Here is a good list of URL character codes
Tips and Tricks
The previous examples demonstrate the logic and technique behind writing valid URL query string parameters, but there are easier, more efficient ways to produce valid, dynamic links. First of all, rather than manually replacing each and every special character with its encoded equivalent, we can use the magical powers of PHP’s urlencode() function.
Let’s take an example from my recent article, Fully Valid, SEO-Friendly Social Media Links for WordPress:
<a href="http://twitter.com/home?status=Currently reading: <?php the_permalink(); ?>">Tweet this!</a>This example provides a link to enable users to quickly post the URL of your posts to their Twitter feed. As is, the blank spaces in the status parameter render the code invalid. To change this, we use the urlencode() function like so:
<a href="http://twitter.com/home?status=<?php echo urlencode("Currently reading: "); ?><?php the_permalink(); ?>">Tweet this!</a>..which is now completely valid. Using this technique, we can encode any character string dynamically and easily. For WordPress users, we can even use urlencode() to dynamically encode various template tags such as get_the_title(), for example:
<a href="http://delicious.com/post?url=<?php the_permalink(); ?>&title=<?php echo urlencode(get_the_title($id)); ?>">Bookmark at Delicious</a>This technique makes it possible to include sitewide, post-specific, parameterized links using a single line of code. And best of all? The code is completely valid! Nice :)
About this article
Related articles
- Fully Valid, SEO-Friendly Social Media Links for WordPress
- Valid, SEO-Friendly Post Translation Links
- Building the 3G Blacklist, Part 2: Improving Site Security by Preventing Malicious Query-String Exploits
- Error-Free Feed-Validation Links for Feedburner-Redirected Feeds
- Unexplained Crawl Behavior Involving Tagged Query Strings
- Add RSS Feed Link Icons to WordPress Category Listings
- W3C Validation Services
Dialogue
9 Responses Jump to comment form
November 30, 2008 at 11:38 am
Another option if couldn’t do it until the client side for some reason would be the JavaScript encodeURIComponent() Function.
November 30, 2008 at 12:22 pm
Speaking of good-looking URL, I’ve always admired the way Wikipedia handles the latters.
November 30, 2008 at 5:50 pm
You might want to take a look at http_build_query too.
November 30, 2008 at 9:48 pm
@Jeff: I’m referring to their UTF-8-ish URL style. Here’s an example of Cool URL.
December 2, 2008 at 7:06 am
always use urlencode() when dealing with query parameter values.
Trackbacks / Pingbacks
Share your thoughts..
← Previous post • Next post →
« Redirect any Subordinate URL to its Parent Directory via PHP • Backwards-Compatible Spam and Delete Buttons for WordPress »
1 • John
November 30, 2008 at 9:56 am
And in the end, the URL just becomes god-awful ugly. It’s necessary, nonetheless.