PHP quick start

This quick start is intended to let you quickly try using several common Cloudinary features. It doesn't necessarily employ coding best practices and the code you create here isn't intended for production.

You can perform this quick start in a code sandbox or in a clean project in the dev environment of your choice.

You can also view the completed code of this quick start in a GitHub repo.

Prerequisites

To perform this quick start, you'll need:

• A Cloudinary account. If you don't have one yet, you can quickly register for free.
• Your product environment credentials. You can find your credentials in the Dashboard page of your Cloudinary Console.
• A working PHP development environment with a supported version of PHP.

1. Set up and configure the SDK

Install the SDK

Use Composer to manage your PHP library dependency, and install Cloudinary's PHP library.

1. Update your composer.json file as follows:

   composer.json

2. Automatically install dependencies, including Cloudinary's PHP package, by running the following command in the root folder of your project:

Configure Cloudinary

Within a new file based on an empty HTML template called 'php_quickstart', use your API environment variable to configure your credentials (replace cloudinary://my_key:my_secret@my_cloud_name below with your environment variable value):

2. Upload an image

Use the upload method of the UploadApi class to upload assets to Cloudinary. The code is encased in HTML to format and display the response:

3. Get info about the image

Use the asset method of the AdminApi class to return the details of our uploaded asset. The code is encased in HTML to format and display the response:

4. Transform and deliver the image

Use the imageTag method to generate the full image URL based on the specified transformation parameters and add the image tag to your HTML code:

5. Run your code

Run your php_quickstart.php file and take a look at the output you get from each step of this quick start.

View the completed code

The sample code for this quick start can be forked from GitHub.

Next steps

• Learn more about the PHP SDK by visiting the other pages in this SDK guide.
• Get comprehensive details about Cloudinary features and capabilities:
  • Media upload guide: Provides details and examples of the upload options.
  • Image transformations guide: Provides details and examples of the transformations you can apply to image assets.
  • Video transformations guide: Provides details and examples of the transformations you can apply to video assets.
  • Transformation URL API Reference: Provides details and examples of all available transformation parameters.
  • Admin API guide: Provides details and examples of the methods available for managing and organizing your media assets.