Reference

Text

Templates

Field methods

$field->escape()
$field->excerpt()
$field->exists()
$field->html()
$field->inline()
$field->isEmpty()
$field->isFalse()
$field->isNotEmpty()
$field->isTrue()
$field->isValid()
$field->key()
$field->kirbytags()
$field->kirbytext()
$field->kirbytextinline()
$field->length()
$field->lower()
$field->markdown()
$field->model()
$field->nl2br()
$field->or()
$field->parent()
$field->short()
$field->slug()
$field->smartypants()
$field->split()
$field->toArray()
$field->toBool()
$field->toData()
$field->toDate()
$field->toFile()
$field->toFiles()
$field->toFloat()
$field->toInt()
$field->toLink()
$field->toPage()
$field->toPages()
$field->toString()
$field->toStructure()
$field->toTimestamp()
$field->toUrl()
$field->toUser()
$field->toUsers()
$field->upper()
$field->value()
$field->widont()
$field->words()
$field->xml()
$field->yaml()

Helpers

asset()
attr()
collection()
csrf()
css()
deprecated()
dump()
e()
get()
gist()
go()
h()
html()
image()
invalid()
js()
kirby()
kirbytag()
kirbytags()
kirbytext()
kirbytextinline()
load()
markdown()
option()
page()
pages()
param()
params()
r()
site()
size()
smartypants()
snippet()
svg()
t()
tc()
tt()
twitter()
u()
url()
video()
vimeo()
widont()
youtube()

Panel

Objects

$asset

new Asset()
$asset->alt()
$asset->asset()
$asset->blur()
$asset->bw()
$asset->clone()
$asset->crop()
$asset->exists()
$asset->extension()
$asset->hardcopy()
$asset->html()
$asset->id()
$asset->isResizable()
$asset->isViewable()
$asset->kirby()
$asset->mediaHash()
$asset->mediaPath()
$asset->mediaRoot()
$asset->mediaUrl()
$asset->modified()
$asset->path()
$asset->quality()
$asset->resize()
$asset->root()
$asset->srcset()
$asset->thumb()
$asset->toArray()
$asset->type()
$asset->url()

$file

new File()
$file->blueprint()
$file->blur()
$file->bw()
$file->changeName()
$file->changeSort()
$file->clone()
$file->content()
$file->contentFiles()
$file->copy()
File::create()
$file->crop()
$file->decrement()
$file->delete()
$file->errors()
$file->exists()
$file->extension()
$file->filename()
$file->files()
$file->hardcopy()
$file->hasNext()
$file->hasPrev()
$file->html()
$file->id()
$file->increment()
$file->indexOf()
$file->is()
$file->isFirst()
$file->isLast()
$file->isLocked()
$file->isNth()
$file->isResizable()
$file->isValid()
$file->isViewable()
$file->kirby()
$file->lock()
$file->modified()
$file->next()
$file->nextAll()
$file->page()
$file->panelOptions()
$file->panelPickerData()
$file->parent()
$file->parents()
$file->permissions()
$file->prev()
$file->prevAll()
$file->publish()
$file->quality()
$file->replace()
$file->resize()
$file->root()
$file->siblings()
$file->site()
$file->srcset()
$file->template()
$file->templateSiblings()
$file->thumb()
$file->toArray()
$file->toString()
$file->translation()
$file->translations()
$file->type()
$file->unpublish()
$file->update()
$file->url()

$files

new Files()
$files->add()
$files->append()
$files->changeSort()
$files->chunk()
$files->clone()
$files->count()
$files->current()
$files->data()
$files->empty()
$files->extend()
Files::factory()
$files->filter()
$files->filterBy()
$files->find()
$files->findBy()
$files->findById()
$files->findByKey()
$files->first()
$files->flip()
$files->get()
$files->getAttribute()
$files->getIterator()
$files->group()
$files->groupBy()
$files->has()
$files->indexOf()
$files->intersection()
$files->intersects()
$files->isEmpty()
$files->isEven()
$files->isNotEmpty()
$files->isOdd()
$files->key()
$files->keyOf()
$files->keys()
$files->last()
$files->limit()
$files->map()
$files->next()
$files->not()
$files->nth()
$files->offset()
$files->paginate()
$files->pagination()
$files->parent()
$files->pluck()
$files->prepend()
$files->prev()
$files->query()
$files->remove()
$files->rewind()
$files->search()
$files->set()
$files->shuffle()
$files->slice()
Files::sortArgs()
$files->sortBy()
$files->template()
$files->toArray()
$files->toJson()
$files->toString()
$files->valid()
$files->values()
$files->when()
$files->without()

