Skip to content

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

Try
Buy

View all results ›

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
- 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
- Str
- Tpl
- Url
- V
- Xml

new Block()

Creates a new block object
$block->content()

Returns the content object
$block->controller()

Controller for the block snippet
$block->excerpt()

Converts the block to HTML and then uses the Str::excerpt method to create a non-formatted, shortened excerpt from it
$block->field()

Returns the parent field if known
$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->__toString()

Converts the object to a string

kirby/src/Cms/Block.php#L106

$block->__toString(): string

Return type

string

Parent class

Kirby\Cms\Block

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