/CakePHP 3.8

Function env

Gets an environment variable from available sources, and provides emulation for unsupported or inconsistent environment variables (i.e. DOCUMENT_ROOT on IIS, or SCRIPT_NAME in CGI mode). Also exposes some additional custom environment information.

Link: https://book.cakephp.org/3.0/en/core-libraries/global-constants-and-functions.html#env
Copyright: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
License: MIT License
Located at Core/functions.php
env( string $key , string|null $default = null )

Parameters summary

string $key Environment variable name.
string|null $default = null Specify a default value in case the environment variable is not defined.


  • string|boolean|null Environment variable setting.

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.