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

cURL is a powerful PHP extension for sending and receiving HTTP requests in code. When using cURL, various options can be set to configure request behavior and parameters. The curl_setopt() function is a crucial part of cURL; it sets options for a cURL session.

Syntax

The following is the syntax of the curl_setopt() function:

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

Parameter Explanation:

$ch : cURL handle created by curl_init() .

$option : the cURL option to set.

$value : the value for the option.

Return Value

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

Example

Below is an example that uses curl_setopt() to send a GET request to a specified URL and retrieve the response:

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

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

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

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

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

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

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

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

Explanation

In the example, we first create a cURL handle ($ch) with curl_init() . Then we use curl_setopt() to configure several options: CURLOPT_URL sets the target URL, CURLOPT_HTTPGET sets the request method to GET, CURLOPT_RETURNTRANSFER tells cURL to return the response as a string, and CURLOPT_TIMEOUT sets a 30‑second timeout.

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

Summary

The curl_setopt() function is a vital part of the PHP cURL extension, allowing developers to configure a cURL session with options such as URL, request method, timeout, and more. By using curl_setopt() flexibly, HTTP requests can be sent and received easily within PHP code.