<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>URL-encode according to RFC 3986</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.rawurldecode.html">rawurldecode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.urldecode.html">urldecode</a></div>
<div class="up"><a href="ref.url.html">URL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.rawurlencode" class="refentry">
<div class="refnamediv">
<h1 class="refname">rawurlencode</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">rawurlencode</span> — <span class="dc-title">URL-encode according to RFC 3986</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.rawurlencode-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>rawurlencode</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
)</div>
<p class="para rdfs-comment">
Encodes the given string according to <a href="http://www.faqs.org/rfcs/rfc3986" class="link external">» RFC 3986</a>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.rawurlencode-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">str</code></em></span>
<dd>
<p class="para">
The URL to be encoded.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.rawurlencode-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a string in which all non-alphanumeric characters except
<em>-_.~</em> have been replaced with a percent
(<em>%</em>) sign followed by two hex digits. This is the
encoding described in <a href="http://www.faqs.org/rfcs/rfc3986" class="link external">» RFC 3986</a> for
protecting literal characters from being interpreted as special URL
delimiters, and for protecting URLs from being mangled by transmission
media with character conversions (like some email systems).
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Prior to PHP 5.3.0, rawurlencode encoded tildes (<em>~</em>) as per
<a href="http://www.faqs.org/rfcs/rfc1738" class="link external">» RFC 1738</a>.
</p>
</p></blockquote>
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.rawurlencode-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>5.3.4</td>
<td>
Tilde characters are no longer encoded when
<span class="function"><strong>rawurlencode()</strong></span> is used with EBCDIC strings.
</td>
</tr>
<tr>
<td>5.3.0</td>
<td>
Now conforms to <a href="http://www.faqs.org/rfcs/rfc3986" class="link external">» RFC 3986</a>.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.rawurlencode-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4092">
<p><strong>Example #1 including a password in an FTP URL</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<a href="ftp://user:'</span><span style="color: #007700">, </span><span style="color: #0000BB">rawurlencode</span><span style="color: #007700">(</span><span style="color: #DD0000">'foo @+%/'</span><span style="color: #007700">),<br /> </span><span style="color: #DD0000">'@ftp.example.com/x.txt">'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
<a href="ftp://user:foo%20%40%2B%25%2F@ftp.example.com/x.txt">
</pre></div>
</div>
</div>
</p>
<p class="para">
Or, if you pass information in a PATH_INFO component of the URL:
</p>
<p class="para">
<div class="example" id="example-4093">
<p><strong>Example #2 <span class="function"><strong>rawurlencode()</strong></span> example 2</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'<a href="http://example.com/department_list_script/'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">rawurlencode</span><span style="color: #007700">(</span><span style="color: #DD0000">'sales and marketing/Miami'</span><span style="color: #007700">), </span><span style="color: #DD0000">'">'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
<a href="http://example.com/department_list_script/sales%20and%20marketing%2FMiami">
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.rawurlencode-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.rawurldecode.html" class="function" rel="rdfs-seeAlso">rawurldecode()</a> - Decode URL-encoded strings</span></li>
<li class="member"> <span class="function"><a href="function.urldecode.html" class="function" rel="rdfs-seeAlso">urldecode()</a> - Decodes URL-encoded string</span></li>
<li class="member"> <span class="function"><a href="function.urlencode.html" class="function" rel="rdfs-seeAlso">urlencode()</a> - URL-encodes string</span></li>
<li class="member"><a href="http://www.faqs.org/rfcs/rfc3986" class="link external">» RFC 3986</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.rawurldecode.html">rawurldecode</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.urldecode.html">urldecode</a></div>
<div class="up"><a href="ref.url.html">URL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
