$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.

$file->thumb(array|null|string $options = null): Kirby\Cms\FileVersion|Kirby\Cms\File

Parameters

Name	Type	Default
$options	`array`\|`null`\|`string`	`null`

Return type

Kirby\Cms\FileVersion|Kirby\Cms\File

Exceptions

Type	Description
`Kirby\Exception\InvalidArgumentException`

Parent class

Kirby\Cms\File

Options

You can use the following options in the options array (values are the default values):

$options = [
  'autoOrient' => true,
  'crop'       => false,
  'blur'       => false,
  'grayscale'  => false,
  'height'     => null,
  'quality'    => 90,
  'width'      => null,
];

Since 3.6.0

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).

$options = [
  // other options
  'format'     => null,
];

You can define presets of options in your config.php. Learn more ›

Examples

if($image = $page->image()):
    echo $image->thumb([
      'width'   => 300,
      'height'  => 200,
      'quality' => 80,
    ])->html();
endif;

Since 3.6.0

if($image = $page->image()):
    echo $image->thumb([
      'width'   => 300,
      'height'  => 200,
      'quality' => 80,
      'format'  => 'webp',
    ])->html();
endif;