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 System()
$system->accounts()

Check for a writable accounts folder
$system->content()

Check for a writable content folder
$system->curl()

Check for an existing curl extension
$system->exposedFileUrl()

Returns the URL to the file within a system folder if the file is located in the document root. Otherwise it will return null.
$system->folderUrl()

Returns the URL to a system folder if the folder is located in the document root. Otherwise it will return null.
$system->indexUrl()

Returns the app's human-readable index URL without scheme
$system->info()

Returns an array with relevant system information used for debugging
$system->init()

Create the most important folders if they don't exist yet
$system->isInstallable()

Check if the Panel is installable. On a public server the panel.install option must be explicitly set to true to get the installer up and running.
$system->isInstalled()

Check if Kirby is already installed
$system->isLocal()

Check if this is a local installation
$system->isOk()

Check if all tests pass
$system->is2FA()

Check if the Panel has 2FA activated
$system->is2FAWithTOTP()

Check if the Panel has 2FA with TOTP activated
$system->license()

Loads the license file and returns the license information if available
$system->loginMethods()

Returns the configured UI modes for the login form with their respective options
$system->mbString()

Check for an existing mbstring extension
$system->media()

Check for a writable media folder
$system->php()

Check for a valid PHP version
$system->plugins()

Returns a sorted collection of all installed plugins
$system->register()

Validates the license key and adds it to the .license file in the config folder if possible.
$system->serverSoftware()

Returns the detected server software
$system->serverSoftwareShort()

Returns the short version of the detected server software
$system->sessions()

Check for a writable sessions folder
$system->status()

Get an status array of all checks
$system->title()

Returns the site's title as defined in the content file or site.yml blueprint
$system->toArray()
$system->updateStatus()

Returns the update status object unless the update check for Kirby has been disabled
System::upgradeContent()

Upgrade to the new folder separator

new System()

kirby/src/Cms/System.php#L33

new System(Kirby\Cms\App $app)

Parameters

Name	Type	Default
$apprequired	`Kirby\Cms\App`	no default value

Parent class

Kirby\Cms\System

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