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

$field->callback()
Applies the callback function to the field
$field->escape()
Escapes the field value to be safely used in HTML templates without the risk of XSS attacks
$field->excerpt()
Creates an excerpt of the field value without html or any other formatting.
$field->exists()
Checks if the field exists in the content data array
$field->html()
Converts the field content to valid HTML
$field->inline()
Strips all block-level HTML elements from the field value, it can be safely placed inside of other inline elements without the risk of breaking the HTML structure.
$field->isEmpty()
Checks if the field content is empty
$field->isFalse()
Converts the field value into a proper boolean and inverts it
$field->isNotEmpty()
Checks if the field content is not empty
$field->isTrue()
Converts the field value into a proper boolean
$field->isValid()
Validates the field content with the given validator and parameters
$field->key()
Returns the name of the field
$field->kirbytags()
Parses all KirbyTags without also parsing Markdown
$field->kirbytext()
Converts the field content from Markdown/Kirbytext to valid HTML
$field->kirbytextinline()
Converts the field content from inline Markdown/Kirbytext to valid HTML
$field->length()
Returns the length of the field content
$field->lower()
Converts the field content to lowercase
$field->markdown()
Converts markdown to valid HTML
$field->model()
$field->nl2br()
Converts all line breaks in the field content to <br> tags.
$field->or()
Provides a fallback if the field value is empty
$field->parent()
Returns the parent object of the field
$field->query()
Uses the field value as Kirby query
$field->replace()
It parses any queries found in the field value.
$field->short()
Cuts the string after the given length and adds "…" if it is longer
$field->slug()
Converts the field content to a slug
$field->smartypants()
Applies SmartyPants to the field
$field->split()
Splits the field content into an array
$field->toArray()
Converts the Field object to an array
$field->toBool()
Converts the field value into a proper boolean
$field->toData()
Parses the field value with the given method
$field->toDate()
Converts the field value to a timestamp or a formatted date
$field->toFile()
Returns a file object from a filename in the field
$field->toFiles()
Returns a file collection from a yaml list of filenames in the field
$field->toFloat()
Converts the field value into a proper float
$field->toInt()
Converts the field value into a proper integer
$field->toLink()
Wraps a link tag around the field value. The field value is used as the link text
$field->toPage()
Returns a page object from a page id in the field
$field->toPages()
Returns a pages collection from a yaml list of page ids in the field
$field->toString()
Returns the field value as string
$field->toStructure()
Converts a yaml field to a Structure object
$field->toTimestamp()
Converts the field value to a Unix timestamp
$field->toUrl()
Turns the field value into an absolute Url
$field->toUser()
Converts a user email address to a user object
$field->toUsers()
Returns a users collection from a yaml list of user email addresses in the field
$field->upper()
Converts the field content to uppercase
$field->value()
Returns the field content. If a new value is passed, the modified field will be returned. Otherwise it will return the field value.
$field->widont()
Avoids typographical widows in strings by replacing the last space with  
$field->words()
Returns the number of words in the text
$field->xml()
Converts the field content to valid XML
$field->yaml()
Parses yaml in the field content and returns an array

$field->model()

$field->model(): Kirby\Cms\Model|null

Return type

Kirby\Cms\Model|null

Source code

kirby/src/Cms/Field.php#L173

Edit on GitHub Our content styleguide