Version: Edit on GitHub

Image Thumbnails

For images, Pimcore offers an advanced thumbnail-service also called 'image-pipeline'. It allows you to transform images in unlimited steps to the expected result. You can configure them in Settings > Thumbnails.

With this service every image which is stored as an asset can be transformed. Pimcore doesn't support to modify images which are not stored as an asset inside Pimcore.

IMPORTANT
Use Imagick PECL extension for best results, GDlib is just a fallback with limited functionality (only PNG, JPG, GIF) and less quality! Using ImageMagick Pimcore supports hundreds of formats including: AI, EPS, TIFF, PNG, JPG, GIF, PSD, ...

To use the thumbnailing service of Pimcore, you have to create a transformation pipeline first. To do so, open Settings > Thumbnails and click on Add Thumbnail to create a new configuration. The fields name, description, format and quality should be self-explanatory, the interesting part are now the transformations. Click on + to add a new transformation, so that it look like that for example:

Thumbnails

Important: The transformations are performed in the order from the top to the bottom. This is for example important in the configuration above. If you first round the corners this would be performed on the original image, and then the image will get resized, so the rounded corners are also resized which is not intended.

To retrieve a thumbnail from an asses simply call $asset->getThumbnail("thumbnail-name") on the asset object, which will return an \Pimcore\Model\Asset\Image\Thumbnail object. The thumbnail object's __toString() method returns the path to the thumbnail file, for example: /Car%20Images/ac%20cars/image-thumb__68__content/automotive-car-classic-149813.jpg

Important: The function getThumbnail() does not generate the Thumbnail itself. It just returns the path were the thumbnail file will be stored. If you want to generate the Thumbnail directly have a look at Deferred Rendering of Thumbnails

This path can then be directly used to display the image in a <img /> or <picture> tag. For example:

$image = Asset::getById(1234);

// get path to thumbnail, e.g. `/foo/bar/image-thumb__362__content/foo.webp 
$pathToThumbnail = $image->getThumbnail("myThumbnailName");

// preferred alternative - let Pimcore create the whole image tag
// including high-res alternatives (srcset) or media queries, if configured
$htmlCode = $image->getThumbnail("myThumbnail")->getHtml();

Same in Twig:

{% set image = pimcore_asset(1234) %}

