HTTP Requests in PHP with cURL with Examples

cURL is a widely used library for making HTTP requests in PHP. It provides an easy way for PHP scripts to interact with web servers and retrieve or send data. In this article, we’ll look at how to use cURL to make various types of HTTP requests and how to handle the response.

Setting Up cURL in PHP Script

Before you can use cURL in your PHP script, you need to make sure that the library is installed and enabled on your server. Most PHP installations come with cURL support enabled by default, but you can check if it’s available before you start.

<?php
if (!function_exists('curl_init')) {
    die('cURL is not installed on your server.');
}

Making a Simple GET Request

To make a simple GET request using cURL, you need to create a cURL handle using curl_init(), set the URL of the resource you want to retrieve using curl_setopt(), and then execute the request using curl_exec().

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

// set the URL of the resource you want to retrieve
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com');

// set the request method to GET
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

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

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

// close the cURL handle
curl_close($ch);

// output the response
echo $response;

Making a POST Request

To make a POST request using cURL, you need to set the request method to POST using curl_setopt() and then pass the data to be posted in the request body.

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

// set the URL of the resource you want to retrieve
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com/api/create_user');

// set the request method to POST
curl_setopt($ch, CURLOPT_POST, true);

// set the data to be posted in the request body
curl_setopt($ch, CURLOPT_POSTFIELDS, [
    'username' => 'johndoe',
    'email' => '[email protected]',
    'password' => 'secret',
]);

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

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

// close the cURL handle
curl_close($ch);

// output the response
echo $response;

Handling the Response

When you make a request using cURL, the response from the server can be retrieved using curl_exec(). You can then check the HTTP status code of the response using curl_getinfo() to determine if the request was successful.

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

// set the URL of the resource you want to retrieve
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com');

// set the request method to GET
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

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

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

// get the HTTP status code of the response
$status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

// close the cURL handle
curl_close($ch);

// check if the request was successful
if ($status_code == 200) {
    // output the response
    echo $response;
} else {
    // output an error message
    echo 'An error occurred: HTTP ' . $status_code;
}

Additional Features of cURL

cURL also supports various other features, such as sending requests over HTTPS, setting custom headers, and enabling cookies. Here are a few examples of how to use these features:

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

// set the URL of the resource you want to retrieve
curl_setopt($ch, CURLOPT_URL, 'https://www.example.com');

// set the request method to GET
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

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

// send the request over HTTPS
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);

// set a custom header
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: abc123',
]);

// enable cookies
curl_setopt($ch, CURLOPT_COOKIEFILE, 'cookies.txt');
curl_setopt($ch, CURLOPT_COOKIEJAR, 'cookies.txt');

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

// close the cURL handle
curl_close($ch);

// output the response
echo $response;

Example of simple PHP Class to handle GET and POST requests using cURL, with optional parameters

You can now use this class to make GET and POST requests using cURL, with the options to include parameters, verify the SSL certificate, and handle errors.

<?php
class cURL
{
    /**
     * Makes a GET request using cURL
     *
     * @param string $url The URL of the resource to retrieve
     * @param array $params Optional parameters to include in the query string
     * @param bool $ssl_verify Whether to verify the SSL certificate of the resource
     * @return mixed The response of the request, or false on failure
     */
    public static function get($url, $params = [], $ssl_verify = true)
    {
        // create a new cURL handle
        $ch = curl_init();

        // add the parameters to the URL
        if (!empty($params)) {
            $url .= '?' . http_build_query($params);
        }

        // set the URL of the resource you want to retrieve
        curl_setopt($ch, CURLOPT_URL, $url);

        // set the request method to GET
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

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

        // verify the SSL certificate if requested
        if ($ssl_verify) {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
        } else {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        }

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

        // get the HTTP status code of the response
        $status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

        // close the cURL handle
        curl_close($ch);

        // check if the request was successful
        if ($status_code == 200) {
            // return the response
            return $response;
        } else {
            // return false on failure
            return false;
        }
    }

    /**
     * Makes a POST request using cURL
     *
     * @param string $url The URL of the resource to retrieve
     * @param array $data The data to include in the request body
     * @param bool $ssl_verify Whether to verify the SSL certificate of the resource
     * @return mixed The response of the request, or false on failure
     */
    public static function post($url, $data = [], $ssl_verify = true)
    {
        // create a new cURL handle
        $ch = curl_init();

        // set the URL of the resource you want to retrieve
        curl_setopt($ch, CURLOPT_URL, $url);

        // set the request method to POST
        curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');

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

        // include the data in the request body
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

        // verify the SSL certificate if requested
        if ($ssl_verify) {
            curl_setopt($ch, COPT_SSL_VERIFYPEER, true);
        } else {
            curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        }

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

        // get the HTTP status code of the response
        $status_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

        // close the cURL handle
        curl_close($ch);

        // check if the request was successful
        if ($status_code == 200) {
            // return the response
            return $response;
        } else {
            // return false on failure
            return false;
        }
    }
}

