Reference

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Icons
Samples

Objects

$asset
$file
$files
$kirby
$language
$languages
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Config
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
$query
Server
Str
Tpl
Url
V
Xml

$page->audio()
Filters the Files collection by type audio
$page->blueprint()
Returns the blueprint object
$page->blueprints()
Returns an array with all blueprints that are available for the page
$page->changeNum()
Changes the sorting number The sorting number must already be correct when the method is called
$page->changeSlug()
Changes the slug/uid of the page
$page->changeStatus()
Change the status of the current page to either draft, listed or unlisted
$page->changeTemplate()
Changes the page template
$page->changeTitle()
Change the page title
$page->children()
Returns the Pages collection
$page->childrenAndDrafts()
Returns all children and drafts at the same time
$page->clone()
Creates an instance with the same initial properties.
$page->code()
Filters the Files collection by type code
$page->content()
Returns the content
Page::create()
Creates and stores a new page
$page->createChild()
Creates a child of the current page
$page->createFile()
Creates a new file
$page->createNum()
Create the sorting number for the page depending on the blueprint settings
$page->decrement()
Decrement a given field value
$page->delete()
Deletes the page
$page->depth()
Returns a number indicating how deep the page is nested within the content folder
$page->dirname()
Sorting number + Slug
$page->diruri()
Sorting number + Slug
$page->documents()
Filters the Files collection by type documents
$page->draft()
Searches for a child draft by id
$page->drafts()
Return all drafts of the model
$page->errors()
Returns all content validation errors
$page->exists()
Checks if the page exists on disk
$page->file()
Returns a specific file by filename or the first one
$page->files()
Returns the Files collection
$page->find()
Finds one or multiple children by id
$page->findPageOrDraft()
Finds a single page or draft
$page->grandChildren()
Returns a collection of all children of children
$page->hardcopy()
Creates a clone and fetches all lazy-loaded getters to get a full copy
$page->hasAudio()
Checks if the Files collection has any audio files
$page->hasChildren()
Checks if the model has any children
$page->hasCode()
Checks if the Files collection has any code files
$page->hasDocuments()
Checks if the Files collection has any document files
$page->hasDrafts()
Checks if the model has any drafts
$page->hasFiles()
Checks if the Files collection has any files
$page->hasImages()
Checks if the Files collection has any images
$page->hasListedChildren()
Checks if the page has any listed children
$page->hasNext()
Checks if there's a next item in the collection
$page->hasNextListed()
Checks if there's a next listed page in the siblings collection
$page->hasNextUnlisted()
Checks if there's a next unlisted page in the siblings collection
$page->hasPrev()
Checks if there's a previous item in the collection
$page->hasPrevListed()
Checks if there's a previous listed page in the siblings collection
$page->hasPrevUnlisted()
Checks if there's a previous unlisted page in the siblings collection
$page->hasTemplate()
Checks if the intended template for the page exists.
$page->hasUnlistedChildren()
Checks if the page has any unlisted children
$page->hasVideos()
Checks if the Files collection has any videos
$page->id()
Returns the Page Id
$page->image()
Returns a specific image by filename or the first one
$page->images()
Filters the Files collection by type image
$page->increment()
Increment a given field value
$page->index()
Creates a flat child index
$page->indexOf()
Returns the position / index in the collection
$page->intendedTemplate()
Returns the template that should be loaded if it exists.
$page->is()
Compares the current object with the given page object
$page->isActive()
Checks if the page is the current page
$page->isAncestorOf()
Checks if the page is a direct or indirect ancestor of the given $page object
$page->isCacheable()
Checks if the page can be cached in the pages cache. This will also check if one of the ignore rules from the config kick in.
$page->isChildOf()
Checks if the page is a child of the given page
$page->isDescendantOf()
Checks if the page is a descendant of the given page
$page->isDescendantOfActive()
Checks if the page is a descendant of the currently active page
$page->isDraft()
Checks if the current page is a draft
$page->isErrorPage()
Checks if the page is the error page
$page->isFirst()
Checks if the item is the first in the collection
$page->isHomeOrErrorPage()
It's often required to check for the home and error page to stop certain actions. That's why there's a shortcut.
$page->isHomePage()
Checks if the page is the home page
$page->isLast()
Checks if the item is the last in the collection
$page->isListed()
Checks if the page has a sorting number
$page->isNth()
Checks if the item is at a certain position
$page->isOpen()
Checks if the page is open.
$page->isReadable()
Check if the page can be read by the current user
$page->isSortable()
Checks if the page is sortable
$page->isUnlisted()
Checks if the page has no sorting number
$page->isValid()
Checks if the data has any errors
$page->kirby()
Returns the parent Kirby instance
$page->modified()
Returns the last modification date of the page
$page->next()
Returns the next item in the collection if available
$page->nextAll()
Returns the end of the collection starting after the current item
$page->nextListed()
Returns the next listed page if it exists
$page->nextUnlisted()
Returns the next unlisted page if it exists
$page->num()
Returns the sorting number
$page->parent()
Returns the parent Page object
$page->parents()
Returns a list of all parents and their parents recursively
$page->permissions()
Returns the permissions object for this page
$page->prev()
Returns the previous item in the collection if available
$page->prevAll()
Returns the beginning of the collection before the current item
$page->prevListed()
Returns the previous listed page
$page->prevUnlisted()
Returns the previous unlisted page
$page->publish()
$page->purge()
Clean internal caches
$page->render()
Renders the page with the given data.
$page->resortSiblingsAfterUnlisting()
$page->root()
Returns the absolute root to the page directory No matter if it exists or not.
$page->search()
Search all pages within the current page
$page->siblings()
Returns all sibling elements
$page->site()
Returns the parent Site instance
$page->slug()
Returns the slug of the page
$page->sort()
$page->status()
Returns the page status, which can be draft, listed or unlisted
$page->template()
Returns the final template
$page->templateSiblings()
Returns siblings with the same template
$page->title()
Returns the title field or the slug as fallback
$page->toArray()
Converts the most important properties to array
$page->toString()
String template builder
$page->translation()
Returns a single translation by language code If no code is specified the current translation is returned
$page->translations()
Returns the translations collection
$page->uid()
Returns the UID of the page.
$page->unpublish()
Convert a page from listed or unlisted to draft.
$page->update()
Updates the page data
$page->uri()
The uri is the same as the id, except that it will be translated in multi-language setups
$page->url()
Returns the Url
$page->videos()
Filters the Files collection by type videos

$page->permissions()

Returns the permissions object for this page

$page->permissions(): PagePermissions

Return type

PagePermissions

Source code

kirby/src/Cms/Page.php#L1041