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

cURL is a powerful PHP extension for sending and receiving HTTP requests. The curl_setopt() function is essential for configuring a cURL session by setting various options.

Syntax

The syntax of the curl_setopt() function is:

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 option.

Return Value

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

Example

The following example demonstrates using 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 request
$response = curl_exec($ch);

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

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

Explanation

First, curl_init() creates a cURL handle ($ch). Then curl_setopt() is used 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. CURLOPT_TIMEOUT defines a 30‑second timeout.

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

Summary

The curl_setopt() function is a crucial 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 it flexibly, HTTP requests can be sent and received easily within PHP code.