Skip to content

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- License Hub
Community
Partners

Try
Buy

View all results ›

Formatting 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
- Config options
- Urls
- Roots
- Requirements
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- QrCode
- Query
- Str
- Tpl
- Url
- V
- Xml

new Field()
$field->api()
$field->default()

Returns the default value of the field
Field::defaults()

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

Returns optional dialog routes for the field
$field->drawers()

Returns optional drawer routes for the field
$field->emptyValue()

Returns the preferred empty state for the field
$field->errors()

Runs all validations and returns an array of error messages
Field::factory()

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

Sets a new value for the field
$field->fillWithEmptyValue()

Preferred name would be ::reset but this is taken by options in other fields.
$field->hasNext()

Checks if there's a next item in the collection
$field->hasPrev()

Checks if there's a previous item in the collection
$field->hasValue()

Checks if the field has a value
$field->indexOf()

Returns the position / index in the collection
$field->isActive()

Checks if the field is currently active or hidden because of a when condition
$field->isDisabled()

Checks if the field is disabled
$field->isEmpty()

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

Checks if the given value is considered empty
$field->isFirst()

Checks if the item is the first in the collection
$field->isHidden()

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

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

Checks if the item is the last in the collection
$field->isNth()

Checks if the item is at a certain position
$field->isRequired()

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

Checks if the field can be stored in the given language.
$field->isSubmittable()

A field might have a value, but can still not be submitted because it is disabled, not translatable into the given language or not active due to a when rule.
$field->isTranslatable()

Should the field be translatable into the given language?
$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->next()

Returns the next item in the collection if available
$field->nextAll()

Returns the end of the collection starting after the current item
$field->prev()

Returns the previous item in the collection if available
$field->prevAll()

Returns the beginning of the collection before the current item
$field->required()
$field->routes()

Returns field api routes
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->siblings()

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

Submits a new value for the field. Fields can overwrite this method to provide custom submit logic. This is useful if the field component sends data that needs to be processed before being stored.
$field->toArray()

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

Returns the value of the field in a format to be used in forms (e.g. used as data for Panel Vue components)
$field->toStoredValue()

Returns the value of the field in a format to be stored by our storage classes
$field->translate()
$field->value()

Returns the value of the field if it has a value otherwise it returns null Alias for self::toFormValue()
$field->when()

Field::defaults()

Default props and computed of the field

kirby/src/Form/Field.php#L87

Field::defaults(): array

Return type

array

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

Report an issue on this page on GitHub

Kirby

The CMS that adapts to any project. Made for developers, designers, creators and clients.

🇪🇺 Made in Europe

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- Pixels
- License Hub
Community
Kirby
- Security
- Privacy
- License
- Presskit
- Team
- Contact
With support of