curl_setopt_array

(PHP 5 >= 5.1.3, PHP 7)

curl_setopt_array — Set multiple options for a cURL transfer

Description

bool curl_setopt_array ( resource $ch , array $options )

Sets multiple options for a cURL session. This function is useful for setting a large amount of cURL options without repetitively calling curl_setopt().

Parameters

ch: A cURL handle returned by curl_init().
options: An array specifying which options to set and their values. The keys should be valid curl_setopt() constants or their integer equivalents.

Return Values

Returns TRUE if all options were successfully set. If an option could not be successfully set, FALSE is immediately returned, ignoring any future options in the options array.

Examples

Example #1 Initializing a new cURL session and fetching a web page


<?php
// create a new cURL resource
$ch = curl_init();

// set URL and other appropriate options
$options = array(CURLOPT_URL => 'http://www.example.com/',
                 CURLOPT_HEADER => false
                );

curl_setopt_array($ch, $options);

// grab URL and pass it to the browser
curl_exec($ch);

// close cURL resource, and free up system resources
curl_close($ch);
?>

Prior to PHP 5.1.3 this function can be simulated with:

Example #2 Our own implementation of curl_setopt_array()


<?php
if (!function_exists('curl_setopt_array')) {
   function curl_setopt_array(&$ch, $curl_options)
   {
       foreach ($curl_options as $option => $value) {
           if (!curl_setopt($ch, $option, $value)) {
               return false;
           } 
       }
       return true;
   }
}
?>

Notes

Note:
As with curl_setopt(), passing an array to CURLOPT_POST will encode the data as multipart/form-data, while passing a URL-encoded string will encode the data as application/x-www-form-urlencoded.

User Contributed Notes

maran dot emil at gmail dot com

7 years ago


In case that you need to read SSL page content from https with curl, this function can help you:



<?php



function get_web_page( $url,$curl_data )

{

    $options = array(

        CURLOPT_RETURNTRANSFER => true,         // return web page

        CURLOPT_HEADER         => false,        // don't return headers

        CURLOPT_FOLLOWLOCATION => true,         // follow redirects

        CURLOPT_ENCODING       => "",           // handle all encodings

        CURLOPT_USERAGENT      => "spider",     // who am i

        CURLOPT_AUTOREFERER    => true,         // set referer on redirect

        CURLOPT_CONNECTTIMEOUT => 120,          // timeout on connect

        CURLOPT_TIMEOUT        => 120,          // timeout on response

        CURLOPT_MAXREDIRS      => 10,           // stop after 10 redirects

        CURLOPT_POST            => 1,            // i am sending post data

           CURLOPT_POSTFIELDS     => $curl_data,    // this are my post vars

        CURLOPT_SSL_VERIFYHOST => 0,            // don't verify ssl

        CURLOPT_SSL_VERIFYPEER => false,        //

        CURLOPT_VERBOSE        => 1                //

    );



    $ch      = curl_init($url);

    curl_setopt_array($ch,$options);

    $content = curl_exec($ch);

    $err     = curl_errno($ch);

    $errmsg  = curl_error($ch) ;

    $header  = curl_getinfo($ch);

    curl_close($ch);



  //  $header['errno']   = $err;

  //  $header['errmsg']  = $errmsg;

  //  $header['content'] = $content;

    return $header;

}



$curl_data = "var1=60&var2=test";

$url = "https://www.example.com";

$response = get_web_page($url,$curl_data);



print '<pre>';

print_r($response);



?>

anthon at piwik dot org

5 years ago


Starting in PHP 5.2.0, CURLOPT_FOLLOWLOCATION can't be set via curl_setopt_array() (or curl_setopt()) when either safe_mode is enabled or open_basedir is set.  In these cases, the order of CURLOPT_* settings in the array can be important.

bendavis78 at gmail dot com

9 years ago


You can use CURLOPT_HEADERFUNCTION  with a callback inside an object.  This makes is it easy to capture the headers for later use.  For example:



<?php

class Test

{

    public $headers;



    //...



    public function exec($opts)

    {

        $this->headers = array();

        $opts[CURLOPT_HEADERFUNCTION] = array($this, '_setHeader');

        $ch = curl_init();

        curl_setopt_array($ch, $opts);

        return curl_exec($ch);

    }



    private function _setHeader($ch, $header)

    {

        $this->headers[] = $header;

        return strlen($header);

    }



    

}



$test = new Test();

$opts = array(

   //... your curl opts here

);

$data = $test->exec($opts);

print_r($test->headers);

?>



...something like that



(This works in php v. 5.1.4)

Lionel

7 months ago


If you are writing a mini API for your library, and if you are doing merging of options, remember to use the union operator (+) !

So something like this will definitely fail. This is because array_merge effectively resets all the keys in the array into running numbers:

<?php
function post($url, $options = array) {
    $ch = curl_init();
    curl_setopt_array($ch, array_merge(array(
        CURLOPT_HEADER => 1,
        CURLOPT_RETURNTRANSFER => 1,
        .....
     )));
?>

Rather, this is the correct way of doing it:

<?php
function post($url, $options = array) {
    $ch = curl_init();
    curl_setopt_array($ch, array(
        CURLOPT_HEADER => 1,
        CURLOPT_RETURNTRANSFER => 1,
        .....
     ) + (array) $options);
?>

loop4u at gmail dot com

4 years ago


it should be noted that when using CURLOPT_POSTFIELDS in a loop, CURLOPT_POSTFIELDS appends to the sting. You can use unset() if you don't want this sort of behavior.



<?php

//this will append postfields



while(true) {

    $options = array(CURLOPT_POSTFIELDS => 'foo=bar&foo2=bar');

    $ch = curl_init("http://www.example.com");

    curl_setopt_array($ch, $options);

    curl_exec($ch);

    curl_close($ch);

}



//this will NOT append postfields

while(true) {

    $options = array(CURLOPT_POSTFIELDS => 'foo=bar&foo2=bar');

    $ch = curl_init("http://www.example.com");

    curl_setopt_array($ch, $options);

    curl_exec($ch);

    curl_close($ch);

    unset($options[CURLOPT_POSTFIELDS]);

}

?>

fnjordy at gmail dot com