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

Creates a new page object
$page->apiUrl()

Returns the url to the api endpoint
$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->callMethod()

Calls a registered method class with the passed arguments
$page->changeNum()

Changes the sorting number.
$page->changeSlug()

Changes the slug/uid of the page
$page->changeSort()

Change the position of the page in its siblings collection. Siblings will be resorted. If the page status isn't yet listed, it will be changed to it.
$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 all published children
$page->childrenAndDrafts()

Returns all published and draft children 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->contentFile()

Returns the absolute path to the content file
$page->contentFileData()

Prepares the content for the write method
$page->contentFileDirectory()

Returns the absolute path to the folder in which the content file is located
$page->contentFileExtension()

Returns the extension of the content file
$page->contentFileName()

Returns the content text file which is found by the inventory method
$page->contentFiles()

Returns an array with all content files
$page->controller()

Call the page controller
$page->copy()

Copies the page to a new parent
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 draft child by ID
$page->drafts()

Returns all draft children
$page->duplicate()

Duplicates the page with the given slug and optionally copies all files
$page->errors()

Returns all content validation errors
$page->exists()

Checks if the page exists on disk
Page::factory()

Constructs a Page object and also takes page models into account.
$page->file()

Returns a specific file by filename or the first one
$page->files()

Returns the Files collection
$page->find()

Finds one or multiple published children by ID
$page->findPageOrDraft()

Finds a single published or draft child
$page->go()

Redirects to this page, wrapper for the go() helper
$page->grandChildren()

Returns a collection of all published children of published 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 published 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 draft children
$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->hasMethod()

Checks if the object has a registered method
$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->inventory()

Returns the inventory of files children and content files
$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->isLocked()

Checks if the model is locked for the current user
$page->isNth()

Checks if the item is at a certain position
$page->isOpen()

Checks if the page is open.
$page->isPublished()

Checks if the page is not a draft.
$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->isVerified()

Checks if the page access is verified.
$page->kirby()

Returns the parent Kirby instance
$page->lock()

Returns the lock object for this model
$page->mediaRoot()

Returns the root to the media folder for the page
$page->mediaUrl()

The page's base URL for any files
Page::model()

Creates a page model if it has been registered
$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->panel()

Returns the panel info object
$page->parent()

Returns the parent Page object
$page->parentId()

Returns the parent id, if a parent exists
$page->parentModel()

Returns the parent model, which can either be another Page or the Site
$page->parents()

Returns a list of all parents and their parents recursively
$page->permalink()

Return the permanent URL to the page using its UUID
$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->previewUrl()

Draft preview Url
$page->publish()
$page->purge()

Clean internal caches
$page->query()

Creates a string query, starting from the model
$page->readContent()

Read the content from the content file
$page->render()

Renders the page with the given data.
$page->representation()
$page->resortSiblingsAfterUnlisting()
$page->root()

Returns the absolute root to the page directory No matter if it exists or not.
$page->save()

Stores the content on disk
$page->search()

Search all pages within the current page
$page->setSite()

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

Returns all sibling elements
$page->site()

Returns the parent Site instance
$page->slug()

Returns the slug of the page
$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->toSafeString()

String template builder with automatic HTML escaping
$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->urlForLanguage()

Builds the Url for a specific language
$page->uuid()

Returns the page's Unique ID.
$page->videos()

Filters the Files collection by type videos
$page->writeContent()

Low level data writer method to store the given data on disk or anywhere else

$page->permalink()

Return the permanent URL to the page using its UUID

Since 3.8.0
Read the guide
kirby/src/Cms/Page.php#L963

$page->permalink(): string|null

Return type

string|null

Parent class

Kirby\Cms\Page

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