$kirby

new Kirby()
$kirby->blueprints()
$kirby->cache()
$kirby->call()
$kirby->clone()
$kirby->collection()
$kirby->collections()
$kirby->defaultLanguage()
$kirby->detectedLanguage()
$kirby->email()
$kirby->file()
$kirby->hardcopy()
$kirby->impersonate()
Kirby::instance()
$kirby->language()
$kirby->languages()
$kirby->locks()
$kirby->multilang()
$kirby->nonce()
$kirby->option()
$kirby->options()
$kirby->page()
$kirby->path()
Kirby::plugin()
$kirby->render()
$kirby->request()
$kirby->response()
$kirby->roles()
$kirby->root()
$kirby->roots()
$kirby->route()
$kirby->server()
$kirby->session()
$kirby->sessionHandler()
$kirby->site()
$kirby->system()
$kirby->thumb()
$kirby->translation()
$kirby->translations()
$kirby->url()
$kirby->urls()
$kirby->user()
$kirby->users()
Kirby::version()
Kirby::versionHash()
$kirby->visitor()

$language

new Language()
$language->baseUrl()
$language->clone()
$language->code()
$language->direction()
$language->exists()
$language->hardcopy()
$language->id()
$language->isDefault()
$language->kirby()
$language->locale()
$language->name()
$language->path()
$language->pattern()
$language->root()
$language->router()
$language->site()
$language->slugs()
$language->smartypants()
$language->toArray()
$language->translations()
$language->url()

$languages

new Languages()
$languages->add()
$languages->append()
$languages->chunk()
$languages->clone()
$languages->codes()
$languages->count()
$languages->current()
$languages->data()
$languages->default()
$languages->empty()
$languages->extend()
$languages->filter()
$languages->filterBy()
$languages->find()
$languages->findBy()
$languages->findByKey()
$languages->first()
$languages->flip()
$languages->get()
$languages->getAttribute()
$languages->getIterator()
$languages->group()
$languages->groupBy()
$languages->has()
$languages->indexOf()
$languages->intersection()
$languages->intersects()
$languages->isEmpty()
$languages->isEven()
$languages->isNotEmpty()
$languages->isOdd()
$languages->key()
$languages->keyOf()
$languages->keys()
$languages->last()
$languages->limit()
$languages->map()
$languages->next()
$languages->not()
$languages->nth()
$languages->offset()
$languages->paginate()
$languages->pagination()
$languages->parent()
$languages->pluck()
$languages->prepend()
$languages->prev()
$languages->query()
$languages->remove()
$languages->rewind()
$languages->search()
$languages->set()
$languages->shuffle()
$languages->slice()
Languages::sortArgs()
$languages->sortBy()
$languages->toArray()
$languages->toJson()
$languages->toString()
$languages->valid()
$languages->values()
$languages->when()
$languages->without()

$page

