Skip to content

Kirby 3.8.4

$api->collection()

Setter and getter for an API collection

$api->collection(string $name, Kirby\Toolkit\Collection|array|null $collection = null): Kirby\Api\Collection

Parameters

Name Type Default
$name * string
$collection Kirby\Toolkit\Collection|array|null null

Return type

Kirby\Api\Collection

Exceptions

Type Description
Kirby\Exception\NotFoundException If no collection for $name exists
Exception

Parent class

Kirby\Cms\Api inherited from Kirby\Api\Api