Skip to content

The CMS
Docs
- Guide
- Cookbook
- Reference
- Screencasts
- Glossary
Resources
- Plugins
- Themes
- Newsletter
- Buzz
Community

Try
Buy

View all results ›

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

new Environment()

Class constructor
$environment->address()

Returns the server's IP address
$environment->baseUri()

Returns the full base URL object
$environment->baseUrl()

Returns the full base URL
$environment->cli()

Checks if the request is being served by the CLI
$environment->detect()

Sanitizes the server info and detects all relevant parts. This can be called again at a later point to overwrite all the stored information and re-detect the environment if necessary.
$environment->get()

Gets a value from the server environment array
Environment::getGlobally()

Gets a value from the global server environment array of the current app instance; falls back to $_SERVER if no app instance is running
$environment->host()

Returns the current host name
$environment->https()

Returns whether the HTTPS protocol is used
$environment->info()

Returns the sanitized $_SERVER array
$environment->ip()

Returns the server's IP address
$environment->isBehindProxy()

Returns if the server is behind a reverse proxy server
$environment->isLocal()

Checks if this is a local installation; returns false if in doubt
$environment->options()

Loads and returns options from environment-specific PHP files (by host name and server IP address)
$environment->path()

Returns the detected path
$environment->port()

Returns the correct port number
$environment->requestUri()

Returns an URI object for the requested URL
$environment->requestUrl()

Returns the current URL, including the request path and query
Environment::sanitize()

Sanitizes some $_SERVER keys
$environment->scriptPath()

Returns the path to the php script within the document root without the filename of the script.
$environment->toArray()

Returns all environment data as array

$environment->baseUrl()

Returns the full base URL

kirby/src/Http/Environment.php#L131

$environment->baseUrl(): string

Return type

string

Parent class

Kirby\Http\Environment

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