new Page()
$page->audio()
$page->blueprint()
$page->blueprints()
$page->changeNum()
$page->changeSlug()
$page->changeStatus()
$page->changeTemplate()
$page->changeTitle()
$page->children()
$page->childrenAndDrafts()
$page->clone()
$page->code()
$page->content()
$page->contentFiles()
$page->copy()
Page::create()
$page->createChild()
$page->createFile()
$page->createNum()
$page->decrement()
$page->delete()
$page->depth()
$page->dirname()
$page->diruri()
$page->documents()
$page->draft()
$page->drafts()
$page->duplicate()
$page->errors()
$page->exists()
$page->file()
$page->files()
$page->find()
$page->findPageOrDraft()
$page->grandChildren()
$page->hardcopy()
$page->hasAudio()
$page->hasChildren()
$page->hasCode()
$page->hasDocuments()
$page->hasDrafts()
$page->hasFiles()
$page->hasImages()
$page->hasListedChildren()
$page->hasNext()
$page->hasNextListed()
$page->hasNextUnlisted()
$page->hasPrev()
$page->hasPrevListed()
$page->hasPrevUnlisted()
$page->hasTemplate()
$page->hasUnlistedChildren()
$page->hasVideos()
$page->id()
$page->image()
$page->images()
$page->increment()
$page->index()
$page->indexOf()
$page->intendedTemplate()
$page->is()
$page->isActive()
$page->isAncestorOf()
$page->isCacheable()
$page->isChildOf()
$page->isDescendantOf()
$page->isDescendantOfActive()
$page->isDraft()
$page->isErrorPage()
$page->isFirst()
$page->isHomeOrErrorPage()
$page->isHomePage()
$page->isLast()
$page->isListed()
$page->isLocked()
$page->isNth()
$page->isOpen()
$page->isReadable()
$page->isSortable()
$page->isUnlisted()
$page->isValid()
$page->kirby()
$page->lock()
$page->modified()
$page->next()
$page->nextAll()
$page->nextListed()
$page->nextUnlisted()
$page->num()
$page->panelOptions()
$page->panelPickerData()
$page->parent()
$page->parents()
$page->permissions()
$page->prev()
$page->prevAll()
$page->prevListed()
$page->prevUnlisted()
$page->publish()
$page->purge()
$page->render()
$page->resortSiblingsAfterUnlisting()
$page->root()
$page->search()
$page->siblings()
$page->site()
$page->slug()
$page->sort()
$page->status()
$page->template()
$page->templateSiblings()
$page->title()
$page->toArray()
$page->toString()
$page->translation()
$page->translations()
$page->uid()
$page->unpublish()
$page->update()
$page->uri()
$page->url()
$page->videos()

$pages

new Pages()
$pages->add()
$pages->append()
$pages->audio()
$pages->children()
$pages->chunk()
$pages->clone()
$pages->code()
$pages->count()
$pages->current()
$pages->data()
$pages->documents()
$pages->drafts()
$pages->empty()
$pages->extend()
Pages::factory()
$pages->files()
$pages->filter()
$pages->filterBy()
$pages->find()
$pages->findBy()
$pages->findById()
$pages->findByIdRecursive()
$pages->findByKey()
$pages->findByUri()
$pages->findOpen()
$pages->first()
$pages->flip()
$pages->get()
$pages->getAttribute()
$pages->getIterator()
$pages->group()
$pages->groupBy()
$pages->has()
$pages->images()
$pages->index()
$pages->indexOf()
$pages->intersection()
$pages->intersects()
$pages->isEmpty()
$pages->isEven()
$pages->isNotEmpty()
$pages->isOdd()
$pages->key()
$pages->keyOf()
$pages->keys()
$pages->last()
$pages->limit()
$pages->listed()
$pages->map()
$pages->merge()
$pages->next()
$pages->not()
$pages->notTemplate()
$pages->nth()
$pages->nums()
$pages->offset()
$pages->paginate()
$pages->pagination()
$pages->parent()
$pages->pluck()
$pages->prepend()
$pages->prev()
$pages->published()
$pages->query()
$pages->remove()
$pages->rewind()
$pages->search()
$pages->set()
$pages->shuffle()
$pages->slice()
Pages::sortArgs()
$pages->sortBy()
$pages->template()
$pages->toArray()
$pages->toJson()
$pages->toString()
$pages->unlisted()
$pages->valid()
$pages->values()
$pages->videos()
$pages->when()
$pages->without()

$pagination

new Pagination()
$pagination->clone()
$pagination->end()
$pagination->firstPage()
$pagination->firstPageUrl()
Pagination::for()
$pagination->hardcopy()
$pagination->hasNextPage()
$pagination->hasPage()
$pagination->hasPages()
$pagination->hasPrevPage()
$pagination->isFirstPage()
$pagination->isLastPage()
$pagination->lastPage()
$pagination->lastPageUrl()
$pagination->nextPage()
$pagination->nextPageUrl()
$pagination->offset()
$pagination->pageUrl()
$pagination->pages()
$pagination->prevPage()
$pagination->prevPageUrl()
$pagination->range()
$pagination->rangeEnd()
$pagination->rangeStart()
$pagination->start()
$pagination->toArray()

$request

