Skip to content

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

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 StructureObject()

Creates a new StructureObject with the given props
$structureobject->clone()

Creates an instance with the same initial properties.
$structureobject->content()

Returns the content
$structureobject->hardcopy()

Creates a clone and fetches all lazy-loaded getters to get a full copy
$structureobject->hasNext()

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

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

Returns the required id
$structureobject->indexOf()

Returns the position / index in the collection
$structureobject->is()

Compares the current object with the given structure object
$structureobject->isFirst()

Checks if the item is the first in the collection
$structureobject->isLast()

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

Checks if the item is at a certain position
$structureobject->kirby()

Returns the parent Kirby instance
$structureobject->next()

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

Returns the end of the collection starting after the current item
$structureobject->parent()

Returns the parent Model object
$structureobject->prev()

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

Returns the beginning of the collection before the current item
$structureobject->setSite()

Setter for the parent site object
$structureobject->siblings()

Returns all sibling elements
$structureobject->site()

Returns the parent Site instance
$structureobject->toArray()

Converts all fields in the object to a plain associative array. The id is injected into the array afterwards to make sure it's always present and not overloaded in the content.

$structureobject->id()

Returns the required id

kirby/src/Cms/StructureObject.php#L100

$structureobject->id(): string

Return type

string

Parent class

Kirby\Cms\StructureObject

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