Reference

The Reference provides a quick but detailed reference to pretty much any aspect of Kirby.

Text

KirbyText

(date: …)
(email: …)
(file: …)
(gist: …)
(image: …)
(link: …)
(tel: …)
(twitter: …)
(video: …)

Markdown

Bold text
Line breaks & paragraphs
Code blocks
Email addresses
Headlines
Horizontal rules
Italic text
Links
Lists
Quotes

Templates

Field methods

$field->callback()
$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->query()
$field->replace()
$field->short()
$field->slug()
$field->smartypants()
$field->split()
$field->toArray()
$field->toBlocks()
$field->toBool()
$field->toData()
$field->toDate()
$field->toFile()
$field->toFiles()
$field->toFloat()
$field->toInt()
$field->toLayouts()
$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()
esc()
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

$kirby

new Kirby()
$kirby->api()
$kirby->apply()
$kirby->auth()
$kirby->blueprints()
$kirby->cache()
$kirby->call()
$kirby->clone()
$kirby->collection()
$kirby->collections()
$kirby->component()
$kirby->contentExtension()
$kirby->contentIgnore()
$kirby->contentToken()
$kirby->controller()
$kirby->defaultLanguage()
Kirby::destroy()
$kirby->detectedLanguage()
$kirby->email()
$kirby->extend()
$kirby->extension()
$kirby->extensions()
$kirby->file()
$kirby->hardcopy()
$kirby->impersonate()
Kirby::instance()
$kirby->io()
$kirby->kirbytag()
$kirby->kirbytags()
$kirby->kirbytext()
$kirby->language()
$kirby->languageCode()
$kirby->languages()
$kirby->locks()
$kirby->markdown()
$kirby->multilang()
$kirby->nativeComponent()
$kirby->nonce()
$kirby->option()
$kirby->options()
$kirby->page()
$kirby->panelLanguage()
$kirby->path()
Kirby::plugin()
$kirby->plugins()
$kirby->render()
$kirby->request()
$kirby->resolve()
$kirby->response()
$kirby->roles()
$kirby->root()
$kirby->roots()
$kirby->route()
$kirby->router()
$kirby->routes()
$kirby->server()
$kirby->session()
$kirby->sessionHandler()
$kirby->setCurrentLanguage()
$kirby->setCurrentTranslation()
$kirby->setLocale()
$kirby->site()
$kirby->smartypants()
$kirby->snippet()
$kirby->system()
$kirby->template()
$kirby->thumb()
$kirby->translation()
$kirby->translations()
$kirby->trigger()
$kirby->url()
$kirby->urls()
$kirby->user()
$kirby->users()
Kirby::version()
Kirby::versionHash()
$kirby->visitor()

$page

new Page()
$page->apiUrl()
$page->audio()
$page->blueprint()
$page->blueprints()
$page->callMethod()
$page->changeNum()
$page->changeSlug()
$page->changeSort()
$page->changeStatus()
$page->changeTemplate()
$page->changeTitle()
$page->children()
$page->childrenAndDrafts()
$page->clone()
$page->code()
$page->content()
$page->contentFile()
$page->contentFileData()
$page->contentFileDirectory()
$page->contentFileExtension()
$page->contentFileName()
$page->contentFiles()
$page->controller()
$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->dragText()
$page->dragTextFromCallback()
$page->dragTextType()
$page->duplicate()
$page->errors()
$page->exists()
Page::factory()
$page->file()
$page->files()
$page->find()
$page->findPageOrDraft()
$page->go()
$page->grandChildren()
$page->hardcopy()
$page->hasAudio()
$page->hasChildren()
$page->hasCode()
$page->hasDocuments()
$page->hasDrafts()
$page->hasFiles()
$page->hasImages()
$page->hasListedChildren()
$page->hasMethod()
$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->inventory()
$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->isPublished()
$page->isReadable()
$page->isSortable()
$page->isUnlisted()
$page->isValid()
$page->isVerified()
$page->kirby()
$page->lock()
$page->mediaRoot()
$page->mediaUrl()
Page::model()
$page->modified()
$page->next()
$page->nextAll()
$page->nextListed()
$page->nextUnlisted()
$page->num()
$page->panelIcon()
$page->panelId()
$page->panelImage()
$page->panelOptions()
$page->panelPath()
$page->panelPickerData()
$page->panelUrl()
$page->parent()
$page->parentId()
$page->parentModel()
$page->parents()
$page->permissions()
$page->prev()
$page->prevAll()
$page->prevListed()
$page->prevUnlisted()
$page->previewUrl()
$page->publish()
$page->purge()
$page->query()
$page->readContent()
$page->render()
$page->representation()
$page->resortSiblingsAfterUnlisting()
$page->root()
$page->save()
$page->search()
$page->setSite()
$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->urlForLanguage()
$page->videos()
$page->writeContent()

$pages

