Kirby CMS

https://getkirby.com/docs
Admin
Kirby is a content management system that focuses on flexibility and ease of use for creators,...
Tokens:2,327,527
Snippets:25,405
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install a specific Kirby kit with kirby install:kit <kitname>

Source: https://getkirby.com/docs/guide/install-guide/cli

Install a specific kit by providing its name directly. The example installs the Starterkit. After running, you will be prompted to specify a folder name or accept the proposed name by pressing Enter again.

```bash
kirby install:kit <kitname>
```

```bash
kirby install:kit starterkit
```

--------------------------------

### Setup index.php with error display and Book class include

Source: https://getkirby.com/docs/cookbook/php/understanding-oop

Initial setup for the example: enables error display and includes the Book class file. Place this in index.php next to Book.php.

```php
<?php
// make PHP display errors on screen
ini_set('display_errors', 1);
// require the book class
require_once __DIR__ . '/Book.php';
```

--------------------------------

### Example: $file->site()

Source: https://getkirby.com/docs/reference/objects/cms/file/site

Example usage of the `$file->site()` method to get the parent Site object.

```php
$site = $file->site();
```

--------------------------------

### Example: Iterate over files starting from offset 10

Source: https://getkirby.com/docs/reference/objects/cms/files/offset

Example of using $files->offset(10) to iterate over files starting from the 10th file. The example outputs a list of file links with filenames.

```php
<ul>
  <?php foreach($page->files()->offset(10) as $file): ?>
  <li>
    <a href="<?= $file->url() ?>">
      <?= html($file->filename()) ?>
    </a>
  </li>
  <?php endforeach ?>
</ul>
```

--------------------------------

### DDEV start success message

Source: https://getkirby.com/docs/cookbook/development-deployment/ddev

Example output shown after running ddev start, indicating the project is ready and accessible at the given URLs.

```bash
All project containers are now ready.
Successfully started <yourfoldername>
Project can be reached at http://<yourfoldername>.ddev.site http://127.0.0.1:51312
```

--------------------------------

### Dockerfile for Kirby Starterkit (Ubuntu, Apache, PHP)

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Use this Dockerfile to build a Docker image for the Kirby Starterkit. It installs Apache and PHP with the required extensions, sets the timezone to Europe/Berlin, and suppresses interactive prompts. Unlike the previous example, it does not install Git or clone the Starterkit inside the container.

```Dockerfile
# Use latest offical ubuntu image
FROM ubuntu:latest

# Set timezone
ENV TZ=Europe/Berlin

# Set geographic area using above variable
# This is necessary, otherwise building the image doesn't work
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

# Remove annoying messages during package installation
ARG DEBIAN_FRONTEND=noninteractive

# Install packages: web server & PHP plus extensions
RUN apt-get update && apt-get install -y \
  apache2 \
  apache2-utils \
  ca-certificates \
  php \
  libapache2-mod-php \
  php-curl \
  php-dom \
  php-gd \
  php-intl \
  php-json \
  php-mbstring \
  php-xml \
  php-zip && \
  apt-get clean && rm -rf /var/lib/apt/lists/*

# Copy virtual host configuration from current path onto existing 000-default.conf
COPY 000-default.conf /etc/apache2/sites-available/000-default.conf

# Enable Apache modules required by Kirby: rewrite and headers
RUN a2enmod rewrite && a2enmod headers

# Copy the starterkit into the web root and set permissions
COPY starterkit /var/www/html
RUN chown -R www-data:www-data /var/www/html && chmod -R 755 /var/www/html /var/www/html/* && chmod -R 775 /var/www/html/storage /var/www/html/content && chmod -R 775 /var/www/html/assets /var/www/html/media && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/index.php && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www/html/.htaccess && chmod -R 775 /var/www
```

--------------------------------

### Examples of $site->search()

Source: https://getkirby.com/docs/reference/objects/cms/site/search

Various examples of using $site->search() to search the site, filter results, add pagination, search in specific fields, search full words, and use a GET parameter.

```php
// search the entire site
$results = $site->search('my awesome search');

// filter the search results
$results = $site->search('my awesome search')->listed()->filterBy('template', 'article');

// add pagination to the search results
$results = $site->search('my awesome search')->paginate(20);

// search in certain fields only
$results = $site->search('my awesome search', 'title|text');

// search for full words only
$results = $site->search('my awesome->search', ['words' => true]);

// feed the search with a get parameter -> http://yourdomain.com/?q=awesome
$results = $site->search(get('q'));
```

