Last updated: Nov-14-2022
This page provides an in-depth introduction to the PHP SDK.
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.
You may also find our Glossary helpful to understand Cloudinary-specific terminology.
- 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=>analyticsconfiguration option. Learn more.
Take a look at the following transformation code and the image it delivers:
(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));
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.
The following PHP code uploads the
dog.mp4 video to the specified 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.
(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']);
- Build URLs for image and video transformations
- 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
When using the PHP SDK, keep these guidelines in mind:
- Properties names:
camelCase. For example: publicId
PascalCase. For example: ImageTag
- Pass parameter data as:
Composer to manage your PHP library dependency, and install Cloudinary's PHP library directly from the Packagist repository.
composer.jsonfile as follows:
Automatically install dependencies including Cloudinary's PHP package:
(If you dont have the necessary permissions you can run the file itself:
php composer.phar install)
require_once __DIR__ . '/vendor/autoload.php';
To use the Cloudinary PHP library, you have to configure at least your
api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads). You can find your product environment configuration credentials in the Dashboard page of the Cloudinary Console.
In addition to the required configuration parameters, you can define a number of optional configuration parameters if relevant.
Setting the configuration parameters can be done globally, using either an environment variable or the
Configuration::instance method, or programmatically in each call to a Cloudinary method. Parameters set in a call to a Cloudinary method override globally set parameters.
You can configure the required
api_secret by defining the CLOUDINARY_URL environment variable. The CLOUDINARY_URL value is available in the Dashboard page of the Cloudinary Console. When using Cloudinary through a PaaS add-on (e.g., Heroku or AppFog), this environment variable is automatically defined in your deployment environment. For example:
Set additional parameters, for example upload_prefix and cname, to the environment variable:
Here's an example of setting configuration parameters globally in your PHP application using an instance of the
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;
If you require multiple instances, you can use the
Cloudinary object to configure each instance, for example:
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:
$cloudinary = new Cloudinary('cloudinary://my_key:my_secret@my_cloud_name?url[secure]=true&url[cname]=my_site.com')
- Learn more about uploading images and videos using the PHP SDK.
- See examples of powerful image and video transformations using PHP code
and see our image transformations and video transformation docs.
- Check out Cloudinary's asset administration capabilities, for example, renaming and deleting assets, adding tags and metadata to assets, and searching for assets.
- See the PHP SDK Migration guide for more information on migrating to version 2 of the PHP SDK.
- Stay tuned for updates, tips and tutorials in Product Updates and Blog Posts.