PHP cURL curl_multi_setopt() Function

---

---

The PHP Client URL curl_multi_setopt() function is used to set an option on the given cURL multi handle. Options include things like setting timeouts, utilizing callbacks to manage responses, and defining error handling.

Syntax

Below is the syntax of the PHP cURL curl_multi_setopt() function −

bool curl_multi_setopt ( resource $mh, int $option, mixed $value )

Parameters

Following are the parameters required for the curl_multi_exec() function −

• $mh − It is the handle returned by curl_multi_init() function.

• $option − It is one of the CURLMOPT_* constants.

• $value − It is the value to be set on option.

Return Value

The curl_multi_setopt() function returns TRUE on success or FALSE on failure.

PHP Version

This function was introduced in core PHP 5.5.0 and is compatible with PHP 7, and PHP 8.

Example 1

Here is the basic example of how to use the PHP cURL curl_multi_setopt() function to set a timeout of 10 seconds for all the cURL handles inside the multi-handle.

<?php
   // Start a cURL multi handle
   $mh = curl_multi_init();
   
   curl_multi_setopt($mh, CURLOPT_TIMEOUT, 10);

   // Echo message
   echo "Timeout of 10 seconds has been set.";
?> 

Output

The above code will result something like this −

Timeout of 10 seconds has been set.

Example 2

In the below PHP code we will use the curl_multi_setopt() function with CURLOPT_MAXCONNECTS option to limit the maximum number of simultaneous connections.

<?php
   // Start a cURL multi handle
   $mh = curl_multi_init();
   curl_multi_setopt($mh, CURLOPT_MAXCONNECTS, 5);

   // Echo message
   echo "Simultaneous connections is set to 5.";
?> 

Output

This will generate the below output −

Simultaneous connections is set to 5.

Example 3

Now we will use the curl_multi_setopt() function with the CURLOPT_USERAGENT option to set the User-Agent header for all requests.

<?php
   // Start the cURL handles 
   $mh = curl_multi_init();
   curl_multi_setopt($mh, CURLOPT_USERAGENT, 'Mozilla/5.0 (Windows NT 10.0; Win64; x64)'); 
   
   // Echo message
   echo "Header has been set for all requests.";
?> 

Output

This will create the below output −

Header has been set for all requests.

Example 4

Now we will use the curl_multi_setopt() function with the CURLOPT_PROXY and CURLOPT_PROXYUSERPWD options to configure a HTTP proxy with authentication.

<?php
   // Start the cURL handles 
   $mh = curl_multi_init();
   curl_multi_setopt($mh, CURLOPT_PROXY, 'http://proxy.abc.com:8080');
   curl_multi_setopt($mh, CURLOPT_PROXYUSERPWD, 'username:password');

   // Echo message
   echo "Authentication is configured for HTTP proxy.";
?> 

Output

Following is the output of the above code −

Authentication is configured for HTTP proxy.

Summary

The curl_multi_setopt() is a built-in function which can be used to customize various aspects of a multi-handle cURL session in PHP.