PHP v2 image transformations (Beta)

After you or your users have uploaded image assets to Cloudinary, you can deliver them via dynamic URLs. You can include instructions in your dynamic URLs that tell Cloudinary to manipulate your assets using a set of transformation parameters. All manipulations are performed automatically in the cloud and your transformed assets are automatically optimized before they are routed through a fast CDN to the end user for optimal user experience.

For example, you can resize and crop, add overlay images, blur or pixelate faces, apply a large variety of special effects and filters, and apply settings to optimize your images and to deliver them responsively.

Cloudinary's PHP library simplifies the generation of transformation URLs for easy embedding of assets in your PHP application.

See also: PHP video manipulation

Syntax overview

The PHP SDK provides a more intuitive coding experience for transforming an asset:

  • The SDK supports an action-based syntax, designed to make building delivery URLs and transformations more logical and discoverable.
  • When compiled to the final delivery URL, each action represents a different transformation component.
  • Allows discovering the available options from within your development environment, and ensures that only options that are supported can be used together.

SDK2 transformation structure

  • Action: An Action represents a directive to Cloudinary on how to transform a specific aspect of an asset (e.g., effect or resize). The Action may also include specific values (e.g., Outline::OUTER, 100 to indicate an outer border with a width of 100 pixels).
  • ActionType: The ActionType defines the specific Action to apply (e.g., Effect::outline() or Resize::crop()).
  • Qualifier: Qualifiers further define how to apply an Action (e.g., color qualifies the Effect::outline Action with a value of Color::LIGHTBLUE).

The output of each Action is a complete transformation component (separated by slashes) in the URL. For example, the syntax example above would generate a URL similar to the following:

Copy to clipboard
https://res.cloudinary.com/demo/image/upload/co_lightblue,e_outline:outer:100/mypic.jpg

Deliver and transform images

You can deliver your images using methods the generate image tags or via direct URL-building directives.

The imageTag method

You can add images to your PHP view using Cloudinary's imageTag helper method. This method generates the full image resource URL based on the given transformation parameters and adds the image tag to your HTML code:

Copy to clipboard
Cloudinary $cld = new Cloudinary();
$cld->imageTag('sample');

The code above generates the following HTML image tag:

Copy to clipboard
<img src="https://res.cloudinary.com/demo/image/upload/sample">

You can also include actions in the request, for example, to deliver an image padded to a width of 400 pixels:

Copy to clipboard
use Cloudinary\Transformation\Resize;

$cld->imageTag('sample')->resize(Resize::pad(400));

Note
You also need to include the Group classes you use (e.g. Resize in the example above).

Chaining transformation actions

Cloudinary supports powerful transformations. You can even combine multiple transformation actions together as part of a single transformation request, e.g. resize an image and add a border. In certain cases you may want to perform additional transformations on the result of the previous transformation action. To do that, you can use chained transformation actions.

The following example first crops the original image to a specific set of custom coordinates and then transforms the result so it fills a 130x100 rectangle:

Copy to clipboard
$cld->imageTag('brown_sheep.jpg')
  ->resize(Resize::crop(300, 200)->x(355)->y(410))
  ->resize(Resize::fill(130, 100));

Simple chaining example

The following example applies 4 chained transformations: custom cropping to 300x200, fill to 130x100, rotate by 20 degrees and then scale to 50%:

Copy to clipboard
$cld->imageTag('brown_sheep.jpg')
  ->resize(Resize::crop(300, 200)->x(355)->y(410))
  ->resize(Resize::fill(130, 100))
  ->rotate(20)
  ->resize(Resize::scale(0.5));

More complex chaining example

For more information on image transformations, see Apply common image transformations.

Direct URL building

The ImageTag method described above generates an HTML image tag. In certain conditions, you might want to generate a transformation URL directly, without the containing image tag. To return only the URL, use the Image helper method. Here are few examples:

Copy to clipboard
$cld->image('sample.jpg')
  ->resize(Resize::fill(100,150));       
// Output: "https://res.cloudinary.com/demo/image/upload/c_fill,h_150,w_100/sample.jpg"

$cld->image('sample.png') 
  ->resize(Resize::scale(200, 200))
  ->effect(Effect::sepia());
// Output: "https://res.cloudinary.com/demo/image/upload/c_scale,h_200,w_200/e_sepia/sample.png"

Apply common image transformations

This section provides an overview and examples of the following commonly used image transformation features, along with links to more detailed documentation on these features:

Keep in mind that this section is only intended to introduce you to the basics of using image transformations with PHP.

For comprehensive explanations of how to implement a wide variety of transformations, see Image transformations. For a full list of all supported image transformations and their usage, see the Image transformation reference.

Resizing and cropping

There are a variety of different ways to resize and/or crop your images, and to control the area of the image that is preserved during a crop.

The following example uses the fill cropping method to generate and deliver an image that completely fills the requested 250x250 size while retaining the original aspect ratio. It uses face detection gravity to ensure that all the faces in the image are retained and centered when the image is cropped:

Copy to clipboard
$cloudinary->image('family_bench.jpg')
  ->resize(Resize::fill(250, 250)->gravity(Gravity::faces()));
Original image before face recognition cropping Original image Fill cropping with 'faces' gravity Fill cropping with 'faces' gravity

For details on all resizing and cropping options, see resizing and cropping images.

