Text
KirbyText
Markdown
Templates
Field methods
- $field->escape()
- $field->excerpt()
- $field->exists()
- $field->html()
- $field->isEmpty()
- $field->isFalse()
- $field->isNotEmpty()
- $field->isTrue()
- $field->isValid()
- $field->key()
- $field->kirbytags()
- $field->kirbytext()
- $field->length()
- $field->lower()
- $field->markdown()
- $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
- attr()
- collection()
- csrf()
- css()
- dump()
- e()
- get()
- gist()
- go()
- h()
- html()
- image()
- invalid()
- js()
- kirby()
- kirbytag()
- kirbytags()
- kirbytext()
- load()
- markdown()
- option()
- page()
- pages()
- param()
- params()
- r()
- site()
- size()
- smartypants()
- snippet()
- svg()
- t()
- tc()
- twitter()
- u()
- url()
- video()
- vimeo()
- widont()
- youtube()
Panel
Blueprints
Presets
Fields
Sections
Icons
- account
- add
- alert
- angle-down
- angle-left
- angle-right
- angle-up
- bars
- bold
- bolt
- calendar
- cancel
- cart
- check
- circle
- circle-filled
- circle-outline
- clock
- code
- cog
- collapse
- copy
- dashboard
- document
- dots
- download
- draft
- edit
- expand
- file
- file-audio
- file-code
- file-document
- file-image
- file-spreadsheet
- file-text
- file-video
- file-word
- file-zip
- funnel
- globe
- headline
- image
- import
- italic
- key
- list-bullet
- list-numbers
- loader
- lock
- logout
- markdown
- menu
- open
- page
- parent
- phone
- preview
- protected
- quote
- refresh
- remove
- search
- settings
- share
- smile
- sort
- tag
- template
- text
- title
- toggle-off
- toggle-on
- trash
- undo
- upload
- url
- user
- users
- video
- wand
Samples
Objects
$file
- $file->asset()
- $file->blueprint()
- $file->blur()
- $file->bw()
- $file->changeName()
- $file->changeSort()
- $file->clone()
- $file->content()
- 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->isNth()
- $file->isResizable()
- $file->isValid()
- $file->isViewable()
- $file->kirby()
- $file->modified()
- $file->next()
- $file->nextAll()
- $file->page()
- $file->parent()
- $file->parents()
- $file->permissions()
- $file->prev()
- $file->prevAll()
- $file->publish()
- $file->quality()
- $file->readContent()
- $file->replace()
- $file->resize()
- $file->root()
- $file->save()
- $file->siblings()
- $file->site()
- $file->template()
- $file->templateSiblings()
- $file->thumb()
- $file->toArray()
- $file->toString()
- $file->translation()
- $file->translations()
- $file->type()
- $file->unpublish()
- $file->update()
- $file->url()
- $file->writeContent()
$files
- $files->add()
- $files->append()
- $files->changeSort()
- $files->clone()
- $files->count()
- $files->current()
- $files->data()
- Files::factory()
- $files->filter()
- $files->filterBy()
- $files->find()
- $files->findBy()
- $files->findById()
- $files->findByKey()
- $files->first()
- $files->flip()
- $files->group()
- $files->groupBy()
- $files->has()
- $files->indexOf()
- $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->sortBy()
- $files->template()
- $files->toArray()
- $files->toJson()
- $files->toString()
- $files->valid()
- $files->without()
$kirby
- $kirby->auth()
- $kirby->cache()
- $kirby->call()
- $kirby->clone()
- $kirby->collection()
- $kirby->collections()
- $kirby->controller()
- $kirby->defaultLanguage()
- $kirby->detectedLanguage()
- $kirby->email()
- $kirby->extension()
- $kirby->extensions()
- $kirby->file()
- $kirby->hardcopy()
- $kirby->impersonate()
- Kirby::instance()
- $kirby->language()
- $kirby->languages()
- $kirby->option()
- $kirby->options()
- $kirby->page()
- $kirby->path()
- Kirby::plugin()
- $kirby->plugins()
- $kirby->render()
- $kirby->request()
- $kirby->resolve()
- $kirby->response()
- $kirby->roles()
- $kirby->root()
- $kirby->roots()
- $kirby->route()
- $kirby->routes()
- $kirby->server()
- $kirby->session()
- $kirby->site()
- $kirby->system()
- $kirby->thumb()
- $kirby->translation()
- $kirby->translations()
- $kirby->trigger()
- $kirby->url()
- $kirby->urls()
- $kirby->user()
- $kirby->users()
- Kirby::version()
- $kirby->visitor()
$language
- $language->clone()
- $language->code()
- $language->direction()
- $language->exists()
- $language->hardcopy()
- $language->id()
- $language->isDefault()
- $language->kirby()
- $language->locale()
- $language->name()
- $language->pattern()
- $language->root()
- $language->site()
- $language->toArray()
- $language->translations()
- $language->url()
$languages
- $languages->add()
- $languages->append()
- $languages->clone()
- $languages->codes()
- $languages->count()
- $languages->current()
- $languages->data()
- $languages->default()
- $languages->filter()
- $languages->filterBy()
- $languages->find()
- $languages->findBy()
- $languages->findByKey()
- $languages->first()
- $languages->flip()
- $languages->group()
- $languages->groupBy()
- $languages->has()
- $languages->indexOf()
- $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->sortBy()
- $languages->toArray()
- $languages->toJson()
- $languages->toString()
- $languages->valid()
- $languages->without()
$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::create()
- $page->createChild()
- $page->createFile()
- $page->createNum()
- $page->decrement()
- $page->delete()
- $page->depth()
- $page->dirname()
- $page->diruri()
- $page->documents()
- $page->draft()
- $page->drafts()
- $page->errors()
- $page->exists()
- Page::factory()
- $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->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->isNth()
- $page->isOpen()
- $page->isReadable()
- $page->isSortable()
- $page->isUnlisted()
- $page->isValid()
- $page->isVerified()
- $page->kirby()
- $page->modified()
- $page->next()
- $page->nextAll()
- $page->nextListed()
- $page->nextUnlisted()
- $page->num()
- $page->parent()
- $page->parents()
- $page->permissions()
- $page->prev()
- $page->prevAll()
- $page->prevListed()
- $page->prevUnlisted()
- $page->publish()
- $page->purge()
- $page->readContent()
- $page->render()
- $page->resortSiblingsAfterUnlisting()
- $page->root()
- $page->save()
- $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->urlForLanguage()
- $page->videos()
- $page->writeContent()
$pages
- $pages->add()
- $pages->append()
- $pages->audio()
- $pages->children()
- $pages->clone()
- $pages->code()
- $pages->count()
- $pages->current()
- $pages->data()
- $pages->documents()
- $pages->drafts()
- 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->group()
- $pages->groupBy()
- $pages->has()
- $pages->images()
- $pages->index()
- $pages->indexOf()
- $pages->invisible()
- $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->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->sortBy()
- $pages->template()
- $pages->toArray()
- $pages->toJson()
- $pages->toString()
- $pages->unlisted()
- $pages->valid()
- $pages->videos()
- $pages->visible()
- $pages->without()
$pagination
- $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
$session
$site
- $site->audio()
- $site->blueprint()
- $site->blueprints()
- $site->breadcrumb()
- $site->changeTitle()
- $site->children()
- $site->childrenAndDrafts()
- $site->clone()
- $site->code()
- $site->content()
- $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->inventory()
- $site->isValid()
- $site->kirby()
- $site->modified()
- $site->page()
- $site->pages()
- $site->permissions()
- $site->purge()
- $site->readContent()
- $site->root()
- $site->save()
- $site->search()
- $site->setPage()
- $site->site()
- $site->toArray()
- $site->toString()
- $site->translation()
- $site->translations()
- $site->update()
- $site->url()
- $site->urlForLanguage()
- $site->videos()
- $site->visit()
- $site->wasModifiedAfter()
- $site->writeContent()
$user
- $user->audio()
- $user->avatar()
- $user->blueprint()
- $user->changeEmail()
- $user->changeLanguage()
- $user->changeName()
- $user->changePassword()
- $user->changeRole()
- $user->clone()
- $user->code()
- $user->content()
- 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->isLoggedIn()
- $user->isNth()
- $user->isValid()
- $user->kirby()
- $user->language()
- $user->login()
- $user->loginPasswordless()
- $user->logout()
- $user->modified()
- $user->name()
- $user->next()
- $user->nextAll()
- $user->password()
- $user->permissions()
- $user->prev()
- $user->prevAll()
- $user->readContent()
- $user->role()
- $user->root()
- $user->save()
- $user->siblings()
- $user->site()
- $user->toArray()
- $user->toString()
- $user->translation()
- $user->translations()
- $user->update()
- $user->username()
- $user->validatePassword()
- $user->videos()
- $user->writeContent()
$users
- $users->add()
- $users->append()
- $users->clone()
- $users->count()
- $users->create()
- $users->current()
- $users->data()
- Users::factory()
- $users->filter()
- $users->filterBy()
- $users->find()
- $users->findBy()
- $users->findByKey()
- $users->first()
- $users->flip()
- $users->group()
- $users->groupBy()
- $users->has()
- $users->indexOf()
- $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->search()
- $users->set()
- $users->shuffle()
- $users->slice()
- $users->sortBy()
- $users->toArray()
- $users->toJson()
- $users->toString()
- $users->valid()
- $users->without()
Router
Patterns
Response types
System
Options
Urls
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('emails')
- $kirby->root('index')
- $kirby->root('kirby')
- $kirby->root('media')
- $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::min()
- V::maxLength()
- V::minLength()
- V::maxWords()
- V::minWords()
- V::more()
- V::notContains()
- V::notIn()
- V::num()
- V::required()
- V::same()
- V::size()
- V::startsWith()
- V::time()
- V::url()
Plugins
Extensions
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
- 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.update:before
- page.update:after
- route:before
- route:after
- site.update:before
- site.update:after
- user.changeEmail:before
- user.changeEmail:after
- user.changeName:before
- user.changeName:after
- user.changeLanguage:before
- user.changeLanguage: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.update:before
- user.update:after
Core components
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
- Progess
- Radio Field
- Radio Input
- Range Field
- Range Input
- Select Field
- Select Input
- 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
API
Authentication
Languages
Pages
- /api/pages/:id
- /api/pages/:id
- /api/pages/:id
- /api/pages/:id/children
- /api/pages/:id/children
- /api/pages/:id/children/blueprints
- /api/pages/:id/files
- /api/pages/:id/files
- /api/pages/:id/files/sort
- /api/pages/:id/files/:filename
- /api/pages/:id/files/:filename/sections/:name
- /api/pages/:id/files/:filename
- /api/pages/:id/files/:filename/name
- /api/pages/:id/files/:filename
- /api/pages/:id/slug
- /api/pages/:id/status
- /api/pages/:id/template
- /api/pages/:id/title
Roles
Site
- /api/site
- /api/site/
- /api/site/children
- /api/site/children
- /api/site/children/blueprints
- /api/site/files
- /api/site/files
- /api/site/files/sort
- /api/site/files/:filename
- /api/site/files/:filename
- /api/site/files/:filename
- /api/site/files/:filename/name
- /api/site/files/:filename/sections/:name
- /api/site/sections/:name
- /api/site/title
System
Translations
Users
- /api/users
- /api/users/
- /api/users/:id
- /api/users/:id
- /api/users/:id
- /api/users/:id/email
- /api/users/:id/files
- /api/users/:id/files
- /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
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::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::remove()
- F::rename()
- F::safeName()
- F::similar()
- F::size()
- F::type()
- F::unzip()
- F::uri()
- F::write()
Header
Html
Mime
Server
Str
- Str::accepted()
- Str::after()
- Str::ascii()
- Str::before()
- Str::between()
- Str::contains()
- Str::convert()
- Str::encode()
- Str::encoding()
- Str::endsWith()
- Str::excerpt()
- 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::trim()
- Str::ucfirst()
- Str::ucwords()
- Str::unhtml()
- Str::until()
- Str::upper()
- Str::widont()