Reference
The Reference provides a quick but detailed reference to pretty much any aspect of Kirby.
Formatting text
KirbyText
Markdown
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->permalinksToUrls()
- $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->toObject()
- $field->toPage()
- $field->toPages()
- $field->toQrCode()
- $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()
- qr()
- r()
- router()
- site()
- size()
- smartypants()
- snippet()
- svg()
- t()
- tc()
- tt()
- u()
- url()
- video()
- vimeo()
- widont()
- youtube()
Panel
Blueprints
Fields
Sections
Blocks
Icons
- account
- add
- alert
- anchor
- angle-down
- angle-left
- angle-right
- angle-up
- archive
- attachment
- audio
- badge
- bars
- bell
- blank
- bold
- bolt
- book
- bookmark
- box
- brush
- bug
- calendar
- cancel
- cancel-small
- car
- cart
- chart
- chat
- check
- checklist
- circle
- circle-filled
- circle-half
- circle-nested
- circle-outline
- clear
- clock
- code
- cog
- collapse
- copy
- credit-card
- crop
- dashboard
- discord
- discount
- display
- divider
- document
- dots
- download
- draft
- edit
- edit-line
- expand
- file
- file-audio
- file-code
- file-document
- file-image
- file-spreadsheet
- file-text
- file-video
- file-word
- file-zip
- filter
- flag
- folder
- folder-structure
- food
- funnel
- github
- globe
- grid
- grid-bottom
- grid-bottom-left
- grid-bottom-right
- grid-full
- grid-left
- grid-right
- grid-top
- grid-top-left
- grid-top-right
- h1
- h2
- h3
- h4
- h5
- h6
- headline
- heart
- heart-filled
- heart-outline
- hidden
- home
- image
- images
- import
- info
- italic
- key
- lab
- layers
- list-bullet
- list-numbers
- live
- loader
- lock
- logout
- map
- markdown
- mastodon
- megaphone
- menu
- merge
- mobile
- money
- moon
- open
- order-alpha-asc
- order-alpha-desc
- order-num-asc
- order-num-desc
- page
- palette
- paragraph
- parent
- paypal
- pen
- phone
- pin
- pipette
- plane
- play
- plus
- preview
- protected
- qr-code
- question
- quote
- refresh
- remove
- search
- server
- settings
- share
- shuffle
- sitemap
- smile
- sort
- sparkling
- split
- star
- star-filled
- star-outline
- status-draft
- status-listed
- status-unlisted
- store
- strikethrough
- subscript
- sun
- superscript
- table
- tablet
- tag
- template
- text
- text-bottom
- text-center
- text-justify
- text-left
- text-middle
- text-right
- text-top
- ticket
- tiktok
- title
- toggle-off
- toggle-on
- translate
- trash
- underline
- undo
- unlock
- upload
- url
- user
- users
- video
- vimeo
- wand
- wheelchair
- youtube
Styling
Samples
Objects
$kirby
- new Kirby()
- $kirby->apply()
- $kirby->blueprints()
- $kirby->cache()
- $kirby->call()
- $kirby->clone()
- $kirby->collection()
- $kirby->collections()
- $kirby->contentToken()
- $kirby->controller()
- $kirby->core()
- $kirby->csrf()
- $kirby->currentLanguage()
- $kirby->defaultLanguage()
- $kirby->detectedLanguage()
- $kirby->email()
- $kirby->environment()
- $kirby->file()
- $kirby->image()
- $kirby->impersonate()
- Kirby::instance()
- $kirby->isNativeComponent()
- $kirby->language()
- $kirby->languages()
- $kirby->load()
- $kirby->locks()
- $kirby->models()
- $kirby->multilang()
- $kirby->nativeComponent()
- $kirby->nonce()
- $kirby->option()
- $kirby->options()
- $kirby->page()
- $kirby->panelLanguage()
- $kirby->path()
- Kirby::plugin()
- $kirby->render()
- $kirby->request()
- $kirby->response()
- $kirby->roles()
- $kirby->root()
- $kirby->roots()
- $kirby->route()
- $kirby->session()
- $kirby->sessionHandler()
- $kirby->site()
- $kirby->snippet()
- $kirby->system()
- $kirby->thumb()
- $kirby->translation()
- $kirby->translations()
- $kirby->trigger()
- $kirby->url()
- $kirby->urls()
- $kirby->user()
- $kirby->users()
- Kirby::version()
- Kirby::versionHash()
- $kirby->visitor()
$site
- new Site()
- $site->audio()
- $site->blueprint()
- $site->blueprints()
- $site->breadcrumb()
- $site->changeTitle()
- $site->children()
- $site->childrenAndDrafts()
- $site->clone()
- $site->code()
- $site->content()
- $site->contentFiles()
- $site->createChild()
- $site->createFile()
- $site->decrement()
- $site->documents()
- $site->draft()
- $site->drafts()
- $site->errorPage()
- $site->errors()
- $site->exists()
- $site->file()
- $site->files()
- $site->find()
- $site->findPageOrDraft()
- $site->grandChildren()
- $site->hardcopy()
- $site->hasAudio()
- $site->hasChildren()
- $site->hasCode()
- $site->hasDocuments()
- $site->hasDrafts()
- $site->hasFiles()
- $site->hasImages()
- $site->hasListedChildren()
- $site->hasUnlistedChildren()
- $site->hasVideos()
- $site->homePage()
- $site->id()
- $site->image()
- $site->images()
- $site->increment()
- $site->index()
- $site->is()
- $site->isLocked()
- $site->isValid()
- $site->kirby()
- $site->lock()
- $site->modified()
- $site->page()
- $site->pages()
- $site->panel()
- $site->permissions()
- $site->purge()
- $site->root()
- $site->search()
- $site->site()
- $site->toArray()
- $site->toSafeString()
- $site->toString()
- $site->translation()
- $site->translations()
- $site->update()
- $site->url()
- $site->uuid()
- $site->videos()
- $site->wasModifiedAfter()
$page
- new Page()
- $page->audio()
- $page->blueprint()
- $page->blueprints()
- $page->changeNum()
- $page->changeSlug()
- $page->changeSort()
- $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->go()
- $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->isAccessible()
- $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->isListable()
- $page->isListed()
- $page->isLocked()
- $page->isMovableTo()
- $page->isNth()
- $page->isOpen()
- $page->isPublished()
- $page->isReadable()
- $page->isSortable()
- $page->isUnlisted()
- $page->isValid()
- $page->kirby()
- $page->lock()
- $page->modified()
- $page->move()
- $page->next()
- $page->nextAll()
- $page->nextListed()
- $page->nextUnlisted()
- $page->num()
- $page->panel()
- $page->parent()
- $page->parents()
- $page->permalink()
- $page->permissions()
- $page->prev()
- $page->prevAll()
- $page->prevListed()
- $page->prevUnlisted()
- $page->publish()
- $page->purge()
- $page->render()
- $page->root()
- $page->search()
- $page->siblings()
- $page->site()
- $page->slug()
- $page->status()
- $page->template()
- $page->templateSiblings()
- $page->title()
- $page->toArray()
- $page->toSafeString()
- $page->toString()
- $page->translation()
- $page->translations()
- $page->uid()
- $page->unpublish()
- $page->update()
- $page->uri()
- $page->url()
- $page->uuid()
- $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->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->random()
- $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->asset()
- $file->base64()
- $file->blueprint()
- $file->blueprints()
- $file->blur()
- $file->bw()
- $file->changeName()
- $file->changeSort()
- $file->changeTemplate()
- $file->clone()
- $file->content()
- $file->contentFiles()
- $file->copy()
- File::create()
- $file->crop()
- $file->dataUri()
- $file->decrement()
- $file->delete()
- $image->dimensions()
- $file->download()
- $file->errors()
- $image->exif()
- $file->exists()
- $file->extension()
- $file->filename()
- $file->files()
- $file->grayscale()
- $file->greyscale()
- $file->hardcopy()
- $file->hasNext()
- $file->hasPrev()
- $file->hash()
- $file->header()
- $image->height()
- $file->html()
- $file->id()
- $image->imagesize()
- $file->increment()
- $file->indexOf()
- $file->is()
- $file->isAccessible()
- $file->isFirst()
- $image->isLandscape()
- $file->isLast()
- $file->isListable()
- $file->isLocked()
- $file->isNth()
- $image->isPortrait()
- $file->isReadable()
- $file->isResizable()
- $image->isSquare()
- $file->isValid()
- $file->isViewable()
- $file->isWritable()
- $file->kirby()
- $file->lock()
- $file->manipulate()
- $file->match()
- $file->mime()
- $file->model()
- $file->modified()
- $file->move()
- $file->name()
- $file->next()
- $file->nextAll()
- $file->niceSize()
- $image->orientation()
- $file->page()
- $file->panel()
- $file->parent()
- $file->parents()
- $file->permalink()
- $file->permissions()
- $file->prev()
- $file->prevAll()
- $file->previewUrl()
- $file->publish()
- $file->purge()
- $file->quality()
- $image->ratio()
- $file->read()
- $file->realpath()
- $file->rename()
- $file->replace()
- $file->resize()
- $file->root()
- $file->sanitizeContents()
- $file->sha1()
- $file->sharpen()
- $file->siblings()
- $file->site()
- $file->size()
- $file->srcset()
- $file->template()
- $file->templateSiblings()
- $file->thumb()
- $file->toArray()
- $file->toJson()
- $file->toSafeString()
- $file->toString()
- $file->translation()
- $file->translations()
- $file->type()
- $file->unpublish()
- $file->update()
- $file->url()
- $file->uuid()
- $file->validateContents()
- $image->width()
- $file->write()
$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->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->niceSize()
- $files->not()
- $files->nth()
- $files->offset()
- $files->paginate()
- $files->pagination()
- $files->parent()
- $files->pluck()
- $files->prepend()
- $files->prev()
- $files->query()
- $files->random()
- $files->remove()
- $files->rewind()
- $files->search()
- $files->set()
- $files->shuffle()
- $files->size()
- $files->slice()
- $files->sort()
- Files::sortArgs()
- $files->sortBy()
- $files->sorted()
- $files->template()
- $files->toArray()
- $files->toJson()
- $files->toString()
- $files->valid()
- $files->values()
- $files->when()
- $files->without()
$user
- new User()
- $user->audio()
- $user->avatar()
- $user->blueprint()
- $user->blueprints()
- $user->changeEmail()
- $user->changeLanguage()
- $user->changeName()
- $user->changePassword()
- $user->changeRole()
- $user->changeTotp()
- $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->isNobody()
- $user->isNth()
- $user->isValid()
- $user->kirby()
- $user->language()
- $user->lock()
- $user->login()
- $user->loginPasswordless()
- $user->logout()
- $user->modified()
- $user->name()
- $user->nameOrEmail()
- $user->next()
- $user->nextAll()
- $user->panel()
- $user->password()
- $user->passwordTimestamp()
- $user->permissions()
- $user->prev()
- $user->prevAll()
- $user->purge()
- $user->role()
- $user->roles()
- $user->root()
- $user->secret()
- $user->siblings()
- $user->site()
- $user->toArray()
- $user->toSafeString()
- $user->toString()
- $user->translation()
- $user->translations()
- $user->update()
- $user->username()
- $user->uuid()
- $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->files()
- $users->filter()
- $users->filterBy()
- $users->find()
- $users->findBy()
- $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->random()
- $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()
oal
$block
- new Block()
- $block->content()
- $block->controller()
- $block->excerpt()
- $block->field()
- $block->hasNext()
- $block->hasPrev()
- $block->id()
- $block->indexOf()
- $block->is()
- $block->isEmpty()
- $block->isFirst()
- $block->isHidden()
- $block->isLast()
- $block->isNotEmpty()
- $block->isNth()
- $block->kirby()
- $block->next()
- $block->nextAll()
- $block->parent()
- $block->prev()
- $block->prevAll()
- $block->siblings()
- $block->toArray()
- $block->toField()
- $block->toHtml()
- $block->type()
$blocks
- new Blocks()
- $blocks->add()
- $blocks->append()
- $blocks->chunk()
- $blocks->clone()
- $blocks->count()
- $blocks->current()
- $blocks->data()
- $blocks->empty()
- $blocks->excerpt()
- $blocks->extend()
- Blocks::factory()
- $blocks->field()
- $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->hasType()
- $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->random()
- $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()
$layout
- new Layout()
- $layout->attrs()
- $layout->columns()
- Layout::factory()
- $layout->field()
- $layout->hasNext()
- $layout->hasPrev()
- $layout->id()
- $layout->indexOf()
- $layout->is()
- $layout->isEmpty()
- $layout->isFirst()
- $layout->isLast()
- $layout->isNotEmpty()
- $layout->isNth()
- $layout->kirby()
- $layout->next()
- $layout->nextAll()
- $layout->parent()
- $layout->prev()
- $layout->prevAll()
- $layout->siblings()
- $layout->toArray()
$layouts
- new Layouts()
- $layouts->add()
- $layouts->append()
- $layouts->chunk()
- $layouts->clone()
- $layouts->count()
- $layouts->current()
- $layouts->data()
- $layouts->empty()
- $layouts->extend()
- Layouts::factory()
- $layouts->field()
- $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->hasBlockType()
- $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->random()
- $layouts->remove()
- $layouts->rewind()
- $layouts->search()
- $layouts->set()
- $layouts->shuffle()
- $layouts->slice()
- $layouts->sort()
- Layouts::sortArgs()
- $layouts->sortBy()
- $layouts->toArray()
- $layouts->toBlocks()
- $layouts->toJson()
- $layouts->toString()
- $layouts->valid()
- $layouts->values()
- $layouts->when()
- $layouts->without()
yJF
$language
- new Language()
- $language->baseUrl()
- $language->clone()
- $language->code()
- $language->direction()
- $language->exists()
- $language->hasNext()
- $language->hasPrev()
- $language->id()
- $language->indexOf()
- $language->isDefault()
- $language->isDeletable()
- $language->isFirst()
- $language->isLast()
- $language->isNth()
- $language->kirby()
- Language::loadRules()
- $language->locale()
- $language->name()
- $language->next()
- $language->nextAll()
- $language->path()
- $language->pattern()
- $language->prev()
- $language->prevAll()
- $language->root()
- $language->router()
- $language->siblings()
- $language->slugs()
- $language->smartypants()
- $language->toArray()
- $language->translations()
- $language->url()
- $language->variable()
$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->random()
- $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->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->hasAuth()
- $request->header()
- $request->headers()
- $request->is()
- $request->method()
- $request->params()
- $request->path()
- $request->query()
- $request->ssl()
- $request->url()
$session
yEa
All classes
Aliases
Router
Patterns
Response types
System
Config options
Urls
Roots
- $kirby->root('accounts')
- $kirby->root('assets')
- $kirby->root('blueprints')
- $kirby->root('cache')
- $kirby->root('collections')
- $kirby->root('commands')
- $kirby->root('config')
- $kirby->root('content')
- $kirby->root('controllers')
- $kirby->root('i18n')
- $kirby->root('i18n:rules')
- $kirby->root('i18n:translations')
- $kirby->root('index')
- $kirby->root('kirby')
- $kirby->root('languages')
- $kirby->root('license')
- $kirby->root('logs')
- $kirby->root('media')
- $kirby->root('models')
- $kirby->root('panel')
- $kirby->root('plugins')
- $kirby->root('roles')
- $kirby->root('sessions')
- $kirby->root('site')
- $kirby->root('snippets')
- $kirby->root('templates')
Requirements
Validators
Plugins
Extensions
- API
- Asset methods
- Auth challenges
- Block methods
- Block models
- Blocks
- Blocks methods
- Blueprints
- Cache driver
- Collection filters
- Collection methods
- Collections
- Commands
- Controllers
- Core components
- Panel Created
- Darkroom driver
- Field methods
- Field previews
- Fields
- File methods
- File types
- Files methods
- Hooks
- Icons
- KirbyTags
- Layout column methods
- Layout methods
- Layouts methods
- Options
- Page methods
- Page models
- Pages
- Pages methods
- Panel areas
- Panel dialogs
- Panel dropdowns
- Panel search
- Permissions
- Request auth types
- Routes
- Sections
- Site methods
- Snippets
- Templates
- Textarea buttons
- Translations
- User methods
- User models
- Users methods
- Validators
- Writer marks/nodes
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
- language.create:after
- language.create:before
- language.delete:after
- language.delete:before
- language.update:after
- language.update: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.render:after
- page.render:before
- page.update:after
- page.update:before
- panel.route:after
- panel.route:before
- route:after
- route:before
- site.changeTitle:after
- site.changeTitle:before
- site.update:after
- site.update:before
- system.exception
- 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
Panel UI
API
Authentication
Languages
Pages
-
GET
/api/pages/:id -
PATCH
/api/pages/:id -
DELETE
/api/pages/:id -
GET
/api/pages/:id/children -
GET|POST
/api/pages/:id/children/search -
POST
/api/pages/:id/children -
GET
/api/pages/:id/blueprints -
GET
/api/pages/:id/files -
POST
/api/pages/:id/files -
PATCH
/api/pages/:id/files/sort -
GET
/api/pages/:id/files/:filename -
GET|POST
/api/pages/:id/files/search -
GET
/api/pages/:id/files/:filename/sections/:name -
PATCH
/api/pages/:id/files/:filename -
PATCH
/api/pages/:id/files/:filename/name -
DELETE
/api/pages/:id/files/:filename -
PATCH
/api/pages/:id/slug -
PATCH
/api/pages/:id/status -
PATCH
/api/pages/:id/template -
PATCH
/api/pages/:id/title
Roles
Site
-
GET
/api/site -
PATCH
/api/site/ -
GET
/api/site/children -
POST
/api/site/children -
GET|POST
/api/site/:id/search -
GET
/api/site/blueprints -
GET
/api/site/files -
POST
/api/site/files -
PATCH
/api/site/files/sort -
GET
/api/site/files/:filename -
GET|POST
/api/site/:id/files/search -
PATCH
/api/site/files/:filename -
DELETE
/api/site/files/:filename -
PATCH
/api/site/files/:filename/name -
GET
/api/site/files/:filename/sections/:name -
GET
/api/site/sections/:name -
PATCH
/api/site/title
System
Translations
Users
-
GET
/api/users -
POST
/api/users/ -
GET
/api/users/:id -
GET|POST
/api/users/:id/search -
PATCH
/api/users/:id -
DELETE
/api/users/:id -
PATCH
/api/users/:id/email -
GET
/api/users/:id/files -
POST
/api/users/:id/files -
GET|POST
/api/users/:id/files/search -
PATCH
/api/users/:id/files/sort -
GET
/api/users/:id/files/:filename -
PATCH
/api/users/:id/files/:filename -
DELETE
/api/users/:id/files/:filename -
PATCH
/api/users/:id/files/:filename/name -
GET
/api/users/:id/files/:filename/sections/:name -
PATCH
/api/users/:id/language -
PATCH
/api/users/:id/name -
PATCH
/api/users/:id/password -
PATCH
/api/users/:id/role -
GET
/api/users/:id/sections/:name
Tools
A
- A::append()
- A::apply()
- A::average()
- A::count()
- A::every()
- A::extend()
- A::fill()
- A::filter()
- A::find()
- A::first()
- A::get()
- A::has()
- A::implode()
- A::isAssociative()
- A::join()
- A::keyBy()
- A::last()
- A::map()
- A::merge()
- A::missing()
- A::move()
- A::nest()
- A::nestByKeys()
- A::pluck()
- A::prepend()
- A::random()
- A::reduce()
- A::shuffle()
- A::slice()
- A::some()
- A::sort()
- A::sum()
- A::update()
- A::without()
- A::wrap()
Cookie
Data
Dir
Escape
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::loadClasses()
- 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::safeBasename()
- F::safeExtension()
- F::safeName()
- F::similar()
- F::size()
- F::type()
- F::typeToExtensions()
- F::unlink()
- F::unzip()
- F::uri()
- F::write()
Header
Html
- Html::a()
- Html::attr()
- Html::breaks()
- Html::create()
- Html::css()
- Html::decode()
- Html::email()
- Html::encode()
- Html::entities()
- Html::figure()
- Html::gist()
- Html::iframe()
- Html::img()
- Html::isVoid()
- Html::js()
- Html::link()
- Html::parse()
- Html::rel()
- Html::simplify()
- Html::svg()
- Html::tag()
- Html::tel()
- Html::value()
- Html::video()
- Html::videoAttr()
- Html::vimeo()
- Html::youtube()
I18n
Mime
QrCode
Query
Str
- Str::accepted()
- Str::after()
- Str::afterStart()
- Str::ascii()
- Str::before()
- Str::beforeEnd()
- Str::between()
- Str::camel()
- Str::camelToKebab()
- Str::contains()
- Str::convert()
- Str::date()
- Str::encode()
- Str::encoding()
- Str::endsWith()
- Str::esc()
- Str::excerpt()
- Str::float()
- Str::from()
- Str::increment()
- Str::kebab()
- Str::kebabToCamel()
- Str::length()
- Str::lower()
- Str::ltrim()
- Str::match()
- Str::matchAll()
- Str::matches()
- Str::pool()
- Str::position()
- Str::query()
- Str::random()
- Str::replace()
- Str::replaceReplacements()
- Str::replacements()
- Str::rtrim()
- Str::safeTemplate()
- Str::short()
- Str::similarity()
- Str::slug()
- Str::snake()
- Str::split()
- Str::startsWith()
- Str::studly()
- Str::substr()
- Str::template()
- Str::toBytes()
- Str::toType()
- Str::trim()
- Str::ucfirst()
- Str::ucwords()
- Str::unhtml()
- Str::until()
- Str::upper()
- Str::uuid()
- Str::widont()
- Str::wrap()