Skip to content

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
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 FieldClass()
$fieldclass->after()
$fieldclass->api()
$fieldclass->autofocus()
$fieldclass->before()
$fieldclass->data()
$fieldclass->default()

Returns the default value for the field, which will be used when a page/file/user is created
$fieldclass->dialogs()

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

If true, the field is no longer editable and will not be saved
$fieldclass->drawers()

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

Runs all validations and returns an array of error messages
$fieldclass->fill()

Setter for the value
$fieldclass->hasNext()

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

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

Optional help text below the field
$fieldclass->icon()

Optional icon that will be shown at the end of the field
$fieldclass->id()
$fieldclass->indexOf()

Returns the position / index in the collection
$fieldclass->isDisabled()
$fieldclass->isEmpty()
$fieldclass->isEmptyValue()
$fieldclass->isFirst()

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

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

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

Checks if the item is at a certain position
$fieldclass->isRequired()
$fieldclass->isSaveable()
$fieldclass->isValid()

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

Returns the Kirby instance
$fieldclass->label()

The field label can be set as string or associative array with translations
$fieldclass->model()

Returns the parent model
$fieldclass->name()

Returns the field name
$fieldclass->next()

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

Returns the end of the collection starting after the current item
$fieldclass->params()

Returns all original params for the field
$fieldclass->placeholder()

Optional placeholder value that will be shown when the field is empty
$fieldclass->prev()

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

Returns the beginning of the collection before the current item
$fieldclass->props()

Define the props that will be sent to the Vue component
$fieldclass->required()

If true, the field has to be filled in correctly to be saved.
$fieldclass->routes()

Routes for the field API
$fieldclass->save()
$fieldclass->siblings()

Returns all sibling elements
$fieldclass->store()

Converts the given value to a value that can be stored in the text file
$fieldclass->toArray()

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

Should the field be translatable?
$fieldclass->type()

Returns the field type
$fieldclass->value()

Returns the value of the field if saveable otherwise it returns null
$fieldclass->when()

Conditions when the field will be shown
$fieldclass->width()

Returns the width of the field in the Panel grid

$fieldclass->api()

kirby/src/Form/FieldClass.php#L87

$fieldclass->api(): array

Return type

array

Parent class

Kirby\Form\FieldClass

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

Kirby

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

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