Skip to content

Kirby 3.8.4

$api->file()

Returns the file object for the given parent path and filename

$api->file(string $path, string $filename): Kirby\Cms\File|null

Parameters

Name Type Default Description
$path * string Path to file's parent model
$filename * string

Return type

Kirby\Cms\File|null

Exceptions

Type Description
Kirby\Exception\NotFoundException if the file cannot be found

Parent class

Kirby\Cms\Api