new Pages()
$pages->add()
$pages->append()
$pages->audio()
$pages->callMethod()
$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->hasMethod()
$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->sort()
Pages::sortArgs()
$pages->sortBy()
$pages->template()
$pages->toArray()
$pages->toJson()
$pages->toString()
$pages->unlisted()
$pages->valid()
$pages->values()
$pages->videos()
$pages->when()
$pages->without()

$file

new File()
$file->apiUrl()
$file->asset()
$image->base64()
$file->blueprint()
$file->blueprints()
$file->blur()
$file->bw()
$file->callMethod()
$file->changeName()
$file->changeSort()
$file->clone()
$file->content()
$file->contentFile()
$file->contentFileData()
$file->contentFileDirectory()
$file->contentFileExtension()
$file->contentFileName()
$file->contentFiles()
$file->copy()
File::create()
$file->crop()
$image->dataUri()
$file->decrement()
$file->delete()
$image->dimensions()
$image->download()
$file->dragText()
$file->dragTextFromCallback()
$file->dragTextType()
$file->errors()
$image->exif()
$file->exists()
$file->extension()
File::factory()
$file->filename()
$file->files()
$file->grayscale()
$file->greyscale()
$file->hardcopy()
$file->hasMethod()
$file->hasNext()
$file->hasPrev()
$image->hash()
$image->header()
$image->height()
$file->html()
$file->id()
$image->imagesize()
$file->increment()
$file->indexOf()
$file->is()
$file->isFirst()
$image->isLandscape()
$file->isLast()
$file->isLocked()
$file->isNth()
$image->isPortrait()
$file->isReadable()
$file->isResizable()
$image->isSquare()
$file->isValid()
$file->isViewable()
$image->isWritable()
$file->kirby()
$file->lock()
$image->match()
$file->mediaHash()
$file->mediaRoot()
$file->mediaToken()
$file->mediaUrl()
$image->mime()
$file->modified()
$image->move()
$image->name()
$file->next()
$file->nextAll()
$image->niceSize()
$image->orientation()
$file->page()
$file->panelIcon()
$file->panelImage()
$file->panelOptions()
$file->panelPath()
$file->panelPickerData()
$file->panelUrl()
$file->parent()
$file->parentId()
$file->parents()
$file->permissions()
$file->prev()
$file->prevAll()
$file->publish()
$file->quality()
$file->query()
$image->ratio()
$image->read()
$file->readContent()
$image->realpath()
$image->rename()
$file->replace()
$file->resize()
$file->root()
$file->save()
$file->setSite()
$file->siblings()
$file->site()
$image->size()
$file->srcset()
$file->template()
$file->templateSiblings()
$file->thumb()
$file->toArray()
$image->toJson()
$file->toString()
$file->translation()
$file->translations()
$file->type()
$file->unpublish()
$file->update()
$file->url()
$image->validateContents()
$image->width()
$image->write()
$file->writeContent()

$files

new Files()
$files->add()
$files->append()
$files->callMethod()
$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->hasMethod()
$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->sort()
Files::sortArgs()
$files->sortBy()
$files->template()
$files->toArray()
$files->toJson()
$files->toString()
$files->valid()
$files->values()
$files->when()
$files->without()

$user

new User()
$user->apiUrl()
$user->audio()
$user->avatar()
$user->blueprint()
$user->blueprints()
$user->callMethod()
$user->changeEmail()
$user->changeLanguage()
$user->changeName()
$user->changePassword()
$user->changeRole()
$user->clone()
$user->code()
$user->content()
$user->contentFile()
$user->contentFileData()
$user->contentFileDirectory()
$user->contentFileExtension()
$user->contentFileName()
$user->contentFiles()
User::create()
$user->createFile()
$user->createId()
$user->decrement()
$user->delete()
$user->documents()
$user->dragTextFromCallback()
$user->dragTextType()
$user->email()
$user->errors()
$user->exists()
User::factory()
$user->file()
$user->files()
$user->hardcopy()
$user->hasAudio()
$user->hasCode()
$user->hasDocuments()
$user->hasFiles()
$user->hasImages()
$user->hasMethod()
$user->hasNext()
$user->hasPrev()
$user->hasVideos()
User::hashPassword()
$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->isNobody()
$user->isNth()
$user->isValid()
$user->kirby()
$user->language()
$user->lock()
$user->login()
$user->loginPasswordless()
$user->logout()
$user->mediaRoot()
$user->mediaUrl()
User::model()
$user->modified()
$user->name()
$user->nameOrEmail()
$user->next()
$user->nextAll()
User::nobody()
$user->panelIcon()
$user->panelImage()
$user->panelOptions()
$user->panelPath()
$user->panelPickerData()
$user->panelUrl()
$user->password()
$user->permissions()
$user->prev()
$user->prevAll()
$user->query()
$user->readContent()
$user->role()
$user->roles()
$user->root()
$user->save()
$user->setSite()
$user->siblings()
$user->site()
$user->toArray()
$user->toString()
$user->translation()
$user->translations()
$user->update()
$user->username()
$user->validatePassword()
$user->videos()
$user->writeContent()

$users

