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
Panel internals

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

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

Advanced

All classes
Aliases

new Kirby()
Creates a new App instance
$kirby->api()
Returns the Api instance
$kirby->apply()
Applies a hook to the given value; the value that gets modified by the hooks is always the last argument
$kirby->auth()
Returns the Authentication layer class
$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->component()
Returns a core component
$kirby->contentExtension()
Returns the content extension
$kirby->contentIgnore()
Returns files that should be ignored when scanning folders
$kirby->controller()
Calls a page controller by name and with the given arguments
$kirby->defaultLanguage()
Returns the default language object
Kirby::destroy()
Destroy the instance singleton and purge other static props
$kirby->detectedLanguage()
Detect the prefered language from the visitor object
$kirby->email()
Returns the Email singleton
$kirby->extend()
Register all given extensions
$kirby->extension()
Returns a given extension by type and name
$kirby->extensions()
Returns the extensions registry
$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->io()
Takes almost any kind of input and tries to convert it into a valid response
$kirby->kirbytag()
Renders a single KirbyTag with the given attributes
$kirby->kirbytags()
KirbyTags Parser
$kirby->kirbytext()
Parses KirbyTags first and Markdown afterwards
$kirby->language()
Returns the current language
$kirby->languageCode()
Returns the current language code
$kirby->languages()
Returns all available site languages
$kirby->locks()
Returns the app's locks object
$kirby->markdown()
Parses Markdown
$kirby->multilang()
Check for a multilang setup
$kirby->nonce()
Returns the nonce, which is used in the panel for inline scripts
$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->plugins()
Loads and returns all plugins in the site/plugins directory Loading only happens on the first call.
$kirby->render()
Returns the Response object for the current request
$kirby->request()
Returns the Request singleton
$kirby->resolve()
Path resolver for the router
$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->router()
Returns the Router singleton
$kirby->routes()
Returns all defined routes
$kirby->server()
Returns the Server object
$kirby->session()
Returns the current session object
$kirby->sessionHandler()
Returns the session handler
$kirby->setCurrentLanguage()
Load and set the current language if it exists Otherwise fall back to the default language
$kirby->setCurrentTranslation()
Set the current translation
$kirby->setLocale()
Set locale settings
$kirby->site()
Initializes and returns the Site object
$kirby->smartypants()
Applies the smartypants rule on the text
$kirby->snippet()
Uses the snippet component to create and return a template snippet
$kirby->system()
System check class
$kirby->template()
Uses the template component to initialize and return the Template object
$kirby->thumb()
Thumbnail creator
$kirby->translation()
Load a specific translation by locale
$kirby->translations()
Returns all available translations
$kirby->trigger()
Trigger a hook by name
$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->visitor()

Returns the visitor object

$kirby->visitor(): Kirby\Cms\Visitor

Return type

Kirby\Cms\Visitor

Source code

kirby/src/Cms/App.php#L1393