Converting to another image format

You can deliver any image uploaded to Cloudinary in essentially any image format. There are three main ways to convert and deliver in another format:

  • Specifying the image's public ID with the desired extension.
  • Explicitly setting the desired format using the fetch_format parameter.
  • Using the auto fetch_format to instruct Cloudinary to deliver the image in the most optimized format for each browser that requests it.

For example:

Deliver a .jpg file in .gif format:

Copy to clipboard
$cloudinary->image('sample.gif')

Let Cloudinary select the optimal format for each browser. For example, in Chrome, this image delivers in .webp format:

Copy to clipboard
$cloudinary->image('cloud_castle.jpg')->resize(Resize::scale(350))->format(Format::auto());

generates the following URL:

For more details see Image format support.

Applying image effects and filters

You can select from a large selection of image effects, enhancements, and filters to apply to your images. The available effects include a variety of color balance and level effects, tinting, blurring, pixelating, sharpening, automatic improvement effects, artistic filters, image and text overlays, distortion and shape changing effects, outlines, backgrounds, shadows, and more.

For example, the code below applies a cartoonify effect, rounding corners effect, and background color effect (and then scales the image down to a height of 300 pixels).

Copy to clipboard
$cloudinary->image('actor.jpg')
  ->effect(Effect::cartoonify())
  ->roundCorners(RoundCorners::max())
  ->effect(Effect::outline(Outline::OUTER, 100)->color(Color::LIGHTBLUE))
  ->background(Color::LIGHTBLUE)
  ->resize(Resize::scale()->height(300));

An image with several transformation effects

For more details on the available image effects and filters, see Applying image effects and filters

Adding text and image overlays

You can add images and text as overlays on your main image. You can apply the same types of transformations on your overlay images as you can with any image and you can use gravity settings or x and y coordinates to control the location of the overlays. You can also apply a variety of transformations on text, such color, font, size, rotation, and more.

For example, the code below overlays a couple's photo on a mug image. The overlay photo is cropped using face detection with adjusted color saturation and a vignette effect applied. The word love is added in a pink, fancy font and rotated to fit the design. A balloon graphic is also added. Additionally, the final image is cropped and the corners are rounded.

Copy to clipboard
$cloudinary->image('coffee_cup.jpg')
  ->resize(Resize::fill(400, 250)->gravity(Gravity::south()))
  ->overlay(
      Source::image('nice_couple')
        ->resize(
            Resize::crop(1.3, 1.3)->gravity(Gravity::faces())
                ->resizeMode(ResizeMode::regionRelative())
        )
        ->adjust(Adjust::saturation(50))
        ->effect(Effect::vignette())
        ->resize(Resize::scale(100))
        ->roundCorners(RoundCorners::max()),
      Position::center()->x(-20)->y(20)
  )
  ->overlay(
      Source::image('balloon')
        ->resize(Resize::scale()->height(55))
        ->adjust(Adjust::hue(-20))
        ->rotate(5),
      Position::center()->x(30)->y(5)
  )
  ->overlay(
      Source::text('Love')
        ->fontFamily('Cookie')
        ->fontSize(40)
        ->fontWeight(FontWeight::BOLD)
        ->effect(Effect::colorize()->color(Color::rgb('#f08')))
        ->rotate(20),
      Position::center()->x(-45)->y(44)
  )
  ->resize(Resize::crop(300, 250)->x(30))
  ->roundCorners(60);

An image with many transformations and overlays applied

Image optimizations

By default, Cloudinary automatically performs certain optimizations on all transformed images. There are also a number of additional features that enable you to further optimize the images you use in your application. These include optimizations to image quality, format, and size, among others.

For example, you can use auto as the value for format and quality to automatically deliver the image in the format and quality that minimize file size while meeting the required quality level. The following example applies both, resulting in a 50% file size reduction (1.4MB vs. 784KB) with no visible change in quality.

Copy to clipboard
$cloudinary->image('pond_reflect.jpg')
  ->format(Format::auto())
  ->quality(Quality::auto());

50% file size optimization using auto format and auto quality features

For an in-depth review of the many ways you can optimize your images, see Image optimization

Responsive image settings

Responsive web design is a method of designing websites to provide an optimal viewing experience to users, irrespective of the device, window size, orientation, or resolution used to view it. Ensuring that optimal experience means you should avoid sending high resolution images that get resized client-side, with significant bandwidth waste for users of small displays. Instead, you should always deliver the right size image for each device and screen size.

For example, you can ensure that each user receives images at the size and device pixel ratio (dpr) that fit their device using the auto value for the dpr and width attributes. The auto value is replaced with actual values on the client side based on the actual browser settings and window width:

Copy to clipboard
$myTag = $cld->imageTag('myphoto')
  ->resize(Resize::scale())->width('auto')->dpr('auto')
  ->rotate(Rotate::angle(20))
  ->border(Border::solid()->width(3)->color(Color::RED)
  ->roundCorners(RoundCorners::max())
  ->effect(Effect::artisticFilter(ArtisticFilter::HOKUSAI)));
$myTag->config->tag->responsive = true;
$myTag->config->tag->responsivePlaceholder = 'blank';

Cloudinary offers several options for simplifying the complexity of delivering responsive images. For a detailed guide on how to implement these options, see Responsive images.

See also