On the 1st of March 2022, this legacy SDK will reach its end of life. From that date onward, we will no longer release new features for this version of the SDK. Support will still be available until further notice.
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.
The library is based on generic code that can be used with PHP frameworks such as
Symfony and others.
Take a look at the following transformation code and the image it delivers:
cl_image_tag("front_face.png", array("secure"=>true, "transformation"=>array( array("width"=>150, "height"=>150, "gravity"=>"face", "crop"=>"thumb"), array("radius"=>20), array("effect"=>"sepia"), array("overlay"=>"cloudinary_icon_blue", "gravity"=>"south_east", "x"=>5, "y"=>5, "width"=>50, "opacity"=>60, "effect"=>"brightness:200"), array("angle"=>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 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.
\Cloudinary\Uploader::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
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:
Although Composer is the recommended method for installing the PHP library, if necessary you can also manually install the library as follows:
- Download the latest sources from:https://github.com/cloudinary/cloudinary_php/archive/support/1.x.zip.
srcfolder and the
autoload.phpfile into your PHP project and then include Cloudinary's PHP classes in your code:
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 account-specific configuration credentials in the Dashboard page of the account 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
config method, or programmatically in each call to a Cloudinary method. Parameters set in a call to a Cloudinary method override globally set parameters.
secureconfiguration parameter is
false. However, for most modern applications, it's recommended to configure the
trueto ensure that your transformation URLs are always generated as HTTPS.
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 account 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:
\Cloudinary::config([ "cloud_name" => "my_cloud_name", "api_key" => "my_key", "api_secret" => "my_secret", "secure" => true]);
When using the PHP SDK, keep these guidelines in mind:
- Parameter names:
snake_case. For example: public_id
PascalCase. For example: CloudinaryField
snake_case. For example: cl_image_upload_tag
- Pass parameter data as:
For additional useful code samples and to learn how to integrate Cloudinary with your PHP applications, take a look at our Sample Projects.
- Basic PHP sample: Uploading local and remote images to Cloudinary and generating various transformation URLs.
- PHP Photo Album: A fully working web application that allows you to upload photos, maintain a database with references, list images with their metadata, and display them using various cloud-based transformations. Image uploading is performed both from the server side and directly from the browser using a jQuery plugin.
- 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.
- Stay tuned for updates, tips and tutorials in Product Updates and Blog Posts.