Reference

Search

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Blocks
Icons
Samples

Objects

$asset
$block
$blocks
$file
$files
$kirby
$language
$languages
$layout
$layoutcolumn
$layouts
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit
Panel internals

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

Advanced

All classes
Aliases

new Block()
Creates a new block object
$block->content()
Returns the content object
$block->controller()
Controller for the block snippet
Block::factory()
Static Item factory
$block->hasNext()
Checks if there's a next item in the collection
$block->hasPrev()
Checks if there's a previous item in the collection
$block->id()
Returns the unique item id (UUID v4)
$block->indexOf()
Returns the position / index in the collection
$block->is()
Compares the item to another one
$block->isEmpty()
Checks if the block is empty
$block->isFirst()
Checks if the item is the first in the collection
$block->isHidden()
Checks if the block is hidden from being rendered in the frontend
$block->isLast()
Checks if the item is the last in the collection
$block->isNotEmpty()
Checks if the block is not empty
$block->isNth()
Checks if the item is at a certain position
$block->kirby()
Returns the Kirby instance
$block->next()
Returns the next item in the collection if available
$block->nextAll()
Returns the end of the collection starting after the current item
$block->parent()
Returns the parent model
$block->prev()
Returns the previous item in the collection if available
$block->prevAll()
Returns the beginning of the collection before the current item
$block->siblings()
Returns all sibling elements
$block->toArray()
The result is being sent to the editor via the API in the panel
$block->toField()
Converts the block to html first and then places that inside a field object. This can be used further with all available field methods
$block->toHtml()
Converts the block to HTML
$block->type()
Returns the block type

$block->_key()

Deprecated method to return the block type

$block->_key(): string

Return type

string

Source code

kirby/src/Cms/Block.php#L91