$kirby
The $kirby
object is the app instance of your Kirby installation. It's the central starting point to get all the different aspects of your site, like the options, urls, roots, languages, roles, etc.
-
$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->core()
-
$kirby->csrf()
-
$kirby->defaultLanguage()
-
$kirby->detectedLanguage()
-
$kirby->email()
-
$kirby->environment()
-
$kirby->extend()
-
$kirby->extension()
-
$kirby->extensions()
-
$kirby->file()
-
$kirby->hardcopy()
-
$kirby->image()
-
$kirby->impersonate()
-
$kirby->io()
-
$kirby->isNativeComponent()
-
$kirby->kirbytag()
-
$kirby->kirbytags()
-
$kirby->kirbytext()
-
$kirby->language()
-
$kirby->languageCode()
-
$kirby->languages()
-
$kirby->load()
-
$kirby->locks()
-
$kirby->markdown()
-
$kirby->multilang()
-
$kirby->nativeComponent()
-
$kirby->nonce()
-
$kirby->option()
-
$kirby->options()
-
$kirby->page()
-
$kirby->panelLanguage()
-
$kirby->path()
-
$kirby->plugins()
-
$kirby->render()
-
$kirby->request()
-
$kirby->resolve()
-
$kirby->response()
-
$kirby->roles()
-
$kirby->root()
-
$kirby->roots()
-
$kirby->route()
-
$kirby->router()
-
$kirby->routes()
-
$kirby->session()
-
$kirby->sessionHandler()
-
$kirby->setCurrentLanguage()
-
$kirby->setCurrentTranslation()
-
$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->visitor()
-
Kirby::destroy()
-
Kirby::instance()
-
Kirby::plugin()
-
Kirby::version()
-
Kirby::versionHash()
-
new Kirby()
How to fetch the $kirby
object
The $kirby
class is accessible in Kirby's templates/snippets etc. through the $kirby
variable.
In any situation, you can define a $kirby
object using the kirby()
helper: