Variables

URLs

Last updated: Mon, 26 Nov 2007

urlencode

(PHP 4, PHP 5)

urlencode — 编码 URL 字符串

说明

string urlencode ( string $str )

返回字符串，此字符串中除了 -_. 之外的所有非字母数字字符都将被替换成百分号（%）后跟两位十六进制数，空格则编码为加号（+）。此编码与 WWW 表单 POST 数据的编码方式是一样的，同时与 application/x-www-form-urlencoded 的媒体类型编码方式一样。由于历史原因，此编码在将空格编码为加号（+）方面与 RFC1738 编码（参见 rawurlencode()）不同。此函数便于将字符串编码并将其用于 URL 的请求部分，同时它还便于将变量传递给下一页：

Example#1 urlencode() 例子


<?php
echo '<a href="mycgi?foo=', urlencode($userinput), '">';
?>

注意：小心与 HTML 实体相匹配的变量。像 &amp、&copy 和 &pound 都将被浏览器解析，并使用实际实体替代所期待的变量名。这是明显的混乱，W3C 已经告诫人们好几年了。参考地址：» http://www.w3.org/TR/html4/appendix/notes.html#h-B.2.2。PHP 通过 arg_separator.ini 指令，支持将参数分割符变成 W3C 所建议的分号。不幸的是大多数用户代理并不发送分号分隔符格式的表单数据。较为简单的解决办法是使用 & 代替 & 作为分隔符。你不需要为此修改 PHP 的 arg_separator。让它仍为 &，而仅使用 htmlentities() 或 htmlspecialchars() 对你的 URL 进行编码。

Example#2 urlencode() 与 htmlentities() 例子


<?php
$query_string = 'foo=' . urlencode($foo) . '&bar=' . urlencode($bar);
echo '<a href="mycgi?' . htmlentities($query_string) . '">';
?>

参见 urldecode()，htmlentities()，rawurldecode() 和 rawurlencode()。

Variables

URLs

Last updated: Mon, 26 Nov 2007

add a note User Contributed Notes
urlencode

php dot net at unixen dot dk
16-Jun-2008 03:53


>> Hi muthuishere , i saw your excellent contribution, but couldnt make it work, so i corrected some bits and pieces and had the following done:



<?php

function SmartUrlEncode($url){

    if (strpos($url, '=') === false):

        return $url;

    else:

        $startpos = strpos($url, "?");

        $tmpurl=substr($url, 0 , $startpos+1) ;

        $qryStr=substr($url, $startpos+1 ) ;

         $qryvalues=explode("&", $qryStr);

          foreach($qryvalues as $value):

              $buffer=explode("=", $value);

            $buffer[1]=urlencode($buffer[1]);

           endforeach;

          $finalqrystr=implode("&amp;", &$qryvalues);

        $finalURL=$tmpurl . $finalqrystr;

        return $finalURL;

    endif;

}

?>



As you see its very much yours, modfied primarily using '&amp;' instead of '&', and ofcourse an if test to see if anything in input is to be cursed... Thanks for great function !

muthuishere at gmail dot com
08-Jun-2008 12:50


Most of us may need a function



 if they have entire URL but you need to be encoding only the query values  , not the URL and not the parameters



The below function takes an URL as input and applies url encoding only to the parameter values



/******************************************



For eg www.google.com/?q=alka rani&start=100  



urlencode

   ==>  www.google.com/search?q=alka+rani&start=100



if you change it to rawurlencode

  ==>  www.google.com/search?q=alka%20rani&start=100



**************************************/

