$file->thumb()
Creates a modified version of images The media manager takes care of generating those modified versions and putting them in the right place. This is normally the /media
folder of your installation, but could potentially also be a CDN or any other place.
Parameters
Name | Type | Default |
---|---|---|
$options | array |string |null |
null |
Return type
Kirby\Cms\FileVersion
|Kirby\Cms\File
|Kirby\Filesystem\Asset
Exceptions
Type | Description |
---|---|
Kirby\Exception\InvalidArgumentException |
Parent class
Options
Accepted types
Type | Value |
---|---|
null | Default preset from configuration if defined |
string | Name of preset defined in configuration |
array | See details below |
If you pass an array as options, you can use the following key/value pairs (values are the default values):
You can also set the format
option to convert an existing JPEG, GIF or PNG into a WebP or AVIF file method (value is the default value).
You can define presets of options in your config.php
. Learn more ›
Examples
If a focal point is set, this focal point will automatically be used when the crop option is set to true
. If you use a custom crop position, this will overwrite the focal point set in the file metadata.