{# get path to thumbnail, e.g. `/foo/bar/image-thumb__362__content/foo.webp #}
<img src="{{ image.thumbnail('myThumbnailName') }}">

{# preferred alternative - let Pimcore create the whole image tag #}
{# including high-res alternatives (srcset) or media queries, if configured #}
{{ image.thumbnail('myThumbnailName').html }}

Explanation of the Transformations

Transformation Description Configuration Result
ORIGINAL IMAGE This is the image which is used in the following transformations NONE ;-) Sample Original
RESIZE The image is exactly resized to the given dimensions without respecting the ratio. Config Resize Sample Resize
SCALE BY HEIGHT The image is scaled respecting the ratio to the given height, the width is variable depending on the original ratio of the image (portrait, landscape). Config Height Sample Height
SCALE BY WIDTH The image is scaled respecting the ratio to the given width, the height is variable depending on the original ratio of the image (portrait, landscape). Config Width Sample Width
CONTAIN The image is scaled to either the given height or the width, depending on the ratio of the original image. That means that the image is scaled to fit into a "virtual" box with the dimensions given in the configuration. Config Contain Sample Contain
CROP Cuts out a box of the image starting at the given X,Y coordinates and using the width and height. Config Crop Sample Crop
COVER The image is resized so that it completely covers the given dimensions. Then the overlapping pieces are cropped depending on the given positioning or based on the focal point set on the source image. This is useful if you need a fixed size for a thumbnail but the source images have different ratios. Config Cover Sample Cover
FRAME The transformation is the same as CONTAIN the difference is, that the image gets exactly the entered dimensions by adding transparent borders left / right or top / bottom. Config Frame Sample Frame
ROTATE Rotates the image with the given angle. The background is transparent by default. Config Rotate Sample Rotate
BACKGROUND COLOR Background color is especially useful if you have transparent PNG as source data or if you're using the FRAME or the ROTATE transformations where you get transparencies. It allows you to give transparencies a color, and gives you the possibility to use them for examples JPEG's which doesn't support transparency. Config Background Sample Background
ROUNDED CORNERS Rounds the corners to the given width/height. Config Corner Sample Corner

For thumbnails in action also have a look at our Live Demo.

Generating HTML for Thumbnails

Pimcore offers the method getHTML(array $options) to get a ready to use <picture> tag for your thumbnail. You can configure the generated markup with the following options:

Name Type Description
disableWidthHeightAttributes bool Width & height attributes are set automatically by Pimcore, to avoid this set this option (eg. to true => isset check)
disableAutoTitle bool Set to true, to disable the automatically generated title attribute (containing title and copyright from the origin image)
disableAutoAlt bool Set to true, to disable the automatically generated alt attribute
disableAutoCopyright bool Set to true, to disable the automatically appended copyright info (alt & title attribute)
disableAutoCopyright bool Set to true, to disable the automatically appended copyright info (alt & title attribute)
pictureAttributes array
imgAttributes array
lowQualityPlaceholder bool Put's a small SVG/JPEG placeholder image into the src (data-uri), the real image path is placed in data-src and data-srcset.
pictureCallback callable A callable to modify the attributes for the generated <picture> tag. There 1 argument passed, the array of attributes.
sourceCallback callable A callable to modify the attributes for any of the generated <source> tag. There 1 argument passed, the array of attributes.
imgCallback callable A callable to modify the attributes for the generated <img> tag. There 1 argument passed, the array of attributes.
disableImgTag bool Set to true to not include the <img> fallback tag in the generated <picture> tag.
useDataSrc bool Set to true to use data-src(set) attributes instead of src(set).

Usage Examples

/* Use directly on the asset object */
{{ pimcore_asset_by_path('/path/to/image.jpg').thumbnail('myThumbnail').html }}

/* ... with some additional options */
{{ pimcore_asset_by_path('/path/to/image.jpg').thumbnail('myThumbnail').html({ 
    pictureAttributes: {
        data-test: "my value"
    },
    disableImgTag: true
}) }}

/* Use with the image tag in documents */
<div>
    <p>
        {{ pimcore_image('myImage', {'thumbnail': 'myThumbnail'}) }}
    </p>
</div>

/* Use without pre-configured thumbnail */
{{ pimcore_image('myImage', {
    'thumbnail': {
        'width': 500,
        'aspectratio': true,
        'interlace': true,
        'quality': 85,
        'format': 'png'
    }
}) }}
 
/* Use from an object-field */
/* where "myThumbnail" is the name of the thumbnail configuration in settings -> thumbnails */
{% if myObject.myImage %}
   {{ myObject.myImage.thumbnail('myThumbnail').html }}
{% endif %}

 
/* Use from an object-field with dynamic configuration */
<img src="{{ myObject.myImage.thumbnail({'width': 220, 'format': 'jpeg'}) }}" />
 

/* Use directly on the asset object using dynamic configuration */
{{ pimcore_asset_by_path('/path/to/image.jpg').thumbnail({'width': 500, 'format': 'png'}).html }}

Advanced Examples

Pimcore returns an \Pimcore\Model\Asset\Image\Thumbnail object when calling $asset->getThumbnail("thumb-name") which gives you even more flexibility when working with thumbnails.

$thumbnail = $asset->getThumbnail("myThumbnail");
 
// get the final dimensions of the thumbnail (especially useful when working with dynamic configurations)
$width = $thumbnail->getWidth();
$height = $thumbnail->getHeight();
 
// get the html "<picture>" tag for the thumbnail incl. custom class on the containing `<img>` tag:
echo $thumbnail->getHtml(['imgAttributes' => ["class" => "custom-class"]]);
 
// get the path to the thumbnail
$path = $thumbnail->getPath();
 
// Asset\Image\Thumbnail implements __toString(), so you can still print the path by
echo $thumbnail; // prints something like /Car%20Images/....png

// examples for callbacks, etc. for the generated <picture> tag
$thumbnail->getHtml([
    'useDataSrc' => true,
    'pictureAttributes' => [
        'data-bar' => uniqid(),
    ],
    'imgAttributes' => [
        'data-foo' => uniqid(),
    ],
    'imgCallback' => function ($attributes) {
        // modify <img> tag attributes
        $attributes['data-foo'] = 'new value';
        return $attributes;
    },
    'sourceCallback' => function ($attributes) {
        // modify <source> tag attributes
        $attributes['data-custom-source-attr'] = uniqid();
        return $attributes;
    },
    'pictureCallback' => function ($attributes) {
        // modify <source> tag attributes
        $attributes['data-custom-picture-attr'] = uniqid();
        return $attributes;
    },
    'disableImgTag' => true,
    'lowQualityPlaceholder' => true,
]);

More Examples


/* adding custom html attributes to the generated <img> or <picture> tag, using a dynamic thumbnail */
{{ image.thumbnail({
    'width': 180,
    'height': 180,
    'cover': true,
}).html({
    'imgAttributes': {
        'class': 'thumbnail-class',
    },
    'data-my-name': 'my value',
    'attributes': {
        'non-standard': 'HTML attributes',
        'another': 'one'
    }
}) }}
  
/* same with a thumbnail definition */
{{ image.thumbnail('exampleScaleWidth').html({
    'pictureAttributes': {
        'class': 'thumbnail-class',
    },
    'data-my-name': 'my value',
}) }}
  
/* disable the automatically added width & height attributes */
{{ image.thumbnail('exampleScaleWidth').html({}, ['width', 'height']) }}

/* add alt text */
{{ image.thumbnail('exampleScaleWidth').html({'alt': 'top priority alt text'}) }}
/* OR */
{{ image.thumbnail('exampleScaleWidth').html({'defaultalt': 'default alt, if not set in image'}) }}

Additionally there are some special parameters to customize generated image HTML code.

Using ICC Color Profiles for CMYK -> RGB

Pimcore supports ICC color profiles to get better results when converting CMYK images (without embedded color profile) to RGB.

Due licensing issues Pimcore doesn't include the color profiles (*.icc files) in the download package, but you can download them for free here: Adobe ICC Profiles or here: ICC (color.org).

After downloading the profiles put them into your project folder or anywhere else on your sever (eg. /usr/share/color/icc). Then go to the Pimcore system settings, open the assets section and configure the path to your favorite color profile.

Color Profiles

Dynamic Generation on Request

Pimcore auto-generates a thumbnail if requested but doesn't exist on the file system and is directly called via it's file path (not using any of the getThumbnail() methods). For example: Call https://example.com/examples/panama/image-thumb__6644__contentimages/img_0037.jpeg (/examples/panama/ is the path to the source asset, 6644 is the ID of the source asset, contentimages is the name of the thumbnail configuration, img_0037.jpeg the filename of the source asset) directly in your browser. Now pimcore checks if the asset with the ID 6644 and the thumbnail with the key "contentimages" exists, if yes the thumbnail is generated on-the-fly and delivered to the client. When requesting the images again the image is directly served by the webserver (Apache, Nginx), because the file already exists (just the same way it works with the getThumbnail() methods).

The structure of the path is identically with the one generated by the getThumbnail() methods, so it doesn't matter whether the thumbnail is generated by getThumbnail() (inside a PHP process) or on-the-fly (in a separate process).

Of course this works only with predefined (named) thumbnail configurations and not with dynamic configurations.

Deferred Rendering of Thumbnails

For performance reasons, Pimcore doesn't generate the thumbnail image directly when calling getThumbnail() on an asset, instead it generates them when they are actually needed (on request).

But sometimes it's necessary to have the actual image already generated, in this case you can pass a 2nd parameter to getThumbnail() to force the processing of the image.

$asset = Asset\Image::getById(123);
$asset->getThumbnail("myConfig", false); // set the 2nd parameter to false

The processing is also forced when calling the method getPathReference() or getPath(false) on the returning thumbnail object:

$asset->getThumbnail("myConfig")->getPathReference(); 
// or 
$asset->getThumbnail("myConfig")->getPath(false); 

High-Resolution Support

This is a special functionality to allow embedding high resolution (ppi/dpi) images. The following is only necessary in special use-cases like Web-to-Print, in typical web-based cases, Pimcore automatically adds the srcset attribute to <img> and <picture> tags automatically, so no manual work is necessary.

Use in the Thumbnail Configuration:

High Resolution The above configuration will generate a thumbnail with 500px width.

When using this configuration in combination with the image editable using the following code

{{ pimcore_image('myImage', {'thumbnail': 'contentimages'}) }}

this will create the following output:

<img src="/Car%20Images/ac%20cars/image-thumb__68__contentimages/automotive-car-classic-149813@2x.png" width="250" height="190" />

It's also possible to add the high-res dynamically:

{{ pimcore_image('myImage', {thumbnail: {
    width: 250,
    contain: true,
    highResolution: 2
}}) }}

This will create an image width = 500px

Combining "Dynamic Generation on Request" with High Resolution Images

This is especially useful in the case you want to serve thumbnails depending on the ppi of the device screen or in combination with Web2Print documents (browser preview with normal size, tripled in size for PDF ouptut). Pimcore also utilizes this functionality internally to provide the automatically added high.res support on <img> and <picture> tags. So again, this feature is only useful in some edge-cases.

Example
{{ image.thumbnail('testThumbnailDefinitionName').path }}

this generates the followinig ouput:

/Car%20Images/ac%20cars/image-thumb__68__testThumbnailDefinitionName/automotive-car-classic-149813.jpg

To get an high-res version of the thumbnail, you can just add @2x before the file extension:

/Car%20Images/ac%20cars/image-thumb__68__content/automotive-car-classic-149813@2x.png
/Car%20Images/ac%20cars/image-thumb__68__content/automotive-car-classic-149813@5x.png

Using float is possible too:

/Car%20Images/ac%20cars/image-thumb__68__content/automotive-car-classic-149813@3.2x.png

Pimcore will then dynamically generate the thumbnails accordingly.

Media Queries in Thumbnail Configuration

If your're using media queries in your thumbnail configuration pimcore automatically generates a <picture> tag when calling $asset->getThumbnail("example")->getHtml(). But in some cases it is necessary to get single thumbnails for certain media queries out of the thumbnail object, which is described in the examples below.

$a = Asset::getById(71);
 
// list all available medias in "galleryCarousel" thumbnail configuration
p_r(array_keys(Asset\Image\Thumbnail\Config::getByName("galleryCarousel")->getMedias()));
 
// get the <picture> element for "galleryCarousel" => default behavior
$a->getThumbnail("galleryCarousel")->getHtml();
 
// get path of thumbnail for media query min-width: 940px
$a->getThumbnail("galleryCarousel")->getMedia("(min-width: 940px)");
 
// get <img> tag for media query min-width: 320px including @srcset 2x
$a->getThumbnail("galleryCarousel")->getMedia("(min-width: 320px)")->getHtml();
 
// get 2x thumbnail path for media query min-width: 320px
$a->getThumbnail("galleryCarousel")->getMedia("(min-width: 320px)", 2);

Focal Point

Pimcore supports focal points on images, which are considered when images are automatically cropped. At the moment this makes only sense if the transformation COVER is used. If a focal point is set on the source image, it is automatically considered and the thumbnail is cropped accordingly to ensure the focus of the image is on the focal point.

Defining a focal point on image assets

Focal point context menu entry on document image editable

Image thumbnails cover transformation considering focal point

Clipping Support

Images with an embedded clipping path (8BIM / Adobe profile meta data) are automatically clipped when generating thumbnails of them.

If you do not want to use thumbnail auto clipping, you can disable the support by adding the following config option:

    assets:
        image:
            thumbnails:
                clip_auto_support: false

Note on using WebP with Imagick using delegates

Please ensure that your delegate definition for WebP encoding includes the -q flag, otherwise the quality setting on thumbnails will not be considered and the default value of 75 is being used by cwebp.

Working example of a WebP encode delegate (defined in /etc/ImageMagick-6/delegates.xml):

<delegate decode="png" encode="webp" command="&quot;cwebp&quot; -quiet -q %Q &quot;%i&quot; -o &quot;%o&quot;"/>

Adding Custom Callbacks / Transformations / Filters

It is also possible to add some custom code to your thumbnail configurations, this is especially useful for situations when very specific image operations are needed to be applied to the resulting thumbnail.

Example

$thumbnailConfig = Asset\Image\Thumbnail\Config::getByName('content');
$thumbnailConfig->addItemAt(0, function (Imagick $imagick) {
	/**
	 * @var \Imagick $i
	 */
	$i = $imagick->getResource();
	$i->sepiaToneImage(80);
}, []);


$asset = Asset::getById(39);
$asset->clearThumbnails(true);
$thumb = $asset->getThumbnail($thumbnailConfig);
$file = $thumb->getPath();

Downloading Asset Thumbnails

Besides embedding thumbnails into CMS pages and distributing them via other channels, backend users can download a thumbnail of an asset. In order to make a thumbnail downloadable, mark "List as option in download section on image detail view" option in Image Thumbnail Advanced settings. All thumbnails with this option enabled are listed in the "Download Thumbnail" dropdown on the detail view of an Asset. To download the thumbnail of the asset choose the thumbnail from the list and hit the "Download" button.

Customize Auto (Web-Optimized) Format

For most web-based applications it's recommended to use the auto configuration, which does multiple things:

  • automatically select the target image format (jpeg, png) based on image characteristics (such as alpha channel)
  • multiple additional optimized image formats (webp, avif) using progressive enhancement (in <picture tag)
  • runs image optimizers (such as jpegoptim and pngout) on generated images using an async queue

Even if this setting does quite a lot of stuff automatically, it's still required to set a quality in the thumbnail configuration. This quality will be used by jpeg and png and if not configured otherwise also for webp. If avif is supported by Imagick this won't use the quality from the thumbnail configuration, but uses a fixed value.
It is possible to customize the used alternative image formats and their qualities by using the following configuration:

pimcore:
    assets:
        image:
            thumbnails:
                auto_formats:
                    # the quality is used by Imagick, set to null if quality value from config should be used 
                    # the following config is used as the default by Pimcore
                    # the order of the formats is used for the priority of the <source> in the <picture> tag
                    avif:
                        quality: 15
                    webp:
                        quality: null
                        enabled: true

Config for disabling all auto-formats

pimcore:
    assets:
        image:
            thumbnails:
                auto_formats: null