--------------------------------

### Fetching the first file

Source: https://getkirby.com/docs/reference/objects/cms/site/file

Example of using $site->file() without arguments to get the first file. Checks if a file exists and outputs a link with the filename.

```php
<?php if ($file = $site->file()): ?>
<a href="<?= $file->url() ?>">
  <?= html($file->filename()) ?>
</a>
<?php endif ?>
```

--------------------------------

### Example: $pages->get() usage

Source: https://getkirby.com/docs/reference/objects/cms/pages/get

Example of using $pages->get() to retrieve a page by key and output its title.

```php
<?= $page->children()->get('some-page')->title() ?>
```

--------------------------------

### Example: get document_root

Source: https://getkirby.com/docs/reference/objects/http/environment/get

Example usage of $environment->get() to retrieve the 'document_root' key. The comment shows a sample output of '/var/www/kirby'.

```php
// sample output: /var/www/kirby
$server->get('document_root');
```

--------------------------------

### Fetching the first image with $site->image()

Source: https://getkirby.com/docs/reference/objects/cms/site/image

Example of using `$site->image()` without arguments to get the first image and display it in an HTML img tag.

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

--------------------------------

### Example: Creating a file with $site->createFile()

Source: https://getkirby.com/docs/reference/objects/cms/site/create-file

This example impersonates the 'kirby' user and creates a new file with the given properties, including filename, parent, source, template, and content.

```php
$kirby->impersonate('kirby');

$newPage = $site->createFile(
    [
        'filename' => 'trees.jpg',
        'parent'   => $site,
        'source'   => $kirby->root('assets') . '/images/trees.jpg',
        'template' => 'image',
        'content' => [
            'alt' => 'A beautiful flower',
        ],
    ]
);
```

--------------------------------

### Section::setup()

Source: https://getkirby.com/docs/reference/objects/cms/section

Sets up the section with given parameters.

```APIDOC
## Section::setup()

### Description
Sets up the section with given parameters.

### Method
Static method

### Signature
`Section::setup(...)`

### Parameters
No parameters documented.

### Returns
- **mixed** - The setup result.

```

--------------------------------

### Example: get an item from the cache driver

Source: https://getkirby.com/docs/reference/objects/cache/apcu-cache/get

Example usage of the `get()` method to retrieve a value from the cache driver. The result is assigned to `$value`.

```php
// get an item from the cache driver
$value = $cache->get('value');
```

--------------------------------

### Example: Creating a new user with User::create()

Source: https://getkirby.com/docs/reference/objects/cms/user/create

Example of creating a new user with email, name, role, language, password, and custom content fields.

```php
$newUser = User::create([
  'email'     => 'bastian@getkirby.com',
  'name'      => 'Bastian',
  'role'      => 'admin',
  'language'  => 'en',
  'password'  => 'topSecret',
  'content'   => [
    'mastodon'  => 'https://mastodon.social/@getkirby',
    'position'  => 'founder'
  ]
]);
```

--------------------------------

### Examples: get latest saved content and unsaved changes

Source: https://getkirby.com/docs/reference/objects/cms/file/version

Shows two usage examples: `$file->version('latest')` to get the latest saved content, and `$file->version('changes')` to get all unsaved changes.

```php
// get the latest saved content of a file
$file->version('latest');

// get all unsaved changes
$file->version('changes');
```

--------------------------------

### Download and copy starterkit content to storage

Source: https://getkirby.com/docs/cookbook/development-deployment/git-based-deployment-with-dokku

Run on the server as root to download the starterkit content, copy it into the live and dev storage folders, set ownership to the Dokku user (UID 32767), and clean up the downloaded files.

```bash
# SERVER (as root)
cd ~
wget -O starterkit.zip https://github.com/getkirby/starterkit/archive/refs/heads/main.zip
unzip starterkit.zip
cp -a starterkit-main/content/* /var/lib/dokku/data/storage/live/content/
cp -a starterkit-main/content/* /var/lib/dokku/data/storage/dev/content/
chown -R 32767:32767 /var/lib/dokku/data/storage/live/content
chown -R 32767:32767 /var/lib/dokku/data/storage/dev/content
rm -r starterkit-main starterkit.zip
```

--------------------------------

### Example: $files->get() usage

Source: https://getkirby.com/docs/reference/objects/cms/files/get