new Request()
$request->auth()
$request->body()
$request->cli()
$request->csrf()
$request->data()
$request->domain()
$request->file()
$request->files()
$request->get()
$request->header()
$request->headers()
$request->is()
$request->method()
$request->params()
$request->path()
$request->query()
$request->ssl()
$request->url()

$session

new Session()
$session->clear()
$session->decrement()
$session->get()
$session->increment()
$session->pull()
$session->reload()
$session->remove()
$session->set()

$user

new User()
$user->audio()
$user->avatar()
$user->blueprint()
$user->changeEmail()
$user->changeLanguage()
$user->changeName()
$user->changePassword()
$user->changeRole()
$user->clone()
$user->code()
$user->content()
$user->contentFiles()
User::create()
$user->createFile()
$user->createId()
$user->decrement()
$user->delete()
$user->documents()
$user->email()
$user->errors()
$user->exists()
$user->file()
$user->files()
$user->hardcopy()
$user->hasAudio()
$user->hasCode()
$user->hasDocuments()
$user->hasFiles()
$user->hasImages()
$user->hasNext()
$user->hasPrev()
$user->hasVideos()
$user->id()
$user->image()
$user->images()
$user->increment()
$user->indexOf()
$user->inventory()
$user->is()
$user->isAdmin()
$user->isFirst()
$user->isKirby()
$user->isLast()
$user->isLastAdmin()
$user->isLastUser()
$user->isLocked()
$user->isLoggedIn()
$user->isNth()
$user->isValid()
$user->kirby()
$user->language()
$user->lock()
$user->login()
$user->loginPasswordless()
$user->logout()
$user->modified()
$user->name()
$user->next()
$user->nextAll()
$user->panelOptions()
$user->panelPickerData()
$user->password()
$user->permissions()
$user->prev()
$user->prevAll()
$user->role()
$user->root()
$user->siblings()
$user->site()
$user->toArray()
$user->toString()
$user->translation()
$user->translations()
$user->update()
$user->username()
$user->validatePassword()
$user->videos()

$users

new Users()
$users->add()
$users->append()
$users->chunk()
$users->clone()
$users->count()
$users->create()
$users->current()
$users->data()
$users->empty()
$users->extend()
Users::factory()
$users->filter()
$users->filterBy()
$users->find()
$users->findBy()
$users->findByKey()
$users->first()
$users->flip()
$users->get()
$users->getAttribute()
$users->getIterator()
$users->group()
$users->groupBy()
$users->has()
$users->indexOf()
$users->intersection()
$users->intersects()
$users->isEmpty()
$users->isEven()
$users->isNotEmpty()
$users->isOdd()
$users->key()
$users->keyOf()
$users->keys()
$users->last()
$users->limit()
Users::load()
$users->map()
$users->next()
$users->not()
$users->nth()
$users->offset()
$users->paginate()
$users->pagination()
$users->parent()
$users->pluck()
$users->prepend()
$users->prev()
$users->query()
$users->remove()
$users->rewind()
$users->role()
$users->search()
$users->set()
$users->shuffle()
$users->slice()
Users::sortArgs()
$users->sortBy()
$users->toArray()
$users->toJson()
$users->toString()
$users->valid()
$users->values()
$users->when()
$users->without()

Router

Patterns

(:all)
(:alpha)
(:alphanum)
(:any)
(:num)

Response types

Array
Empty
Exception
Page
Response
String

System

Options

api
auth
cache
content
date
debug
email
error
fatal
home
hooks
kirbytext
languages
locale
markdown
panel
ready
routes
session
slugs
smartypants
thumbs
url
whoops

Urls

$kirby->url('assets')
$kirby->url('index')
$kirby->url('media')

Roots

$kirby->root('accounts')
$kirby->root('assets')
$kirby->root('blueprints')
$kirby->root('cache')
$kirby->root('collections')
$kirby->root('config')
$kirby->root('content')
$kirby->root('controllers')
$kirby->root('index')
$kirby->root('kirby')
$kirby->root('media')
$kirby->root('models')
$kirby->root('plugins')
$kirby->root('roles')
$kirby->root('sessions')
$kirby->root('site')
$kirby->root('snippets')
$kirby->root('templates')

Validators

