$site
The $site object is the root element for any site with pages. It represents the main content folder with its site.txt.
-
new Site()
-
$site->audio()
-
$site->blueprint()
-
$site->blueprints()
-
$site->breadcrumb()
-
$site->changeTitle()
-
$site->children()
-
$site->childrenAndDrafts()
-
$site->clone()
-
$site->code()
-
$site->content()
-
$site->contentFiles()
-
$site->createChild()
-
$site->createFile()
-
$site->decrement()
-
$site->documents()
-
$site->draft()
-
$site->drafts()
-
$site->errorPage()
-
$site->errors()
-
$site->exists()
-
$site->file()
-
$site->files()
-
$site->find()
-
$site->findPageOrDraft()
-
$site->grandChildren()
-
$site->hardcopy()
-
$site->hasAudio()
-
$site->hasChildren()
-
$site->hasCode()
-
$site->hasDocuments()
-
$site->hasDrafts()
-
$site->hasFiles()
-
$site->hasImages()
-
$site->hasListedChildren()
-
$site->hasUnlistedChildren()
-
$site->hasVideos()
-
$site->homePage()
-
$site->id()
-
$site->image()
-
$site->images()
-
$site->increment()
-
$site->index()
-
$site->is()
-
$site->isLocked()
-
$site->isValid()
-
$site->kirby()
-
$site->lock()
-
$site->modified()
-
$site->page()
-
$site->pages()
-
$site->panelOptions()
-
$site->permissions()
-
$site->purge()
-
$site->root()
-
$site->search()
-
$site->site()
-
$site->toArray()
-
$site->toString()
-
$site->translation()
-
$site->translations()
-
$site->update()
-
$site->url()
-
$site->videos()
-
$site->wasModifiedAfter()
How to access the $site object
The $site variable is automatically available in your templates and snippets.
To access the $site object in extensions, you have to define it first:
// via the kirby object
$site = $kirby->site();
// using the `site()` helper
$site = site();Examples
Get the site title
echo $site->title();Get any custom field of the site
echo $site->description();Get the files stored in the content folder
$siteFiles = $site->files();Get all the pages of the site
$pageIndex = $site->index();Get the URL of the site
$url = $site->url();