<!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 encodes the given string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.curl-error.html">curl_error</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.curl-exec.html">curl_exec</a></div>
<div class="up"><a href="ref.curl.html">cURL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.curl-escape" class="refentry">
<div class="refnamediv">
<h1 class="refname">curl_escape</h1>
<p class="verinfo">(PHP 5 >= 5.5.0)</p><p class="refpurpose"><span class="refname">curl_escape</span> — <span class="dc-title">URL encodes the given string</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.curl-escape-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>curl_escape</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ch</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$str</code></span>
)</div>
<p class="para rdfs-comment">
This function URL 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.curl-escape-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">ch</code></em>
</span><dd>
<p class="para">A cURL handle returned by
<span class="function"><a href="function.curl-init.html" class="function">curl_init()</a></span>.</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">str</code></em></span>
<dd>
<p class="para">
The string to be encoded.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.curl-escape-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns escaped string or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.curl-escape-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4212">
<p><strong>Example #1 <span class="function"><strong>curl_escape()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Create a curl handle<br /></span><span style="color: #0000BB">$ch </span><span style="color: #007700">= </span><span style="color: #0000BB">curl_init</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">// Escape a string used as a GET parameter<br /></span><span style="color: #0000BB">$location </span><span style="color: #007700">= </span><span style="color: #0000BB">curl_escape</span><span style="color: #007700">(</span><span style="color: #0000BB">$ch</span><span style="color: #007700">, </span><span style="color: #DD0000">'Hofbräuhaus / München'</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">// Result: Hofbr%C3%A4uhaus%20%2F%20M%C3%BCnchen<br /><br />// Compose an URL with the escaped string<br /></span><span style="color: #0000BB">$url </span><span style="color: #007700">= </span><span style="color: #DD0000">"http://example.com/add_location.php?location=</span><span style="color: #007700">{</span><span style="color: #0000BB">$location</span><span style="color: #007700">}</span><span style="color: #DD0000">"</span><span style="color: #007700">;<br /></span><span style="color: #FF8000">// Result: http://example.com/add_location.php?location=Hofbr%C3%A4uhaus%20%2F%20M%C3%BCnchen<br /><br />// Send HTTP request and close the handle<br /></span><span style="color: #0000BB">curl_setopt</span><span style="color: #007700">(</span><span style="color: #0000BB">$ch</span><span style="color: #007700">, </span><span style="color: #0000BB">CURLOPT_URL</span><span style="color: #007700">, </span><span style="color: #0000BB">$url</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">curl_setopt</span><span style="color: #007700">(</span><span style="color: #0000BB">$ch</span><span style="color: #007700">, </span><span style="color: #0000BB">CURLOPT_RETURNTRANSFER</span><span style="color: #007700">, </span><span style="color: #0000BB">true</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">curl_exec</span><span style="color: #007700">(</span><span style="color: #0000BB">$ch</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">curl_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$ch</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.curl-escape-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.curl-unescape.html" class="function" rel="rdfs-seeAlso">curl_unescape()</a> - Decodes the given 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"> <span class="function"><a href="function.rawurlencode.html" class="function" rel="rdfs-seeAlso">rawurlencode()</a> - URL-encode according to RFC 3986</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.curl-error.html">curl_error</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.curl-exec.html">curl_exec</a></div>
<div class="up"><a href="ref.curl.html">cURL Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
