Reference

Search

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Blocks
Icons
Samples

Objects

$asset
$block
$blocks
$file
$files
$kirby
$language
$languages
$layout
$layoutcolumn
$layouts
$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

asset()
Helper to create an asset object
attr()
Generates a list of HTML attributes
collection()
Returns the result of a collection by name
csrf()
Checks / returns a CSRF token
css()
Creates one or multiple CSS link tags
deprecated()
Triggers a deprecation warning if debug mode is active
dump()
Simple object and variable dumper to help with debugging.
e()
Smart version of echo with an if condition as first argument
esc()
Escape context specific output
get()
Shortcut for $kirby->request()->get()
gist()
Embeds a Github Gist
go()
Redirects to the given Urls Urls can be relative or absolute.
h()
Shortcut for html()
html()
Creates safe html by encoding special characters
image()
Return an image from any page specified by the path
invalid()
Runs a number of validators on a set of data and checks if the data is invalid
js()
Creates a script tag to load a javascript file
kirby()
Returns the Kirby object in any situation
kirbytag()
Makes it possible to use any defined Kirbytag as standalone function
kirbytags()
Parses KirbyTags in the given string. Shortcut for $kirby->kirbytags($text, $data)
kirbytext()
Parses KirbyTags and Markdown in the given string. Shortcut for $kirby->kirbytext()
kirbytextinline()
Parses KirbyTags and inline Markdown in the given string.
load()
A super simple class autoloader
markdown()
Parses markdown in the given string. Shortcut for $kirby->markdown($text)
option()
Shortcut for $kirby->option($key, $default)
page()
Fetches a single page or multiple pages by id or the current page when no id is specified
pages()
Helper to build page collections
param()
Returns a single param from the URL
params()
Returns all params from the current Url
r()
Smart version of return with an if condition as first argument
site()
Returns the current site object
size()
Determines the size/length of numbers, strings, arrays and countable objects
smartypants()
Enhances the given string with smartypants. Shortcut for $kirby->smartypants($text)
snippet()
Embeds a snippet from the snippet folder
svg()
Includes an SVG file by absolute or relative file path.
t()
Returns translate string for key from translation file
tc()
Translates a count
tt()
Translate by key and then replace placeholders in the text
twitter()
Builds a Twitter link
u()
Shortcut for url()
url()
Builds an absolute URL for a given path
video()
Creates a video embed via iframe for Youtube or Vimeo videos. The embed Urls are automatically detected from the given Url.
vimeo()
Embeds a Vimeo video by URL in an iframe
widont()
The widont function makes sure that there are no typographical widows at the end of a paragraph – that's a single word in the last line
youtube()
Embeds a Youtube video by URL in an iframe

kirby()

Returns the Kirby object in any situation

kirby(): Kirby\Cms\App

Return type

Kirby\Cms\App

Example

<?= kirby()->roots()->content() ?>

Source code

kirby/config/helpers.php#L398

Edit on GitHub Our content styleguide