Reference

Search

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Icons
Samples

Objects

$asset
$file
$files
$kirby
$language
$languages
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Config
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
$query
Server
Str
Tpl
Url
V
Xml

Advanced

new Kirby()
Creates a new App instance
$kirby->blueprints()
Returns all available blueprints for this installation
$kirby->cache()
Returns a cache instance by key
$kirby->call()
Calls any Kirby route
$kirby->clone()
Creates an instance with the same initial properties.
$kirby->collection()
Returns a specific user-defined collection by name. All relevant dependencies are automatically injected
$kirby->collections()
Returns all user-defined collections
$kirby->defaultLanguage()
Returns the default language object
$kirby->detectedLanguage()
Detect the prefered language from the visitor object
$kirby->email()
Returns the Email singleton
$kirby->file()
Finds any file in the content directory
$kirby->hardcopy()
Creates a clone and fetches all lazy-loaded getters to get a full copy
$kirby->impersonate()
Become any existing user
Kirby::instance()
Returns the current App instance
$kirby->language()
Returns the current language
$kirby->languages()
Returns all available site languages
$kirby->locks()
Returns the app's locks object
$kirby->multilang()
Check for a multilang setup
$kirby->option()
Load a specific configuration option
$kirby->options()
Returns all configuration options
$kirby->page()
Returns any page from the content folder
$kirby->path()
Returns the request path
Kirby::plugin()
Kirby plugin factory and getter
$kirby->render()
Returns the Response object for the current request
$kirby->request()
Returns the Request singleton
$kirby->response()
Response configuration
$kirby->roles()
Returns all user roles
$kirby->root()
Returns a system root
$kirby->roots()
Returns the directory structure
$kirby->route()
Returns the currently active route
$kirby->server()
Returns the Server object
$kirby->session()
Returns the current session object
$kirby->site()
Initializes and returns the Site object
$kirby->system()
System check class
$kirby->thumb()
Thumbnail creator
$kirby->translation()
Load a specific translation by locale
$kirby->translations()
Returns all available translations
$kirby->url()
Returns a system url
$kirby->urls()
Returns the url structure
$kirby->user()
Returns a specific user by id or the current user if no id is given
$kirby->users()
Returns all users
Kirby::version()
Returns the current version number from the composer.json (Keep that up to date! :))
Kirby::versionHash()
Creates a hash of the version number
$kirby->visitor()
Returns the visitor object

$kirby->request()

Returns the Request singleton

$kirby->request(): Kirby\Http\Request

Return type

Kirby\Http\Request

Source code

kirby/src/Cms/App.php#L888