V::accepted()
V::alpha()
V::alphanum()
V::between()
V::contains()
V::date()
V::denied()
V::different()
V::email()
V::endsWith()
V::filename()
V::in()
V::integer()
V::ip()
V::less()
V::match()
V::max()
V::maxLength()
V::maxWords()
V::min()
V::minLength()
V::minWords()
V::more()
V::notContains()
V::notIn()
V::num()
V::required()
V::same()
V::size()
V::startsWith()
V::time()
V::url()

Plugins

Extensions

API
Blueprints
Cache driver
Collection filters
Collections
Controllers
Core components
Panel Created
Field methods
Field previews
Fields
File methods
Files methods
Hooks
KirbyTags
Options
Page methods
Page models
Pages
Pages methods
Panel login
Panel views
Routes
Sections
Site methods
Snippets
Templates
Translations
User methods
User models
Users methods
Validators

Hooks

file.changeName:after
file.changeName:before
file.changeSort:after
file.changeSort:before
file.create:after
file.create:before
file.delete:after
file.delete:before
file.replace:after
file.replace:before
file.update:after
file.update:before
kirbytags:after
kirbytags:before
kirbytext:after
kirbytext:before
page.changeNum:after
page.changeNum:before
page.changeSlug:after
page.changeSlug:before
page.changeStatus:after
page.changeStatus:before
page.changeTemplate:after
page.changeTemplate:before
page.changeTitle:after
page.changeTitle:before
page.create:after
page.create:before
page.delete:after
page.delete:before
page.duplicate:after
page.duplicate:before
page.update:after
page.update:before
route:after
route:before
site.update:after
site.update:before
system.loadPlugins:after
user.changeEmail:after
user.changeEmail:before
user.changeLanguage:after
user.changeLanguage:before
user.changeName:after
user.changeName:before
user.changePassword:after
user.changePassword:before
user.changeRole:after
user.changeRole:before
user.create:after
user.create:before
user.delete:after
user.delete:before
user.login:after
user.login:before
user.logout:after
user.logout:before
user.update:after
user.update:before

Core components

CSS URLs
Dumper
File URLs
File versions
JavaScript URLs
Markdown parser
SmartyPants parser
Snippets
Templates
Thumbs
URLs

UI Kit

Autocomplete
Bar
Box
Button
ButtonGroup
Calendar
Card
Cards
Checkbox Input
Checkboxes Field
Checkboxes Input
Collection
Column
Counter
Date Field
Date Input
DateTime Input
Dialogs
Draggable
Dropdown
Dropzone
Email Field
Email Input
Empty
Fieldset
Files Field
Form
Grid
Header
Headline
Headline Field
Icon
Image
Info Field
Line Field
Link
List
List Item
Number Field
Number Input
Pagination
Password Input
Progress
Radio Field
Radio Input
Range Field
Range Input
Select Field
Select Input
Structure Field
Tag
Tags Field
Tags Input
Tel Field
Tel Input
Text
Text Field
Text Input
Textarea Field
Textarea Input
Time Field
Time Input
Toggle Field
Toggle Input
Upload
Url Field
Url Input
View

Panel internals

Helpers
Libraries
Store: content

API

Authentication

/api/auth/login POST
/api/auth/logout POST
/api/auth GET

Languages

/api/languages POST
/api/languages/:code DELETE
/api/languages/:code GET
/api/languages GET
/api/languages/:code PATCH

Roles

/api/roles/:id GET
/api/roles GET

System

/api/system GET
/api/system/install POST
/api/system/register POST

Translations

/api/translations/:code GET
/api/translations GET

Users

/api/users/:id/email PATCH
/api/users/:id/language PATCH
/api/users/:id/name PATCH
/api/users/:id/password PATCH
/api/users/:id/role PATCH
/api/users/ POST
/api/users/:id DELETE
/api/users/:id/files/:filename/name PATCH
/api/users/:id/files POST
/api/users/:id/files/:filename DELETE
/api/users/:id/files/:filename GET
/api/users/:id/files GET
/api/users/:id/files/search GET|POST
/api/users/:id/files/:filename/sections/:name GET
/api/users/:id/files/sort PATCH
/api/users/:id/files/:filename PATCH
/api/users/:id GET
/api/users GET
/api/users/:id/search GET|POST
/api/users/:id/sections/:name GET
/api/users/:id PATCH

Tools

A