Example of using $files->get() to retrieve a file by its path and output its URL. The method modifies the existing $files object and returns it again.

```php
<?php
if ($file = $page->files()->get('photography/landscape/hobbits-and-stuff.jpg')):
  echo $file->url();
endif;
?>
```

--------------------------------

### $system->init()

Source: https://getkirby.com/docs/reference/objects/cms/system

Initializes the system.

```APIDOC
## $system->init()

### Description
Initializes the system.

### Method
Method call

### Endpoint
`Kirby\Cms\System::init()`

### Parameters
None documented.

### Response
No return value documented.

### Response Example
```php
$system->init();
```
```

--------------------------------

### Using params() to get all parameters

Source: https://getkirby.com/docs/reference/templates/helpers/params

Example of using `params()` to get all detected parameters from the current URL.

```php
// http://yourdomain.com/blog/tag:mytag/year:2014
$params = params();

// $params is array('tag' => 'mytag', 'year' => '2014')
// you can also get a single param with the param function.
```

--------------------------------

### Install Starterkit via Kirby CLI

Source: https://getkirby.com/docs/guide/quickstart

Use this command to install the Starterkit via the Kirby CLI. You will be prompted to specify a folder name to install into.

```bash
kirby install:kit Starterkit
```

--------------------------------

### Example: Get file modification time

Source: https://getkirby.com/docs/reference/objects/cms/file/modified

This example shows how to get the modification time of a file. It demonstrates getting the unix timestamp, a formatted date, and a formatted date using strftime. The modification time reflects the actual file as well as the .txt content file(s), whichever was last modified.

```php
if ($file = $page->file()) {
    // unix timestamp
    echo $file->modified();

    // formatted date
    echo $file->modified('d/m/Y');

    // formatted date using strftime
    echo $file->modified('%d/%m/%Y', 'strftime');

}
```

--------------------------------

### Build and run container with env-file

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Commands to build a new image and run a container with the id.env file, mounting the starterkit directory.

```bash
docker build -t docker-starterkit .
docker run -d --name mycontainer -p 80:80 \
  --mount type=bind,source=$(pwd)/starterkit,destination=/var/www/html \
  --env-file id.env docker-starterkit
```

--------------------------------

### Example: pluck filenames in a loop

Source: https://getkirby.com/docs/reference/objects/cms/files/pluck

Example of using `pluck('filename')` to get all filenames and display them in an HTML list.

```php
<ul>
  <?php foreach($page->files()->pluck('filename') as $filename): ?>
  <li><?= html($filename) ?></li>
  <?php endforeach ?>
</ul>
```

--------------------------------

### Example: List site files with links and sizes

Source: https://getkirby.com/docs/reference/objects/cms/site/files

Iterates over the site's files and outputs each file as a link with its filename and size. Uses $file->url(), $file->filename(), and $file->niceSize().

```php
<h2>Files</h2>
<ul>
  <?php foreach($site->files() as $file): ?>
  <li>
    <a href="<?= $file->url() ?>">
      <?= $file->filename() ?>
      (<?= $file->niceSize() ?>)
    </a>
  </li>
  <?php endforeach ?>
</ul>
```

--------------------------------

### Example: echo $pagination->firstPageUrl()

Source: https://getkirby.com/docs/reference/objects/cms/pagination/first-page-url

Example usage showing how to get and echo the first page URL after paginating a collection.

```php
$subpages   = $page->children()->paginate(10);
$pagination = $subpages->pagination();

echo $pagination->firstPageUrl();
// http://yourdomain/example/page:1
```

--------------------------------

### GET request example

Source: https://getkirby.com/docs/reference/objects/http/remote/request

Performs a GET request to fetch an image and saves the content to a file if the response code is 200.

```php
<?php
$targetPage = page('notes')->children()->first();

$response = Remote::request(
    'https://picsum.photos/200/300',
    [
        'method' => 'GET',
    ]
);

// Save content from request to file
if ($response->code() === 200) {
    F::write($targetPage->root() . '/photo.jpg', $response->content());
}
```

--------------------------------

### Create a new Kirby project with the Plainkit

Source: https://getkirby.com/docs/guide/install-guide/composer

Alternative to the Starterkit command that sets up the Plainkit instead.

```bash
composer create-project getkirby/plainkit your-project
```

--------------------------------

### Create a new Kirby project with the Starterkit

Source: https://getkirby.com/docs/guide/install-guide/composer

