Skip to content

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- License Hub
Community
Partners

Try
Buy

View all results ›

Formatting 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
- Config options
- Urls
- Roots
- Requirements
- Validators
Plugins
API
- Authentication
- Languages
- Pages
- Roles
- Site
- System
- Translations
- Users
Tools
- A
- Cookie
- Data
- Dir
- Escape
- F
- Header
- Html
- I18n
- Mime
- QrCode
- Query
- Str
- Tpl
- Url
- V
- Xml

new Site()

Creates a new Site object
$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
$site->breadcrumb()

Builds a breadcrumb collection
$site->changeStorage()

Moves or copies the model to a new storage instance/type
$site->changeTitle()

Change the site title
$site->children()

Returns all published children
$site->childrenAndDrafts()

Returns all published and draft children at the same time
$site->clone()

Creates a new instance with the same initial properties
$site->code()

Filters the Files collection by type code
$site->content()

Returns the content
$site->createChild()

Creates a main page
$site->createDefaultContent()

Creates default content for the model, by using our Form class to generate the defaults, based on the model's blueprint setup.
$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 draft child by ID
$site->drafts()

Returns all draft children
$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 published children by ID
$site->findPageOrDraft()

Finds a single published or draft child
$site->grandChildren()

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

Checks if the Files collection has any files
$site->hasImages()

Checks if the Files collection has any images
$site->hasListedChildren()

Checks if the page has any listed children
$site->hasMethod()

Checks if the object has a registered custom method
$site->hasUnlistedChildren()

Checks if the page has any unlisted children
$site->hasVideos()

Checks if the Files collection has any videos
$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->isValid()

Checks if the data has any errors
$site->kirby()

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

Returns lock for the model
$site->mediaDir()

Returns the absolute path to the media folder for the page
$site->mediaRoot()

Alias for ::mediaDir
$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->panel()

Returns the panel info object
$site->permissions()

Returns the permissions object for this site
$site->previewUrl()

Returns the preview URL with authentication for drafts and versions
$site->purge()

Clean internal caches
$site->query()

Creates a string query, starting from the model
$site->root()

Returns the absolute path to the content directory
$site->save()

Low-level method to save the model with the given data. Consider using ::update() instead.
$site->search()

Search all pages in the site
$site->site()

Returns the parent Site instance
$site->storage()

Returns the content storage handler
$site->toArray()

Converts the most important site properties to an array
$site->toSafeString()

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

Returns the site's Unique ID which is always site://.
$site->version()

Returns a content version instance
$site->versions()

Returns a versions collection
$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->homePageId()

Returns the global home page id

kirby/src/Cms/Site.php#L237

$site->homePageId(): string

Return type

string

Parent class

Kirby\Cms\Site

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

Report an issue on this page on GitHub

Kirby

The CMS that adapts to any project. Made for developers, designers, creators and clients.

🇪🇺 Made in Europe

The CMS
Docs
- Guide
- Reference
- Cookbook
- Quicktips
- Screencasts
- Glossary
- Archive
Resources
- Plugins
- Themes
- Newsletter
- Buzz
- Pixels
- License Hub
Community
Kirby
- Security
- Privacy
- License
- Presskit
- Team
- Contact
With support of