function SmartUrlEncode($url){



//Extract the Querystr pos after ? mark

$startpos = stripos($url, "?");



//Extract the URl alone

$tmpurl=substr($url, 0 , $startpos+1) ;

//echo $tmpurl . "<br>";



//Extract the Querystr alone

$qryStr=substr($url, $startpos+1 ) ;



//echo $qryStr . "<br>";



//Split the querystring into & pairs

 $qryvalues=explode("&", $qryStr);



  foreach($qryvalues as  &$value)

  {

    //Split the single data into two i.e data   |  value



      $buffer=explode("=", $value);



    // Urlencode only the value now , Change it to rawurlencode if necessary

    $buffer[1]=urlencode($buffer[1]);

    

    //Join values back in the array

    $value = implode("=", $tmp);

  

  }

  //Output Querystr ,Join all the pairs with & 

  $finalqrystr=implode("&", $qryvalues);

//  echo $finalqrystr . "<br>";



$finalURL=$tmpurl . $finalqrystr;



//echo $finalURL . "<br>";



return finalURL;

}



}

simon dot rupf at int-ag dot ch
13-Apr-2008 06:20


Kerdster's function works like a charm. It has only a minor beauty flaw in my humble opinion: It encodes every character, even the plain ascii ones. This just doesn't like nice in the browsers address bar. ;-)



Inspired by Mkaganer's utf8_urldecode example in urldecode comments here's the enhanced code:



<?php

    function utf16_urlencode ( $str ) {

        # convert characters > 255 into HTML entities

        $convmap = array( 0xFF, 0x2FFFF, 0, 0xFFFF );

        $str = mb_encode_numericentity( $str, $convmap, "UTF-8");



        # escape HTML entities, so they are not urlencoded

        $str = preg_replace( '/&#([0-9a-fA-F]{2,5});/i', 'mark\\1mark', $str );

        $str = urlencode($str);



        # now convert escaped entities into unicode url syntax

        $str = preg_replace( '/mark([0-9a-fA-F]{2,5})mark/i', '%u\\1', $str );

        return $str;

    }

?>



Probably the above code could be optimized further, comments are highly appreciated!



Thanks, Simon

kerdster at gmail dot com
28-Feb-2008 08:02


> php dot net at samokhvalov dot com

 > 12-Dec-2006 09:49



Thanx for idea!

I have wrote more simple function based on your function to simulate JS function escape (); It uses mb_string functions unstead of iconv.



<?php

function utf16urlencode($str)

{

    $str = mb_convert_encoding($str, 'UTF-16', 'UTF-8');

    $out = '';

    for ($i = 0; $i < mb_strlen($str, 'UTF-16'); $i++) 

    {

        $out .= '%u'.bin2hex(mb_substr($str, $i, 1, 'UTF-16'));

    }

    return $out;

}

?>

rezamilanx at yahoo
11-Feb-2008 05:34


Some people have difficulties with all urlencode and so on solutions. So I decided to solve using base64_encode several times for more security from this way:



//- First page:

<?

$url='mypage.php';

?>

<a href="index.php?page=<? echo encode($url,5); ?>">My page</a>



//- Second page:

<?

$mypage=$_GET['page'];

$mypage=decode($mypage,5);

echo file_get_contents($mypage);

?>



*file_get_contents could not run your php scripts see same function

-----------

function encode($ss,$ntime){

    for($i=0;$i<$ntime;$i++){

        $ss=base64_encode($ss);

    }

retrun $ss;

}



function decode($ss,$ntime){

    for($i=0;$i<$ntime;$i++){

        $ss=base64_decode($ss);

    }

retrun $ss;

}

randallgirard at hotmail dot com
08-Feb-2008 08:49


As a reply to: mmj48.com



Your method of replacing just the slash would be BAD practice... UNLESS, it was used STRICTLY on the PATH part of the URL.