Run this command after installing Composer to set up a new Kirby installation with the Starterkit. It creates a project in the `your-project` directory.

```bash
composer create-project getkirby/starterkit your-project
```

--------------------------------

### $session->startTime()

Source: https://getkirby.com/docs/reference/objects/session/session

Gets the session start time.

```APIDOC
## $session->startTime()

### Description
Gets the start time of the session.

### Method
startTime

### Signature
`$session->startTime()`
```

--------------------------------

### $session->startTime

Source: https://getkirby.com/docs/guide/sessions

Gets the session start time.

```APIDOC
## $session->startTime

### Description
Returns the session start time.

### Method
$session->startTime

### Example
```php
$session->startTime();
```

```

--------------------------------

### $system->init()

Source: https://getkirby.com/docs/reference/objects/cms/system/init

Creates the most important folders if they don't exist yet. Throws a PermissionException if the system lacks the necessary permissions.

```APIDOC
## $system->init()

### Description
Creates the most important folders if they don't exist yet.

### Method
`$system->init(): void`

### Parameters
None.

### Return Value
`void`

### Exceptions
- `Kirby\Exception\PermissionException` - Thrown when the system does not have permission to create the folders.

### Parent Class
`Kirby\Cms\System`
```

--------------------------------

### F::dirname() usage example

Source: https://getkirby.com/docs/reference/objects/filesystem/f/dirname

Example of using F::dirname() to get the directory name from a file path. The output is '/var/www'.

```php
$dirname = F::dirname('/var/www/test.txt');
// dirname is /var/www
```

--------------------------------

### Configuration file example: site/config/config.php

Source: https://getkirby.com/docs/reference/objects/cms/app/option

Example configuration file showing how to define a nested option 'my.option' with value 'foo'.

```php
return [
    'my' => [
        'option' => 'foo'
    ]
];
```

--------------------------------

### Create Dockerfile for Kirby Starterkit

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Defines a Docker image based on webdevops/php-apache-dev:8.1, installs Git, and clones the Starterkit into /app. The FROM line must be first. The base OS is Debian, so apt-get is used.

```Dockerfile
FROM webdevops/php-apache-dev:8.1
RUN apt-get update && apt-get install -y git
RUN git clone --depth 1 https://github.com/getkirby/starterkit.git /app
```

--------------------------------

### Example: Iterate over siblings

Source: https://getkirby.com/docs/reference/objects/cms/page/siblings

Example of using `$page->siblings()` to get all sibling pages and loop through them, displaying each sibling's title as HTML.

```php
<?php
$siblings = $page->siblings();
foreach($siblings as $sibling):
?>
  <h1><?= $sibling->title()->html() ?></h1>
<?php endforeach ?>
```

--------------------------------

### new System()

Source: https://getkirby.com/docs/reference/objects/cms/system

Creates a new System instance to gather server and environment information.

```APIDOC
## new System()

### Description
Creates a new System instance to gather server and environment information.

### Method
Constructor

### Endpoint
`Kirby\Cms\System::__construct()`

### Parameters
None documented.

### Response
Returns a new `Kirby\Cms\System` instance.

### Response Example
```php
$system = new System();
```
```

--------------------------------

### Example: Get filename of a page's file

Source: https://getkirby.com/docs/reference/objects/cms/file/filename

Example usage: if a page has a file, echo its filename. The method returns the filename with extension.

```php
if ($file = $page->file()) {
    echo $file->filename();
}
```

--------------------------------

### Install Starterkit via Git clone

Source: https://getkirby.com/docs/guide/quickstart

Run this command in a terminal to create a new Kirby project based on the Starterkit. Replace 'project-folder' with your desired directory name.

```bash
git clone https://github.com/getkirby/starterkit project-folder
```

--------------------------------

### Example: thumb() with width, height, and quality

Source: https://getkirby.com/docs/reference/objects/cms/file/thumb

Example of using `$file->thumb()` with an array of options to resize an image and output it as HTML.

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

--------------------------------

### Example: Get last child page title

Source: https://getkirby.com/docs/reference/objects/cms/pages/last

Outputs the title of the last child page of the current page. Uses the children() method to get a Pages collection and then last() to get the final element.

```php
<?= $page->children()->last()->title() ?>
```

--------------------------------

### Example: Using $files->pagination()

Source: https://getkirby.com/docs/reference/objects/cms/files/pagination

Shows how to paginate files and then retrieve the pagination object.

