Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Plugins
- Themes
- Newsletter
- Buzz
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Fields
- Sections
- Blocks
- Icons
- Styling
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $block
- $blocks
- $layout
- $layouts
- $language
- $languages
- $pagination
- $request
- $session
- All classes
- Aliases
Router
- Patterns
- Response types
System
- Options
- Urls
- Roots
- Validators
Plugins
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

new Field()

Field constructor
$field->api()

Returns field api call
$field->data()

Returns field data
Field::defaults()

Default props and computed of the field
$field->errors()

Validates when run for the first time and returns any errors
Field::factory()

Creates a new field instance
$field->formFields()

Parent collection with all fields of the current form
$field->isEmpty()

Checks if the field is empty
$field->isInvalid()

Checks if the field is invalid
$field->isRequired()

Checks if the field is required
$field->isValid()

Checks if the field is valid
$field->kirby()

Returns the Kirby instance
Field::load()

Load a component definition by type
$field->model()

Returns the parent model
$field->save()

Checks if the field is saveable
Field::setup()

Loads all options from the component definition mixes in the defaults from the defaults method and then injects all additional mixins, defined in the component options.
$field->toArray()

Converts the field to a plain array
$field->value()

Returns the value of the field if saveable otherwise it returns null

$field->api()

Returns field api call

kirby/src/Form/Field.php#L85

$field->api(): mixed

Return type

mixed

Parent class

Kirby\Form\Field

Did you find an error? Help us improve our docs and edit this page on Github. Make sure to check out our styleguide →