Skip to content

Kirby 5.0.4

$page->image()

Returns a specific image by filename or the first one

$page->image(string|null $filename = null): Kirby\Cms\File|null

Parameters

Name Type Default
$filename stringornull null

Return types

Kirby\Cms\Fileornull

This method modifies the existing $page object it is applied to and returns it again.

Parent class

Kirby\Cms\Page

What is an image file?

Kirby considers the following file types as images:

  • ai
  • avif
  • bmp
  • gif
  • eps
  • ico
  • j2k
  • jp2
  • jpeg
  • jpg
  • jpe
  • png
  • ps
  • psd
  • svg
  • tif
  • tiff
  • webp

Examples

Fetching the first image

<?php if ($image = $page->image()): ?>
<img src="<?= $image->url() ?>" alt="">
<?php endif ?>

Fetching a specific image

<?php if ($image = $page->image('myimage.jpg')): ?>
<img src="<?= $image->url() ?>" alt="">
<?php endif ?>