PHP SDK

Overview

Cloudinary's PHP SDK provides simple, yet comprehensive image and video upload, transformation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing PHP application.

Tip
In this guide you'll learn how to get started with the PHP SDK, but if you are not familiar with Cloudinary, we advise reading How to integrate Cloudinary first for a high-level overview of integrating Cloudinary into your code, and an introduction to the main concepts.

Related topics
This guide relates to the current release of the Cloudinary PHP SDK v2.x.

  • For information on the previous major release of the PHP SDK, see the PHP SDK 1.x documentation. See the PHP SDK Migration guide for more information on migrating from version 1.x to version 2.x of the PHP SDK.
  • For details on all new features and fixes from previous releases of version 2.x, see the CHANGELOG.
  • By default, URLs generated with this SDK include an appended SDK-usage query parameter. Cloudinary tracks aggregated data from this parameter to improve future SDK versions and no individual data is collected. If needed, you can disable the url=>analytics configuration option. Learn more.

Quick example: Transformations

Take a look at the following transformation code and the image it delivers:

PHP:
Copy to clipboard
(new ImageTag('front_face.png'))
  ->resize(Resize::thumbnail()->width(150)->height(150)->gravity(Gravity::focusOn(FocusOn::face())))
  ->roundCorners(RoundCorners::byRadius(20))
  ->effect(Effect::sepia())
  ->overlay(
      Overlay::source(Source::image('cloudinary_icon_blue')
        ->transformation((new ImageTransformation())
          ->adjust(Adjust::brightness()->level(100))
          ->adjust(Adjust::opacity(60))
          ->resize(Resize::scale()->width(50))))
      ->position((new Position())
        ->gravity(Gravity::compass(Compass::southEast()))
        ->offsetX(5)->offsetY(5)))
    ->rotate(Rotate::byAngle(10));
sample transformation

This relatively simple code performs all of the following on the original front_face.jpg image before delivering it:

  • Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
  • Round the corners with a 20 pixel radius
  • Apply a sepia effect
  • Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%)
  • Rotate the resulting image (including the overlay) by 10 degrees
  • Convert and deliver the image in PNG format (the originally uploaded image was a JPG)

And here's the URL that would be included in the image tag that's automatically generated from the above code:

In a similar way, you can transform a video.

Quick example: File upload

The following PHP code uploads the dog.mp4 video to the specified account sub-folder using the public_id, my_dog. The video will overwrite the existing my_dog video if it exists. When the video upload is complete, the specified notification URL will receive details about the uploaded media asset.

Copy to clipboard
(new UploadApi())->upload('dog.mp4', [
  'folder' => 'myfolder/mysubfolder/', 
  'public_id' => 'my_dog', 
  'overwrite' => true, 
  'notification_url' => 'https://mysite.example.com/notify_endpoint', 
  'resource_type' => 'video']);

PHP library features

  • Build URLs for image and video manipulations
  • PHP view helper tags for embedding and transforming images
  • API wrappers: file upload, administration, sprite generation and more
  • Server-side file upload + direct unsigned file upload from the browser using the jQuery plugin

PHP capitalization and data type guidelines

When using the PHP SDK, keep these guidelines in mind:

  • Properties names: camelCase. For example: publicId
  • Classes: PascalCase. For example: ImageTag
  • Pass parameter data as: array

Installation

Composer installation

Use Composer to manage your PHP library dependency, and install Cloudinary's PHP library directly from the Packagist repository.

  1. Update your composer.json file as follows:

    Copy to clipboard
    {
      "require": {
        "cloudinary/cloudinary_php": "^2"
      }
    }
  2. Automatically install dependencies including Cloudinary's PHP package:

    Copy to clipboard
    php composer.phar install

Configuration

To use the Cloudinary PHP library, you have to configure at least your cloud_name. Your api_key and api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads). You can find your account-specific configuration credentials in the Dashboard page of the account console.

Setting the configuration parameters can be done either programmatically in each call to a Cloudinary method or you can set them globally using either an environment variable or the Configuration::instance method. You can optionally configure the required cloud_name, api_key, and api_secret by defining the CLOUDINARY_URL environment variable. The configuration URL is available in the Dashboard page of the account console. When using Cloudinary through a PaaS add-on (e.g., AppFog), this environment variable is automatically defined in your deployment environment. For example:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name?

In addition to the required parameters, you can define a number of optional configuration parameters if relevant.

Here's an example of setting configuration parameters globally in your PHP application using an instance of the Configuration class:

Copy to clipboard
use Cloudinary\Configuration\Configuration;

// configure globally via a JSON object


Configuration::instance([
  'cloud' => [
    'cloud_name' => 'my_cloud_name', 
    'api_key' => 'my_key', 
    'api_secret' => 'my_secret'],
  'url' => [
    'secure' => true]]);


//  Or configure programatically

$config = Configuration::instance();
$config->cloud->cloudName = 'my_cloud_name';
$config->cloud->apiKey = 'my_key';
$config->cloud->apiSecret = 'my_secret';
$config->url->secure = true;

You can also configure the parameters via the environment variable, for example:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name?url[secure]=true&account[cname]=my_site.com

If you require multiple instances, you can use the Cloudinary object to configure each instance, for example:

Copy to clipboard
use Cloudinary\Configuration\Configuration;

// configure an instance via a JSON object

$cloudinary = new Cloudinary([
  'cloud' => [
    'cloud_name' => 'my_cloud_name',
    'api_key'  => 'my_key',
    'api_secret' => 'my_secret',
  'url' => [
    'secure' => true]]]);


//  Or configure programatically

$config = new Configuration();
$config->cloud->cloudName = 'my_cloud_name';
$config->cloud->apiKey = 'my_key';
$config->cloud->apiSecret = 'my_secret';
$config->url->secure = true;
$cloudinary = new Cloudinary($config);

You can also configure parameters for an instance via environment variable, for example:

Copy to clipboard
$cloudinary = new Cloudinary('cloudinary://my_key:my_secret@my_cloud_name?url[secure]=true&url[cname]=my_site.com')

Related topics

✔️ Feedback sent!

Rate this page: