Using curl_setopt() in PHP cURL: Syntax, Parameters, Return Value, Example, and Explanation

Syntax

The curl_setopt() function configures options for a cURL session in PHP.

bool curl_setopt ( resource $ch , int $option , mixed $value )

Parameter Explanation

$ch: the cURL handle created by curl_init() .

$option: the specific cURL option to set.

$value: the value for the chosen option.

Return Value

The function returns a boolean indicating whether the option was set successfully.

Example

The following code shows how to use curl_setopt() to send a GET request to a URL and retrieve the response.

// Initialize cURL session
$ch = curl_init();

// Set the target URL
curl_setopt($ch, CURLOPT_URL, "https://api.example.com/data");

// Set request method to GET
curl_setopt($ch, CURLOPT_HTTPGET, true);

// Return response as a string instead of outputting directly
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Set timeout (seconds)
curl_setopt($ch, CURLOPT_TIMEOUT, 30);

// Execute the request
$response = curl_exec($ch);

// Check for failure
if ($response === FALSE) {
    echo "Request failed: " . curl_error($ch);
} else {
    // Process response data
    echo $response;
}

// Close the cURL session
curl_close($ch);

Explanation

The script first creates a cURL handle with curl_init(), then sets several options using curl_setopt(): the URL to request, the HTTP method (GET), enabling the return of the response as a string, and a timeout of 30 seconds.

After configuring the options, curl_exec() executes the request. If the request fails, curl_error() provides the error message; otherwise, the response data can be processed. Finally, curl_close() releases the cURL handle.

Summary

The curl_setopt() function is essential for configuring a cURL session in PHP, allowing developers to set options such as URL, request method, timeout, and more, enabling flexible HTTP request handling within PHP code.