$response = cURL::get('https://example.com/api/users');
if ($response !== false) {
    // process the response
} else {
    // handle the error
}

$response = cURL::post('https://example.com/api/users', ['username' => 'johndoe', 'password' => 'secret']);
if ($response !== false) {
    // process the response
} else {
    // handle the error
}

Tips and Tricks for using cURL in PHP

Here are some tips and tricks:

  1. Use cURL functions carefully: Make sure to always close the cURL handle when you’re done with it, and check the return values of cURL functions to handle any errors that may occur.
  2. Set the right options: cURL offers a wide range of options that allow you to customize your requests. Make sure to set the options that are relevant to your use case, such as the request method, the URL, the request body, and the SSL certificate verification.
  3. Use HTTP headers: You can include custom HTTP headers in your requests to provide additional information to the server. For example, you can use the CURLOPT_HTTPHEADER option to set the Authorization header to include an access token.
  4. Monitor the progress of the request: You can use the CURLOPT_PROGRESSFUNCTION option to set a callback function that will be called during the request to monitor its progress. This can be useful for tracking the download progress of a file, for example.
  5. Debug cURL requests: If you’re having trouble with a cURL request, you can use the CURLOPT_VERBOSE option to turn on verbose output and see what’s going on behind the scenes.
  6. Follow redirects automatically: If you’re making a request to a URL that returns a redirect, you can use the CURLOPT_FOLLOWLOCATION option to follow the redirect automatically.
  7. Set a timeout: To avoid long wait times, you can use the CURLOPT_TIMEOUT option to set a timeout for the request. This will make cURL stop the request if it takes longer than the specified timeout.
  8. Send custom request types: You can use the CURLOPT_CUSTOMREQUEST option to send custom request types, such as PATCH or DELETE.
  9. Use an HTTP proxy: If you need to make requests through an HTTP proxy, you can use the CURLOPT_PROXY and CURLOPT_PROXYPORT options to specify the proxy server and port.

These tips and tricks can help you use cURL in PHP more effectively. By keeping these in mind, you can make sure your cURL requests are fast, reliable, and efficient.

Example of using cURL in PHP with cookies and session persistence

<?php

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

// set the URL to fetch
curl_setopt($ch, CURLOPT_URL, 'https://example.com/login');

// set the request method to POST
curl_setopt($ch, CURLOPT_POST, 1);

// set the request body
curl_setopt($ch, CURLOPT_POSTFIELDS, [
    'username' => 'johndoe',
    'password' => 'secret'
]);

// set the cookie jar file
curl_setopt($ch, CURLOPT_COOKIEJAR, 'cookies.txt');

// save the cookies from the response to the cookie jar
curl_setopt($ch, CURLOPT_COOKIEFILE, 'cookies.txt');

// return the response as a string
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// follow redirects
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);

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

// close the cURL handle
curl_close($ch);

// process the response

// ...

// create a new cURL resource for the next request
$ch = curl_init();

// set the URL to fetch
curl_setopt($ch, CURLOPT_URL, 'https://example.com/api/users');

// set the cookie jar file
curl_setopt($ch, CURLOPT_COOKIEJAR, 'cookies.txt');

// send the cookies from the cookie jar with the request
curl_setopt($ch, CURLOPT_COOKIEFILE, 'cookies.txt');

// return the response as a string
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

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

// close the cURL handle
curl_close($ch);

// process the response

// ...

In this example, we first make a POST request to the login page to log in, and then we make another request to the API to retrieve the list of users. To maintain session persistence, we use the CURLOPT_COOKIEJAR and CURLOPT_COOKIEFILE options to save and send the cookies from the response to the next request. This way, we can keep the session alive across multiple requests.

So, cURL is a versatile library that makes it easy to send and receive data over HTTP in PHP. Whether you’re making simple GET requests or complex POST requests with custom headers, cURL provides a simple and flexible API that can handle it all. With a little bit of knowledge, you can streamline your PHP workflow and interact with web servers like a pro.

Posted

in

by

Dev

Tags:

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *