Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Newsletter
- Plugins
- Roadmap
- Releases
Community

Try
Buy

View all results ›

Text
- KirbyText
- Markdown
Templates
- Field methods
- Helpers
Panel
- Blueprints
- Presets
- Fields
- Sections
- Blocks
- Icons
- Samples
Objects
- $kirby
- $site
- $page
- $pages
- $file
- $files
- $user
- $users
- $blocks
- $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 LayoutField()
$layoutfield->after()
$layoutfield->api()
$layoutfield->attrsForm()
$layoutfield->autofocus()
$layoutfield->before()
$layoutfield->blocksToValues()
$layoutfield->data()
$layoutfield->default()

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

If true, the field is no longer editable and will not be saved
$layoutfield->empty()
$layoutfield->errors()

Runs all validations and returns an array of error messages
$layoutfield->fields()
$layoutfield->fieldset()
$layoutfield->fieldsetGroups()
$layoutfield->fieldsets()
$layoutfield->fill()
$layoutfield->form()
$layoutfield->group()
$layoutfield->hasNext()

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

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

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

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

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

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

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

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

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

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

Returns the Kirby instance
$layoutfield->label()

The field label can be set as string or associative array with translations
$layoutfield->layouts()
$layoutfield->max()
$layoutfield->min()
$layoutfield->model()

Returns the parent model
$layoutfield->name()

Returns the field name
$layoutfield->next()

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

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

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

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

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

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

If true, the field has to be filled in correctly to be saved.
$layoutfield->routes()
$layoutfield->save()
$layoutfield->settings()
$layoutfield->siblings()

Returns all sibling elements
$layoutfield->store()
$layoutfield->toArray()

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

Should the field be translatable?
$layoutfield->type()
$layoutfield->validations()
$layoutfield->value()

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

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

Returns the width of the field in the Panel grid

$layoutfield->id()

kirby/src/Form/FieldClass.php#L161

$layoutfield->id(): string

Return type

string

Parent class

Kirby\Form\Field\LayoutField inherited from 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 →