<!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>Set multiple options for a cURL transfer</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.curl-reset.html">curl_reset</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.curl-setopt.html">curl_setopt</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-setopt-array" class="refentry"> <div class="refnamediv"> <h1 class="refname">curl_setopt_array</h1> <p class="verinfo">(PHP 5 >= 5.1.3)</p><p class="refpurpose"><span class="refname">curl_setopt_array</span> — <span class="dc-title">Set multiple options for a cURL transfer</span></p> </div> <div class="refsect1 description" id="refsect1-function.curl-setopt-array-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>curl_setopt_array</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$ch</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span> )</div> <p class="para rdfs-comment"> Sets multiple options for a cURL session. This function is useful for setting a large amount of cURL options without repetitively calling <span class="function"><a href="function.curl-setopt.html" class="function">curl_setopt()</a></span>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.curl-setopt-array-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <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">options</code></em></span> <dd> <p class="para"> An <span class="type"><a href="language.types.array.html" class="type array">array</a></span> specifying which options to set and their values. The keys should be valid <span class="function"><a href="function.curl-setopt.html" class="function">curl_setopt()</a></span> constants or their integer equivalents. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.curl-setopt-array-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> if all options were successfully set. If an option could not be successfully set, <strong><code>FALSE</code></strong> is immediately returned, ignoring any future options in the <em><code class="parameter">options</code></em> array. </p> </div> <div class="refsect1 examples" id="refsect1-function.curl-setopt-array-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4223"> <p><strong>Example #1 Initializing a new cURL session and fetching a web page </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 new cURL resource<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">// set URL and other appropriate options<br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= array(</span><span style="color: #0000BB">CURLOPT_URL </span><span style="color: #007700">=> </span><span style="color: #DD0000">'http://www.example.com/'</span><span style="color: #007700">,<br /> </span><span style="color: #0000BB">CURLOPT_HEADER </span><span style="color: #007700">=> </span><span style="color: #0000BB">false<br /> </span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">curl_setopt_array</span><span style="color: #007700">(</span><span style="color: #0000BB">$ch</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// grab URL and pass it to the browser<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 /><br /></span><span style="color: #FF8000">// close cURL resource, and free up system resources<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> <p class="para"> Prior to PHP 5.1.3 this function can be simulated with: </p> <p class="para"> <div class="example" id="example-4224"> <p><strong>Example #2 Our own implementation of <span class="function"><strong>curl_setopt_array()</strong></span></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">if (!</span><span style="color: #0000BB">function_exists</span><span style="color: #007700">(</span><span style="color: #DD0000">'curl_setopt_array'</span><span style="color: #007700">)) {<br /> function </span><span style="color: #0000BB">curl_setopt_array</span><span style="color: #007700">(&</span><span style="color: #0000BB">$ch</span><span style="color: #007700">, </span><span style="color: #0000BB">$curl_options</span><span style="color: #007700">)<br /> {<br /> foreach (</span><span style="color: #0000BB">$curl_options </span><span style="color: #007700">as </span><span style="color: #0000BB">$option </span><span style="color: #007700">=> </span><span style="color: #0000BB">$value</span><span style="color: #007700">) {<br /> if (!</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">$option</span><span style="color: #007700">, </span><span style="color: #0000BB">$value</span><span style="color: #007700">)) {<br /> return </span><span style="color: #0000BB">false</span><span style="color: #007700">;<br /> } <br /> }<br /> return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br /> }<br />}<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 notes" id="refsect1-function.curl-setopt-array-notes"> <h3 class="title">Notes</h3> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> As with <span class="function"><a href="function.curl-setopt.html" class="function">curl_setopt()</a></span>, passing an array to <strong><code>CURLOPT_POST</code></strong> will encode the data as <em class="emphasis">multipart/form-data</em>, while passing a URL-encoded string will encode the data as <em class="emphasis">application/x-www-form-urlencoded</em>. </p> </p></blockquote> </div> <div class="refsect1 seealso" id="refsect1-function.curl-setopt-array-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.curl-setopt.html" class="function" rel="rdfs-seeAlso">curl_setopt()</a> - Set an option for a cURL transfer</span></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-reset.html">curl_reset</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.curl-setopt.html">curl_setopt</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>