A::append()
A::average()
A::extend()
A::fill()
A::first()
A::get()
A::isAssociative()
A::join()
A::last()
A::merge()
A::missing()
A::move()
A::pluck()
A::prepend()
A::shuffle()
A::sort()
A::update()
A::wrap()

Cookie::exists()
Cookie::forever()
Cookie::get()
Cookie::lifetime()
Cookie::remove()
Cookie::set()

Data

Data::decode()
Data::encode()
Data::handler()
Data::read()
Data::write()

Dir

Dir::copy()
Dir::dirs()
Dir::files()
Dir::index()
Dir::isEmpty()
Dir::isReadable()
Dir::isWritable()
Dir::link()
Dir::make()
Dir::modified()
Dir::move()
Dir::niceSize()
Dir::read()
Dir::remove()
Dir::size()
Dir::wasModifiedAfter()

Escape

Escape::attr()
Escape::css()
Escape::html()
Escape::js()
Escape::url()
Escape::xml()

F

F::append()
F::base64()
F::copy()
F::dirname()
F::exists()
F::extension()
F::extensionToMime()
F::extensionToType()
F::extensions()
F::filename()
F::invalidateOpcodeCache()
F::is()
F::isReadable()
F::isWritable()
F::link()
F::load()
F::mime()
F::mimeToExtension()
F::mimeToType()
F::modified()
F::move()
F::name()
F::niceSize()
F::read()
F::realpath()
F::relativepath()
F::remove()
F::rename()
F::safeName()
F::similar()
F::size()
F::type()
F::unzip()
F::uri()
F::write()

Header::accepted()
Header::contentType()
Header::create()
Header::created()
Header::download()
Header::error()
Header::forbidden()
Header::gone()
Header::missing()
Header::notfound()
Header::panic()
Header::redirect()
Header::status()
Header::success()
Header::type()
Header::unavailable()

Html

Html::a()
Html::attr()
Html::breaks()
Html::decode()
Html::email()
Html::encode()
Html::entities()
Html::figure()
Html::gist()
Html::iframe()
Html::img()
Html::isVoid()
Html::link()
Html::rel()
Html::tag()
Html::tel()
Html::video()
Html::vimeo()
Html::youtube()

I18n

I18n::fallback()
I18n::form()
I18n::locale()
I18n::template()
I18n::translate()
I18n::translateCount()
I18n::translation()
I18n::translations()

Mime

Mime::fix()
Mime::fromExtension()
Mime::fromFileInfo()
Mime::fromMimeContentType()
Mime::fromSvg()
Mime::isAccepted()
Mime::matches()
Mime::toExtension()
Mime::toExtensions()
Mime::type()
Mime::types()

$query

new Query()
$query->result()

Server

Server::address()
Server::cli()
Server::get()
Server::host()
Server::https()
Server::port()
Server::sanitize()

Str

Str::accepted()
Str::after()
Str::ascii()
Str::before()
Str::between()
Str::contains()
Str::convert()
Str::encode()
Str::encoding()
Str::endsWith()
Str::excerpt()
Str::float()
Str::from()
Str::isURL()
Str::kebab()
Str::length()
Str::lower()
Str::ltrim()
Str::pool()
Str::position()
Str::query()
Str::random()
Str::replace()
Str::replaceReplacements()
Str::replacements()
Str::rtrim()
Str::short()
Str::slug()
Str::snake()
Str::split()
Str::startsWith()
Str::substr()
Str::template()
Str::toBytes()
Str::toType()
Str::trim()
Str::ucfirst()
Str::ucwords()
Str::unhtml()
Str::until()
Str::upper()
Str::widont()

Tpl

Tpl::load()

Url

Url::build()
Url::current()
Url::currentDir()
Url::fix()
Url::home()
Url::index()
Url::isAbsolute()
Url::last()
Url::makeAbsolute()
Url::path()
Url::query()
Url::short()
Url::stripFragment()
Url::stripPath()
Url::stripQuery()
Url::to()
Url::toObject()
Url::toTemplateAsset()

V

V::errors()
V::input()
V::message()
V::validators()
V::value()

Xml

Xml::create()
Xml::decode()
Xml::encode()
Xml::entities()
Xml::parse()
Xml::tag()
Xml::value()

Text

Templates

Panel

Objects

Router

System

Plugins

API

Tools

Advanced