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 Layout()
Creates a new Layout object
$layout->attrs()
Returns the attrs object
$layout->columns()
Returns the columns in this layout
Layout::factory()
Static Item factory
$layout->hasNext()
Checks if there's a next item in the collection
$layout->hasPrev()
Checks if there's a previous item in the collection
$layout->id()
Returns the unique item id (UUID v4)
$layout->indexOf()
Returns the position / index in the collection
$layout->is()
Compares the item to another one
$layout->isEmpty()
Checks if the layout is empty
$layout->isFirst()
Checks if the item is the first in the collection
$layout->isLast()
Checks if the item is the last in the collection
$layout->isNotEmpty()
Checks if the layout is not empty
$layout->isNth()
Checks if the item is at a certain position
$layout->kirby()
Returns the Kirby instance
$layout->next()
Returns the next item in the collection if available
$layout->nextAll()
Returns the end of the collection starting after the current item
$layout->parent()
Returns the parent model
$layout->prev()
Returns the previous item in the collection if available
$layout->prevAll()
Returns the beginning of the collection before the current item
$layout->siblings()
Returns all sibling elements
$layout->toArray()
The result is being sent to the editor via the API in the panel

new Layout()

Creates a new Layout object

new Layout(array $params = [ ])

Parameters

Name	Type	Default	Description
`$params`	`array`	`[ ]`

Source code

kirby/src/Cms/Layout.php#L46