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 BlocksField()
$blocksfield->after()
$blocksfield->api()
$blocksfield->autofocus()
$blocksfield->before()
$blocksfield->blocksToValues()
$blocksfield->data()
$blocksfield->default()

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

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

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

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

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

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

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

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

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

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

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

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

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

Returns the Kirby instance
$blocksfield->label()

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

Returns the parent model
$blocksfield->name()

Returns the field name
$blocksfield->next()

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

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

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

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

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

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

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

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

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

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

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

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

Returns the width of the field in the Panel grid

$blocksfield->pretty()

kirby/src/Form/Field/BlocksField.php#L121

$blocksfield->pretty(): bool

Return type

bool

Parent class

Kirby\Form\Field\BlocksField

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