new Users()
$users->add()
$users->append()
$users->callMethod()
$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->hasMethod()
$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->sort()
Users::sortArgs()
$users->sortBy()
$users->toArray()
$users->toJson()
$users->toString()
$users->valid()
$users->values()
$users->when()
$users->without()

OvI

$blocks

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

$layouts

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

$language

new Language()
$language->baseUrl()
$language->clone()
$language->code()
Language::create()
$language->delete()
$language->direction()
$language->exists()
$language->hardcopy()
$language->id()
$language->isDefault()
$language->kirby()
Language::loadRules()
$language->locale()
$language->name()
$language->path()
$language->pattern()
$language->root()
$language->router()
$language->rules()
$language->save()
$language->setSite()
$language->site()
$language->slugs()
$language->smartypants()
$language->toArray()
$language->translations()
$language->update()
$language->url()

$languages

new Languages()
$languages->add()
$languages->append()
$languages->callMethod()
$languages->chunk()
$languages->clone()
$languages->codes()
$languages->count()
$languages->create()
$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->hasMethod()
$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::load()
$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->sort()
Languages::sortArgs()
$languages->sortBy()
$languages->toArray()
$languages->toJson()
$languages->toString()
$languages->valid()
$languages->values()
$languages->when()
$languages->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->limit()
$pagination->nextPage()
$pagination->nextPageUrl()
$pagination->offset()
$pagination->page()
$pagination->pageUrl()
$pagination->pages()
$pagination->prevPage()
$pagination->prevPageUrl()
$pagination->range()
$pagination->rangeEnd()
$pagination->rangeStart()
$pagination->start()
$pagination->toArray()
$pagination->total()

$request

new Request()
$request->auth()
$request->body()
$request->cli()
$request->csrf()
$request->data()
$request->detectRequestMethod()
$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()

1NF

All classes

Aliases

Asset
Collection
Dir
Field
File
Files
Html
Kirby
Page
Pages
Pagination
R
Response
S
Site
Structure
Url
User
Users
Visitor
Data
Json
Yaml
Database
Db
Errorpageexception
Cookie
Header
Remote
Server
Dimensions
A
C
Config
Escape
F
I18n
Mime
Obj
Str
Tpl
V
Xml

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
remote
routes
servers
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('logs')
$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

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

Plugins

Extensions

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

Hooks

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

Core components

CSS URLs
Dumper
File URLs
File versions
JavaScript URLs
Markdown parser
Search
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
Store: notification
Uploads

API

Authentication

/api/auth/login
/api/auth/logout
/api/auth

Languages

/api/languages
/api/languages
/api/languages/:code
/api/languages/:code
/api/languages/:code

Roles

/api/roles
/api/roles/:id

System

/api/system
/api/system/install
/api/system/register

Translations

/api/translations
/api/translations/:code

Users

/api/users
/api/users/
/api/users/:id
/api/users/:id/search
/api/users/:id
/api/users/:id
/api/users/:id/email
/api/users/:id/files
/api/users/:id/files
/api/users/:id/files/search
/api/users/:id/files/sort
/api/users/:id/files/:filename
/api/users/:id/files/:filename
/api/users/:id/files/:filename
/api/users/:id/files/:filename/name
/api/users/:id/files/:filename/sections/:name
/api/users/:id/language
/api/users/:id/name
/api/users/:id/password
/api/users/:id/role
/api/users/:id/sections/:name

Tools

A

A::append()
A::apply()
A::average()
A::extend()
A::fill()
A::first()
A::get()
A::isAssociative()
A::join()
A::last()
A::merge()
A::missing()
A::move()
A::nest()
A::nestByKeys()
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::exists()
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::loadOnce()
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::typeToExtensions()
F::unzip()
F::uri()
F::write()

Header

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::create()
Html::decode()
Html::email()
Html::encode()
Html::entities()
Html::figure()
Html::gist()
Html::iframe()
Html::img()
Html::isVoid()
Html::link()
Html::parse()
Html::rel()
Html::simplify()
Html::tag()
Html::tel()
Html::value()
Html::video()
Html::vimeo()
Html::youtube()

I18n

I18n::fallback()
I18n::fallbacks()
I18n::form()
I18n::formatNumber()
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::similarity()
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::attr()
Xml::create()
Xml::decode()
Xml::encode()
Xml::entities()
Xml::parse()
Xml::simplify()
Xml::tag()
Xml::value()

Text

KirbyText

(date: …)

(email: …)

(file: …)

(gist: …)

(image: …)

(link: …)

(tel: …)

(twitter: …)

(video: …)

Markdown

Bold text

Line breaks & paragraphs

Code blocks

Email addresses

Headlines

Horizontal rules

Italic text

Links

Lists

Quotes

Templates

Field methods

$field->callback()

$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->query()

$field->replace()

$field->short()

$field->slug()

$field->smartypants()

$field->split()

$field->toArray()

$field->toBlocks()

$field->toBool()

$field->toData()

$field->toDate()

$field->toFile()

$field->toFiles()

$field->toFloat()

$field->toInt()

$field->toLayouts()

$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()