# $site

The `$site` object is the root element for any site with pages. It represents the main content folder with its `site.txt`.

****

- Full class name: `Kirby\Cms\Site`
- Alias: `Site`
- Source: <https://github.com/getkirby/kirby/tree/5.5.3/src/Cms/Site.php#L27>

****

### $site

- [$site->__call()](https://getkirby.com/docs/reference/objects/cms/site/__call.md)
- [new Site()](https://getkirby.com/docs/reference/objects/cms/site/__construct.md)
- [$site->__debugInfo()](https://getkirby.com/docs/reference/objects/cms/site/__debug-info.md)
- [$site->__toString()](https://getkirby.com/docs/reference/objects/cms/site/__to-string.md)
- [$site->apiUrl()](https://getkirby.com/docs/reference/objects/cms/site/api-url.md)
- [$site->audio()](https://getkirby.com/docs/reference/objects/cms/site/audio.md)
- [$site->blueprint()](https://getkirby.com/docs/reference/objects/cms/site/blueprint.md)
- [$site->blueprints()](https://getkirby.com/docs/reference/objects/cms/site/blueprints.md)
- [$site->breadcrumb()](https://getkirby.com/docs/reference/objects/cms/site/breadcrumb.md)
- [$site->changeStorage()](https://getkirby.com/docs/reference/objects/cms/site/change-storage.md)
- [$site->changeTitle()](https://getkirby.com/docs/reference/objects/cms/site/change-title.md)
- [$site->children()](https://getkirby.com/docs/reference/objects/cms/site/children.md)
- [$site->childrenAndDrafts()](https://getkirby.com/docs/reference/objects/cms/site/children-and-drafts.md)
- [$site->clone()](https://getkirby.com/docs/reference/objects/cms/site/clone.md)
- [$site->code()](https://getkirby.com/docs/reference/objects/cms/site/code.md)
- [$site->content()](https://getkirby.com/docs/reference/objects/cms/site/content.md)
- [$site->contentFileData()](https://getkirby.com/docs/reference/objects/cms/site/content-file-data.md)
- [$site->createChild()](https://getkirby.com/docs/reference/objects/cms/site/create-child.md)
- [$site->createDefaultContent()](https://getkirby.com/docs/reference/objects/cms/site/create-default-content.md)
- [$site->createFile()](https://getkirby.com/docs/reference/objects/cms/site/create-file.md)
- [$site->decrement()](https://getkirby.com/docs/reference/objects/cms/site/decrement.md)
- [$site->documents()](https://getkirby.com/docs/reference/objects/cms/site/documents.md)
- [$site->draft()](https://getkirby.com/docs/reference/objects/cms/site/draft.md)
- [$site->drafts()](https://getkirby.com/docs/reference/objects/cms/site/drafts.md)
- [$site->errorPage()](https://getkirby.com/docs/reference/objects/cms/site/error-page.md)
- [$site->errorPageId()](https://getkirby.com/docs/reference/objects/cms/site/error-page-id.md)
- [$site->errors()](https://getkirby.com/docs/reference/objects/cms/site/errors.md)
- [$site->exists()](https://getkirby.com/docs/reference/objects/cms/site/exists.md)
- [$site->file()](https://getkirby.com/docs/reference/objects/cms/site/file.md)
- [$site->files()](https://getkirby.com/docs/reference/objects/cms/site/files.md)
- [$site->find()](https://getkirby.com/docs/reference/objects/cms/site/find.md)
- [$site->findPageOrDraft()](https://getkirby.com/docs/reference/objects/cms/site/find-page-or-draft.md)
- [$site->getMethod()](https://getkirby.com/docs/reference/objects/cms/site/get-method.md)
- [$site->grandChildren()](https://getkirby.com/docs/reference/objects/cms/site/grand-children.md)
- [$site->hardcopy()](https://getkirby.com/docs/reference/objects/cms/site/hardcopy.md)
- [$site->hasAudio()](https://getkirby.com/docs/reference/objects/cms/site/has-audio.md)
- [$site->hasChildren()](https://getkirby.com/docs/reference/objects/cms/site/has-children.md)
- [$site->hasCode()](https://getkirby.com/docs/reference/objects/cms/site/has-code.md)
- [$site->hasDocuments()](https://getkirby.com/docs/reference/objects/cms/site/has-documents.md)
- [$site->hasDrafts()](https://getkirby.com/docs/reference/objects/cms/site/has-drafts.md)
- [$site->hasFiles()](https://getkirby.com/docs/reference/objects/cms/site/has-files.md)
- [$site->hasImages()](https://getkirby.com/docs/reference/objects/cms/site/has-images.md)
- [$site->hasListedChildren()](https://getkirby.com/docs/reference/objects/cms/site/has-listed-children.md)
- [$site->hasMethod()](https://getkirby.com/docs/reference/objects/cms/site/has-method.md)
- [$site->hasUnlistedChildren()](https://getkirby.com/docs/reference/objects/cms/site/has-unlisted-children.md)
- [$site->hasVideos()](https://getkirby.com/docs/reference/objects/cms/site/has-videos.md)
- [$site->homePage()](https://getkirby.com/docs/reference/objects/cms/site/home-page.md)
- [$site->homePageId()](https://getkirby.com/docs/reference/objects/cms/site/home-page-id.md)
- [$site->id()](https://getkirby.com/docs/reference/objects/cms/site/id.md)
- [$site->image()](https://getkirby.com/docs/reference/objects/cms/site/image.md)
- [$site->images()](https://getkirby.com/docs/reference/objects/cms/site/images.md)
- [$site->increment()](https://getkirby.com/docs/reference/objects/cms/site/increment.md)
- [$site->index()](https://getkirby.com/docs/reference/objects/cms/site/index.md)
- [$site->inventory()](https://getkirby.com/docs/reference/objects/cms/site/inventory.md)
- [$site->is()](https://getkirby.com/docs/reference/objects/cms/site/is.md)
- [$site->isAccessible()](https://getkirby.com/docs/reference/objects/cms/site/is-accessible.md)
- [$site->isLocked()](https://getkirby.com/docs/reference/objects/cms/site/is-locked.md)
- [$site->isValid()](https://getkirby.com/docs/reference/objects/cms/site/is-valid.md)
- [$site->kirby()](https://getkirby.com/docs/reference/objects/cms/site/kirby.md)
- [$site->lock()](https://getkirby.com/docs/reference/objects/cms/site/lock.md)
- [$site->mediaDir()](https://getkirby.com/docs/reference/objects/cms/site/media-dir.md)
- [$site->mediaRoot()](https://getkirby.com/docs/reference/objects/cms/site/media-root.md)
- [$site->mediaUrl()](https://getkirby.com/docs/reference/objects/cms/site/media-url.md)
- [$site->modified()](https://getkirby.com/docs/reference/objects/cms/site/modified.md)
- [$site->page()](https://getkirby.com/docs/reference/objects/cms/site/page.md)
- [$site->pages()](https://getkirby.com/docs/reference/objects/cms/site/pages.md)
- [$site->panel()](https://getkirby.com/docs/reference/objects/cms/site/panel.md)
- [$site->permissions()](https://getkirby.com/docs/reference/objects/cms/site/permissions.md)
- [$site->previewUrl()](https://getkirby.com/docs/reference/objects/cms/site/preview-url.md)
- [$site->purge()](https://getkirby.com/docs/reference/objects/cms/site/purge.md)
- [$site->query()](https://getkirby.com/docs/reference/objects/cms/site/query.md)
- [$site->readContent()](https://getkirby.com/docs/reference/objects/cms/site/read-content.md)
- [$site->root()](https://getkirby.com/docs/reference/objects/cms/site/root.md)
- [$site->save()](https://getkirby.com/docs/reference/objects/cms/site/save.md)
- [$site->search()](https://getkirby.com/docs/reference/objects/cms/site/search.md)
- [$site->site()](https://getkirby.com/docs/reference/objects/cms/site/site.md)
- [$site->storage()](https://getkirby.com/docs/reference/objects/cms/site/storage.md)
- [$site->toArray()](https://getkirby.com/docs/reference/objects/cms/site/to-array.md)
- [$site->toSafeString()](https://getkirby.com/docs/reference/objects/cms/site/to-safe-string.md)
- [$site->toString()](https://getkirby.com/docs/reference/objects/cms/site/to-string.md)
- [$site->translation()](https://getkirby.com/docs/reference/objects/cms/site/translation.md)
- [$site->translations()](https://getkirby.com/docs/reference/objects/cms/site/translations.md)
- [$site->update()](https://getkirby.com/docs/reference/objects/cms/site/update.md)
- [$site->url()](https://getkirby.com/docs/reference/objects/cms/site/url.md)
- [$site->urlForLanguage()](https://getkirby.com/docs/reference/objects/cms/site/url-for-language.md)
- [$site->uuid()](https://getkirby.com/docs/reference/objects/cms/site/uuid.md)
- [$site->version()](https://getkirby.com/docs/reference/objects/cms/site/version.md)
- [$site->versions()](https://getkirby.com/docs/reference/objects/cms/site/versions.md)
- [$site->videos()](https://getkirby.com/docs/reference/objects/cms/site/videos.md)
- [$site->visit()](https://getkirby.com/docs/reference/objects/cms/site/visit.md)
- [$site->wasModifiedAfter()](https://getkirby.com/docs/reference/objects/cms/site/was-modified-after.md)
- [$site->writeContent()](https://getkirby.com/docs/reference/objects/cms/site/write-content.md)

## 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:

```php
// via the kirby object
$site = $kirby->site();

// using the `site()` helper
$site = site();
```

## Examples

### Get the site title

```php
echo $site->title();
```

### Get any custom field of the site

```php
echo $site->description();
```

### Get the files stored in the content folder

```php
$siteFiles = $site->files();
```

### Get all the pages of the site

```php
$pageIndex = $site->index();
```

### Get the URL of the site

```php
$url = $site->url();
```