You must account for the URLQUERIES, but also the scheme, user, password, and fragment characters (:, /, &, #, etc)

However, these may change depending on the environment (mainly refering to the &, query var separator)



Escaping each of these would also be a bad practice, and impractical. Rather, build a class / tool which will generate your URL's, and render escapes. You could also use the PHP routine: parse_url() for some interesting results.

Thomas
05-Sep-2007 05:30


Reply to 'peter at mailinator dot com'



If you are having problems using urldecode in PHP following the escape() function in Javascript, try to do a decodeURI() before the escape(). This fixed it for me at least.



Thomas

mmj48.com
07-Aug-2007 11:28


What I use instead:



<?php

function escape($url)

{

    return str_replace("%2F", "/", urlencode($url));

}

?>

ahrensberg at gmail dot com
05-Aug-2007 08:04


Like "Benjamin dot Bruno at web dot de" earlier has writen, you can have problems with encode strings with special characters to flash. Benjamin write that:



<?php

   function flash_encode ($input)

   {

      return rawurlencode(utf8_encode($input));

   }

?>



... could do the problem. Unfortunately flash still have problems with read some quotations, but with this one:



<?php

   function flash_encode($string)

   {

      $string = rawurlencode(utf8_encode($string));



      $string = str_replace("%C2%96", "-", $string);

      $string = str_replace("%C2%91", "%27", $string);

      $string = str_replace("%C2%92", "%27", $string);

      $string = str_replace("%C2%82", "%27", $string);

      $string = str_replace("%C2%93", "%22", $string);

      $string = str_replace("%C2%94", "%22", $string);

      $string = str_replace("%C2%84", "%22", $string);

      $string = str_replace("%C2%8B", "%C2%AB", $string);

      $string = str_replace("%C2%9B", "%C2%BB", $string);



      return $string;

   }

?>



... should solve this problem.

mensonge
26-Jul-2007 09:29


I had difficulties with all above solutions. So I applied a dirty simple solution by using:



base64_encode($param)

and

base64_decode($param)



The string's length is a bit longer but no more problem with encoding.

sebastiaan at netomzet dot nl
06-Mar-2007 01:04


quote: "Apache's mod_rewrite and mod_proxy are unable to handle urlencoded URLs properly - http://issues.apache.org/bugzilla/show_bug.cgi?id=34602" 



The most simple solution is to use urlencode twice! 



echo urlencode(urlencode($var));



Apache's mod_rewrite will handle it like a normal string using urlencode once.

in reply to "kL"
20-Feb-2007 05:23


kL's example is very bugged since it loops itself and the encode function is two-way.



Why do you replace all %27 through '  in the same string in that you replace all ' through %27?



Lets say I have a string: Hello %27World%27. It's a nice day.

I get: Hello Hello 'World'. It%27s a nice day.



With other words that solution is pretty useless.



Solution:

Just replace ' through %27 when encoding

Just replace %27 through ' when decoding. Or just use url_decode.

rm<at>mindbench<dot>nl
14-Feb-2007 09:32


Another thing to keep in mind is that urlencode is not unicode.



For example, urlencoding enquête from an UTF-8 project will produce enqu%C3%AAte.



However, urlencode(utf8_decode('enquête')) produces enqu%EAte, like expected.

php dot net at samokhvalov dot com
13-Dec-2006 09:18


Addition to the previous note:



to make it work on *nix systems (where big-endian byte order in UTF-16 is being used, in contrast to WIN32) add following lines right after the second iconv():



            if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {

                $b = $a;

                $a[1] = $b[0];

                $a[0] = $b[1];

            }

php dot net at samokhvalov dot com
13-Dec-2006 02:49


In AJAX era you might need to use UCS-2 (UTF-16) url-encoding (chars represented in form '%uXXXX' - e.g. '%u043e' for Russian 'o'). But PHP is weak in working with multibyte encoded strings, so you cannot simply use urlencode() for the string in UCS-2. Here is simple function serving for this purpose.



Note, that this function takes UTF8-encoded string as input and, then, for internal purposes use some 1-byte encoding (cp1251 in my case). If you have the string in some 1-byte encoding, you may remove the first iconv() and modify the second one and thus slightly simplify the function.



function utf16urlencode($str)

{

    $str = iconv("utf-8", "cp1251", $str);

    $res = "";

    for ($i = 0; $i < strlen($str); $i++) {

        $res .= "%u";

        $a = iconv("cp1251", "ucs-2", $str[$i]);

        for ($j = 0; $j < strlen($a); $j++) {

            $n = dechex(ord($a[$j]));

            if (strlen($n) == 1) {

                $n = "0$n";

            }

            $res .= $n;

        }

    }

    return $res;

}

Benjamin dot Bruno at web dot de
04-Oct-2006 12:54


If you need to prepare strings with special characters (like German Umlaut characters) in order to import them into flash files via GET, try using utf8_encode and rawurlencode sequentially, like this: 



<?php 

function flash_encode ($input) {

  return rawurlencode(utf8_encode($input));

}

?>



Thus, you can avoid having use encodeURI in JavaScript, which is only availabe in JavaScript 1.5.

kL
07-Sep-2006 08:13


Apache's mod_rewrite and mod_proxy are unable to handle urlencoded URLs properly - http://issues.apache.org/bugzilla/show_bug.cgi?id=34602



If you need to use any of these modules and handle paths that contain %2F or %3A (and few other encoded special url characters), you'll have use a different encoding scheme.



My solution is to replace "%" with "'".

<?php

function urlencode($u)

{

    return str_replace(array("'",'%'),array('%27',"'"),urlencode($u));

}



function urldecode($u)

{

    return urldecode(strtr($u,"'",'%'));

}

?>

peter at runempire dot com
06-Aug-2006 05:09


I think this was mentioned earlier but it was confusing.. But I had some problems with the urlencode eating my '/' so I did a simple str_replace like the following:



$url = urlencode($img);

$img2 = "$url";

$img2 = str_replace('%2F54', '/', $img2);

$img2 = str_replace('+' , '%20' , $img2);



You don't need to replace the '+' but I just feel comfortable with my %20, although it may present a problem if whatever you're using the str_replace for has a '+' in it where it shouldn't be.



But that fixed my problem.. all the other encodes like htmlentities and rawurlencode just ate my /'s

peter at mailinator dot com
22-Jul-2006 02:11


Be carefull when using this function with JavaScript escape function.



In JavaScript when you try to encode utf-8 data with escape function you will get some strange encoded string which you wont be able to decode with php url(de)encode funtions.



I found a website which has some very good tool regarding this problem: http://www.webtoolkit.info/



It has components which deal with url (en)decode.

Roamy: info AT roamy DOT de
29-Jan-2006 03:58


<?// urlencode + urldecode 4 Linux/Unix-Servers:=============

//==================================================

//=====This small script matches all encoded String for ========

//=====Linux/Unix-Servers For IIS it got to be  The Other Way  ==

//===== around...and remember in a propper Url =============

//===== there shoudn't be the 'dirty Letter': %C3==============

//==================================================

function int2hex($intega){

    $Ziffer = "0123456789ABCDEF";

return $Ziffer[($intega%256)/16].$Ziffer[$intega%16];

}

function url_decode($text){

    if(!strpos($text,"%C3"))

        for($i=129;$i<255;$i++){

            $in = "%".int2hex($i);

            $out = "%C3%".int2hex($i-64);

            $text = str_replace($in,$out,$text);

        }

return urldecode($text);

}

function url_encode($text){

    $text = urlencode($text);

    if(!strpos($text,"%C3"))

        for($i=129;$i<255;$i++){

            $in = "%".int2hex($i);

            $out = "%C3%".int2hex($i-64);

            $text = str_replace($in,$out,$text);

        }

return $text;

}//==================================================

?>

torecs at sfe dot uio dot no
11-Jan-2006 07:30


This very simple function makes an valid parameters part of an URL, to me it looks like several of the other versions here are decoding wrongly as they do not convert & seperating the variables into &amp;. 



  $vars=array('name' => 'tore','action' => 'sell&buy');

  echo MakeRequestUrl($vars);

  

  /* Makes an valid html request url by parsing the params array

   * @param $params The parameters to be converted into URL with key as name.

   */

  function MakeRequestUrl($params)

  {

      $querystring=null;

    foreach ($params as $name => $value)

    {

      $querystring=$name.'='.urlencode($value).'&'.$querystring;

    }

      // Cut the last '&'

      $querystring=substr($querystring,0,strlen($querystring)-1);

      return htmlentities($querystring);

  }



  Will output: action=sell%26buy&amp;name=tore

roberlamerma at gmail dot com
22-Nov-2005 11:00


I rewrote inus at flowingcreativity dot net function to generate an encoded url string from the POST, or GET array. It handles properly POST/GET array vars.



function _HTTPRequestToString($arr_request, $var_name, $separator='&') {

    $ret = "";

    if (is_array($arr_request)) {

        foreach ($arr_request as $key => $value) {

            if (is_array($value)) {

                if ($var_name) {

                    $ret .= $this->_HTTPRequestToString($value, "{$var_name}[{$key}]", $separator);

                } else {

                    $ret .= $this->_HTTPRequestToString($value, "{$key}", $separator);

                }

            } else {

                if ($var_name) {

                    $ret .= "{$var_name}[{$key}]=".urlencode($value)."&";

                } else {

                    $ret .= "{$key}=".urlencode($value)."&";

                }

            }

        }

    }

    if (!$var_name) {

        $ret = substr($ret,0,-1);

    }

    return $ret;

}

Chris
01-Nov-2005 12:54


Just remember that according to W3C standards, you must rawurlencode() the link that's provided at the end of a mailto.



i.e.

<a href="mailto:jdoe@some.where.com?Subject=Simple testing(s)&bcc=jane@some.where.com">Mail Me</a>



Needs to be escaped (which rawurlencode() does for us).

The colon is OK after "mailto", as is the "@" after the e-mail name.

However, the rest of the URL needs to be encoded, replacing the following:

'?' => %3F

'=' => %3D

' ' => %20

'(' => %28

')' => %29

'&' => %26

'@' => %40 (note this one is in 'jane@some.where.com'



I tried to post the note with the correct text (that is the characters replaced in the note), but it said that there was a line that was too long, and so wouldn't let me add the note.



As a secondary note, I noticed that the auto-conversion routines at this site itself stopped the link at the space after "Simple testing(s)' in the first entry shown above.

bisqwit at iki dot fi
02-Sep-2005 04:27


Constructing hyperlinks safely HOW-TO:



<?php

$path_component = 'machine/generated/part';

$url_parameter1 = 'this is a string';

$url_parameter2 = 'special/weird "$characters"';



$url = 'http://example.com/lab/cgi/test/'. rawurlencode($path_component) . '?param1=' . urlencode($url_parameter1) . '&param2=' . urlencode($url_parameter2);



$link_label = "Click here & you'll be <happy>";



echo '<a href="', htmlspecialchars($url), '">', htmlspecialchars($link_label), '</a>';

?>



This example covers all the encodings you need to apply in order to create URLs safely without problems with any special characters. It is stunning how many people make mistakes with this.



Shortly:

- Use urlencode for all GET parameters (things that come after each "=").

- Use rawurlencode for parts that come before "?".

- Use htmlspecialchars for HTML tag parameters and HTML text content.

R Mortimer
26-Aug-2005 04:14


Do not let the browser auto encode an invalid URL. Not all browsers perform the same encodeing. Keep it cross browser do it server side.

Bachsau
13-Aug-2005 01:24


Diferrent from the above example you do not have to encode URLs in hrefs with this. The browser does it automaticaly, so you just have to encode it with htmlentities() ;)

linus at flowingcreativity dot net
05-Jul-2005 12:14


I just came across the need for a function that exports an array into a query string. Being able to use urlencode($theArray) would be nice, but here's what I came up with:



<?php



function urlencode_array(

    $var,                // the array value

    $varName,            // variable name to be used in the query string

    $separator = '&'    // what separating character to use in the query string

) {

    $toImplode = array();

    foreach ($var as $key => $value) {

        if (is_array($value)) {

            $toImplode[] = urlencode_array($value, "{$varName}[{$key}]", $separator);

        } else {

            $toImplode[] = "{$varName}[{$key}]=".urlencode($value);

        }

    }

    return implode($separator, $toImplode);

}



?>



This function supports n-dimensional arrays (it encodes recursively).

edwardzyang at thewritingpot dot com
16-Apr-2005 04:48


I was testing my input sanitation with some strange character entities. Ones like � and � were passed correctly and were in their raw form when I passed them through without any filtering.



However, some weird things happen when dealing with characters like (these are HTML entities): &#8252; &#9616; &#9488;and &#920; have weird things going on.



If you try to pass one in Internet Explorer, IE will *disable* the submit button. Firefox, however, does something weirder: it will convert it to it's HTML entity. It will display properly, but only when you don't convert entities.



The point? Be careful with decorative characters.



PS: If you try copy/pasting one of these characters to a TXT file, it will translate to a ?.

Timwi
17-Feb-2005 07:49


The information on this page is misleading in that you might think the ampersand (&) will only need to be escaped as &amp; when there is ambiguity with an existing character entity. This is false; the W3C page linked to from here clarifies that the ampersands must ALWAYS be escaped.



The following:



  <a href='/script.php?variable1=value1&variable2=value2'>Link</a>



is INVALID HTML. It needs to be written as:



  <a href='/script.php?variable1=value1&amp;variable2=value2'>Link</a>



in order for the link to go to:



  /script.php?variable1=value1&variable2=value2



I applaud the W3C's recommendation to use semicolons (';') instead of the ampersands, but it doesn't really change the fact that you still need to HTML-escape the value of all your HTML tag attributes. The following:



  <span title='Rose & Mary'>Some text</span>



is also INVALID HTML. It needs to be escaped as:



  <span title='Rose &amp; Mary'>Some text</span>

george at ishop dot com
04-Nov-2004 05:35


---[ Editor's Note ]---


You can also use rawurlencode() here, and skip the functions provided in this note.


---[ /Editor's Nore]---





For handling slashes in redirections, (see comment from cameron at enprises dot com), try this :





function myurlencode ( $TheVal )


{


 return urlencode (str_replace("/","%2f",$TheVal));


}





function myurldecode ( $TheVal )


{


 return str_replace("%2f","/",urldecode ($TheVal));


} 





This is effectively a double urlencode for slashes and single urlencode for everything else.  So, it is more "standardised" than his suggestion of using a + sign, and more readable (and search engine indexable) than a full double encode/decode.

neugey at cox dot net
18-Sep-2004 04:51


Be careful when encoding strings that came from simplexml in PHP 5.  If you try to urlencode a simplexml object, the script tanks.



I got around the problem by using a cast.



$newValue = urlencode( (string) $oldValue );

monty3 at hotmail dot com
09-Sep-2004 04:00


If you want to pass a url with parameters as a value IN a url AND through a javascript function, such as...



   <a href="javascript:openWin('page.php?url=index.php?id=4&pg=2');">



...pass the url value through the PHP urlencode() function twice, like this...



<?php



   $url = "index.php?id=4&pg=2";

   $url = urlencode(urlencode($url));



   echo "<a href=\"javascript:openWin('page.php?url=$url');\">";

?>



On the page being opened by the javascript function (page.php), you only need to urldecode() once, because when javascript 'touches' the url that passes through it, it decodes the url once itself. So, just decode it once more in your PHP script to fully undo the double-encoding...



<?php



   $url = urldecode($_GET['url']);

?>



If you don't do this, you'll find that the result url value in the target script is missing all the var=values following the ? question mark...



   index.php?id=4

issue9mm at leafapplication dot com
08-Oct-2002 09:53


Just a simple comment, really, but if you need to encode apostrophes, you should be using rawurlencode as opposed to just urlencode. 



Naturally, I figured that out the hard way.

add a note

Variables

URLs

Last updated: Mon, 26 Nov 2007