```php
$files      = $page->files()->paginate(10);
$pagination = $files->pagination();
```

--------------------------------

### Folder structure after setup

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Expected folder structure for the docker-example-3 project.

```filesystem
docker-example-3/
  starterkit/
  default.conf
  Dockerfile
  entrypoint.sh
  id.env
```

--------------------------------

### $system->isInstallable(): bool

Source: https://getkirby.com/docs/reference/objects/cms/system/is-installable

Checks if the Panel is installable. On a public server the panel.install option must be explicitly set to true to get the installer up and running.

```APIDOC
## $system->isInstallable()

### Description
Checks if the Panel is installable. On a public server the panel.install option must be explicitly set to true to get the installer up and running.

### Method
`$system->isInstallable(): bool`

### Return Type
`bool`

### Notes
This method modifies the existing `$system` object it is applied to and returns it again.

### Parent Class
`Kirby\Cms\System`
```

--------------------------------

### Field::setup()

Source: https://getkirby.com/docs/reference/objects/form/field

Sets up the field with default properties.

```APIDOC
## Field::setup()

### Description
Sets up the field with default properties.

### Method
Static method

### Parameters
- **$params** (array) - Required - Field definition array

### Returns
- **array** - The setup field definition
```

--------------------------------

### Usage example: $page->related()->toPage()

Source: https://getkirby.com/docs/reference/templates/field-methods/to-page

Example of using `toPage()` to get a related page and display a link. The method modifies the `$field` object and returns it.

```php
<?php if ($related = $page->related()->toPage()): ?>
  <p><a href="<?= $related->url() ?>">Read more…</a></p>
<?php endif ?>
```

--------------------------------

### $session->startTime(): int

Source: https://getkirby.com/docs/reference/objects/session/session/start-time

Gets the session start time as an integer timestamp.

```APIDOC
## $session->startTime()

### Description
Gets the session start time.

### Method
`$session->startTime(): int`

### Return Type
`int` - Timestamp

### Parent Class
`Kirby\Session\Session`

### Notes
This method modifies the existing `$session` object it is applied to and returns it again.
```

--------------------------------

### Clone the Starterkit repository

Source: https://getkirby.com/docs/guide/install-guide/git

Use this command to install Kirby by cloning the Starterkit repository into the current directory. Navigate to the desired installation location first, then run the command in the terminal.

```bash
git clone https://github.com/getkirby/starterkit.git
```

--------------------------------

### Example: Using toFile() in a template

Source: https://getkirby.com/docs/reference/templates/field-methods/to-file

Example of using `toFile()` to get a file object from a field and display it as an image. The method modifies the existing `$field` object and returns it.

```php
<?php if ($cover = $page->cover()->toFile()): ?>
<figure class="cover">
  <img src="<?= $cover->url() ?>" alt="<?= $cover->alt() ?>">
</figure>
<?php endif ?>
```

--------------------------------

### Example: Using $pagination->lastPage()

Source: https://getkirby.com/docs/reference/objects/cms/pagination/last-page

Shows how to get the last page number from a paginated collection. The example paginates the children of a page and then echoes the last page number.

```php
$subpages   = $page->children()->paginate(10);
$pagination = $subpages->pagination();

echo $pagination->lastPage();
```

--------------------------------

### List files in /app inside the container

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Lists the contents of the /app directory inside the running container to confirm the Starterkit is installed there. Changes made through the command line are reflected in the browser as long as the container exists.

```bash
ls -la /app
```

--------------------------------

### Content of /content/site.txt

Source: https://getkirby.com/docs/guide/templates/collections---Examples%3A%60%60%60php%3C?php%24customCollection+=+collection%28%27projects%27%29%3Bdump%28%24customCollection%29%3B%60%60%60

The site.txt file of the Starterkit, containing fields like Title, Author, Description, and Copyright, which are accessible via the $site object.

```text
Title: Kirby Starterkit

----

Author: Content Folder GmbH & Co. KG

----

Description: This is Kirby's Starterkit.

----

Copyright: © 2009–2026 <a href="http://getkirby.com">The Kirby Team</a>
```

--------------------------------

### Get an item by position with nth()

Source: https://getkirby.com/docs/cookbook/php/loops

Use nth() to fetch an item by its zero-based index in the collection. The example gets the 4th element (index 3) and prints its title.

```php
$items  = $pages->listed();
$item = $items->nth(3); // get the 4th element in the collection (index starts at 0)
echo $item->title();

```

