Reference

Search

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
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 Site()
Creates a new Site object
$site->apiUrl()
Returns the url to the api endpoint
$site->audio()
Filters the Files collection by type audio
$site->blueprint()
Returns the blueprint object
$site->blueprints()
Returns an array with all blueprints that are available as subpages of the site
$site->breadcrumb()
Builds a breadcrumb collection
$site->callMethod()
Calls a registered method class with the passed arguments
$site->changeTitle()
Change the site title
$site->children()
Returns the Pages collection
$site->childrenAndDrafts()
Returns all children and drafts at the same time
$site->clone()
Creates an instance with the same initial properties.
$site->code()
Filters the Files collection by type code
$site->content()
Returns the content
$site->contentFile()
Returns the absolute path to the content file
$site->contentFileData()
Prepares the content for the write method
$site->contentFileDirectory()
Returns the absolute path to the folder in which the content file is located
$site->contentFileExtension()
Returns the extension of the content file
$site->contentFileName()
Filename for the content file
$site->contentFiles()
Returns an array with all content files
$site->createChild()
Creates a main page
$site->createFile()
Creates a new file
$site->decrement()
Decrement a given field value
$site->documents()
Filters the Files collection by type documents
$site->draft()
Searches for a child draft by id
$site->drafts()
Return all drafts of the model
$site->errorPage()
Returns the error page object
$site->errorPageId()
Returns the global error page id
$site->errors()
Returns all content validation errors
$site->exists()
Checks if the site exists on disk
$site->file()
Returns a specific file by filename or the first one
$site->files()
Returns the Files collection
$site->find()
Finds one or multiple children by id
$site->findPageOrDraft()
Finds a single page or draft
$site->grandChildren()
Returns a collection of all children of children
$site->hardcopy()
Creates a clone and fetches all lazy-loaded getters to get a full copy
$site->hasAudio()
Checks if the Files collection has any audio files
$site->hasChildren()
Checks if the model has any children
$site->hasCode()
Checks if the Files collection has any code files
$site->hasDocuments()
Checks if the Files collection has any document files
$site->hasDrafts()
Checks if the model has any drafts
$site->hasFiles()
Checks if the Files collection has any files
$site->hasImages()
Checks if the Files collection has any images
$site->hasInvisibleChildren()
$site->hasListedChildren()
Checks if the page has any listed children
$site->hasMethod()
Checks if the object has a registered method
$site->hasUnlistedChildren()
Checks if the page has any unlisted children
$site->hasVideos()
Checks if the Files collection has any videos
$site->hasVisibleChildren()
$site->homePage()
Returns the home page object
$site->homePageId()
Returns the global home page id
$site->id()
Each model must return a unique id
$site->image()
Returns a specific image by filename or the first one
$site->images()
Filters the Files collection by type image
$site->increment()
Increment a given field value
$site->index()
Creates a flat child index
$site->inventory()
Creates an inventory of all files and children in the site directory
$site->is()
Compares the current object with the given site object
$site->isLocked()
Checks if the model is locked for the current user
$site->isValid()
Checks if the data has any errors
$site->kirby()
Returns the parent Kirby instance
$site->lock()
Returns the lock object for this model
$site->mediaRoot()
Returns the root to the media folder for the site
$site->mediaUrl()
The site's base url for any files
$site->modified()
Gets the last modification date of all pages in the content folder.
$site->page()
Returns the current page if $path is not specified. Otherwise it will try to find a page by the given path.
$site->pages()
Alias for Site::children()
$site->panelIcon()
Returns the panel icon definition
$site->panelImage()
$site->panelOptions()
Returns an array of all actions that can be performed in the Panel This also checks for the lock status
$site->panelPath()
Returns the full path without leading slash
$site->panelUrl()
Returns the url to the editing view in the panel
$site->permissions()
Returns the permissions object for this site
$site->previewUrl()
Preview Url
$site->purge()
Clean internal caches
$site->query()
Creates a string query, starting from the model
$site->readContent()
Read the content from the content file
$site->root()
Returns the absolute path to the content directory
$site->save()
Stores the content on disk
$site->search()
Search all pages in the site
$site->setPage()
Sets the current page object
$site->setSite()
Setter for the parent site object
$site->site()
Returns the parent Site instance
$site->toArray()
Converts the most important site properties to an array
$site->toString()
String template builder
$site->translation()
Returns a single translation by language code If no code is specified the current translation is returned
$site->translations()
Returns the translations collection
$site->update()
Updates the model data
$site->url()
Returns the Url
$site->urlForLanguage()
Returns the translated url
$site->videos()
Filters the Files collection by type videos
$site->visit()
Sets the current page by id or page object and returns the current page
$site->wasModifiedAfter()
Checks if any content of the site has been modified after the given unix timestamp This is mainly used to auto-update the cache
$site->writeContent()
Low level data writer method to store the given data on disk or anywhere else

$site->homePageId()

Returns the global home page id

$site->homePageId(): string

Return type

string

Source code

kirby/src/Cms/Site.php#L307