--------------------------------

### Example: Check for images and get them

Source: https://getkirby.com/docs/reference/objects/cms/page/has-images

Example usage of $page->hasImages() to check for images and retrieve them with $page->images(). Echoing the result outputs 1 when true and nothing when false.

```php
<?php
echo $page->hasImages(); // will echo 1 if true, nothing if false

if ($page->hasImages()) {
  $images = $page->images();
}
?>
```

--------------------------------

### Define presets: extended example in config.php

Source: https://getkirby.com/docs/reference/objects/cms/file/srcset

Configuration example for defining srcset presets with quality options in /site/config/config.php.

```php
return [
  'thumbs' => [
    'srcsets' => [
      'default' => [
        '800w' => ['width' => 800, 'quality' => 80],
        '1024w' => ['width' => 1024, 'quality' => 80],
        '1440w' => ['width' => 1440, 'quality' => 80],
        '2048w' => ['width' => 2048, 'quality' => 80]
      ]
  ]
  ]
];
```

--------------------------------

### Example: Get username for a user

Source: https://getkirby.com/docs/reference/objects/cms/user/username

Outputs the username for the user with the email 'bastian@example.com'.

```php
<?= $kirby->user('bastian@example.com')->username() ?>
```

--------------------------------

### Section::setup(string $type): array

Source: https://getkirby.com/docs/reference/objects/cms/section/setup

Loads all options from the component definition mixes in the defaults from the defaults method and then injects all additional mixins, defined in the component options.

```APIDOC
## Section::setup(string $type): array

### Description
Loads all options from the component definition mixes in the defaults from the defaults method and then injects all additional mixins, defined in the component options.

### Method
Section::setup

### Signature
`Section::setup(string $type): array`

### Parameters
- **$type** (string) - Required - The type of the section.

### Return Type
`array`

### Parent Class
`Kirby\Cms\Section` inherited from `Kirby\Toolkit\Component`
```

--------------------------------

### Use section in blueprint site.yml

Source: https://getkirby.com/docs/cookbook/extensions/first-panel-section

Blueprint configuration for the site.yml file that uses the custom 'links' section type. The section will appear on the Panel start page with the label 'Getting started'.

```yaml
Title: Site
  sections:
    links:
      type: links
      label: Getting started
```

--------------------------------

### Define presets: simple example in config.php

Source: https://getkirby.com/docs/reference/objects/cms/file/srcset

Configuration example for defining srcset presets in site/config/config.php.

```php
return [
  'thumbs' => [
    'srcsets' => [
            'default' => [300, 800, 1024],
            'cover' => [800, 1024, 2048]
        ]
  ]
];
```

--------------------------------

### Str::ltrim() example trimming 'ab' from 'abababaC'

Source: https://getkirby.com/docs/reference/objects/toolkit/str/ltrim

Example usage: Str::ltrim('abababaC', 'ab') returns 'aC' because it removes the fixed sequence 'ab' from the start until it no longer matches.

```php
Str::ltrim('abababaC', 'ab'); // 'aC'
```

--------------------------------

### Run Docker container for Kirby Starterkit

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Starts a container from the docker-starterkit image, binding local port 80 to the container's port 80 and naming it mycontainer. If port 80 is already in use, use a different host port like -p 8080:80.

```bash
docker run --name mycontainer -p 80:80 docker-starterkit
```

--------------------------------

### Example: Get the first file in the collection

Source: https://getkirby.com/docs/reference/objects/cms/file/files

Shows how to use `$file->files()` to access the parent collection and retrieve the first file. The example checks if a file exists and prints its title.

```php
if ($file = $page->files()->first()) {
    echo 'The first file in the collection is: ' . $file->title();
}
```

--------------------------------

### Access reserved field name with content()->get()

Source: https://getkirby.com/docs/reference/objects/page

To access a field with a reserved name, use the content()->get() method instead of the shorthand. The example uses 'inventory' as a reserved name.

```php
$page->content()->get('inventory')
```

--------------------------------

### Initialize Composer project

Source: https://getkirby.com/docs/cookbook/headless/headless-getting-started

Creates a new Composer project in the current folder. Run this command and supply the answers to generate the project structure.

```bash
composer init
```

--------------------------------

### Example: Creating a user with try-catch

Source: https://getkirby.com/docs/reference/objects/cms/users/create

Example of creating a user with name, email, password, language, role, and content. Wrapped in a try-catch to handle exceptions. The password is encrypted automatically.

```php
try {

  $user = $kirby->users()->create([
    'name'      => 'john',
    'email'     => 'john@doe.com',
    'password'  => 'secretpasswordwillbeencrypted',
    'language'  => 'en',
    'role'      => 'editor',
    'content'   => [
      'birthdate' => '1989-01-29'
    ]
  ]);

  echo 'The user "' . $user->name() . '" has been created';

} catch(Exception $e) {

  echo 'The user could not be created';
  // optional error message: $e->getMessage();

}
```

--------------------------------

### Usage example: echo $pagination->pages()

Source: https://getkirby.com/docs/reference/objects/cms/pagination/pages

Shows how to get the total number of pages from a paginated collection and output it. The example uses `$page->children()->paginate(10)` to create a pagination object.

```php
<?php

$subpages   = $page->children()->paginate(10);
$pagination = $subpages->pagination();

echo 'There are ' . $pagination->pages() . ' pages';

?>
```

--------------------------------

### File::create() example

Source: https://getkirby.com/docs/reference/objects/cms/file/create

Example of creating a new file using File::create(). It specifies the source path, parent page, filename, template, and content array.

```php
$file = File::create([
  'source'     => kirby()->root('assets').'/images/some-image.jpg',
  'parent'     => page('photography')->children()->listed()->first(),
  'filename'   => 'new-image.jpg',
  'template' => 'cover',
  'content'   => [
    'caption'   => 'A nice view from above',
  ]
]);
```

--------------------------------

### Get stored values with Kirby Form::toStoredValues()

Source: https://getkirby.com/docs/reference/objects/form/form

Shows how to get form values for storage using `toStoredValues()`. The method turns each value into a version that is made to be stored, for example in a text file.

```php
use Kirby\Form\Form;

$form = new Form(
    fields: [
        'name' => [
            'label' => 'Name',
            'type'  => 'text'
        ],
        'email' => [
            'label' => 'Email',
            'type'  => 'email'
        ],
        'message' => [
            'label' => 'Message',
            'type'  => 'textarea'
        ]
    ]
);

$form->submit([
    'name'  => 'Peter Griffin',
    'email' => 'mail@example.com',
]);

dump($form->toStoredValues());
```

--------------------------------

### Build Docker image from Dockerfile

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Builds an image named docker-starterkit from the Dockerfile in the current directory. The trailing dot provides the build context.

```bash
docker build -t docker-starterkit .
```

--------------------------------

### Inspect Docker image

Source: https://getkirby.com/docs/cookbook/development-deployment/kirby-meets-docker

Outputs detailed information about the 'docker-starterkit' image, including environment variables.

```bash
docker image inspect docker-starterkit
```

--------------------------------

### Override i18n:translations root in index.php

Source: https://getkirby.com/docs/reference/system/roots/i18n-translations

Custom setup to override the i18n:translations root by passing a custom roots setup to the Kirby constructor in index.php. The example sets the root to '/absolute/path/to/custom/root'.

```php
<?php

include 'kirby/bootstrap.php';

$kirby = new Kirby([
    'roots' => [
        'i18n:translations' => '/absolute/path/to/custom/root',
    ],
]);

echo $kirby->render();
```

--------------------------------

### Example: thumb() with format conversion to webp

Source: https://getkirby.com/docs/reference/objects/cms/file/thumb

Example of using `$file->thumb()` with the `format` option set to 'webp' to convert the image format.

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

--------------------------------

### API GET request example

Source: https://getkirby.com/docs/reference/objects/http/remote/request

Performs a GET request to the Kirby API with HTTP Basic auth. Requires HTTP Basic auth enabled and allowInsecure config for local testing without HTTPS.

```php
<?php
$email    = 'test@example.com';
$password = 'topsecret';

$response = Remote::request('https://yoursite.com/api/pages/notes', [
    'method' => 'GET',
    'headers' => [
        'Authorization: Basic ' . base64_encode($email . ':' . $password)
    ],
]);

if ($response->code() === 200) {
    $data = json_decode($response->content())->data;
    dump($data);
}
```

--------------------------------

### Text file example with user:// URI

Source: https://getkirby.com/docs/reference/templates/field-methods/to-user

Shows a text file with an Author field using a user:// URI.

```text
Title: My great article
----
Author: - user://hqq2mn9k
```
Tokens:
Raw