wp_get_environment_type(): string
- Since
- 5.5.0, 5.5.1, 5.5.1
- Source
wp-includes/load.php:250
Description
The type can be set via the WP_ENVIRONMENT_TYPE global system variable, or a constant of the same name.
Possible values are 'local', 'development', 'staging', and 'production'.
If not set, the type defaults to 'production'.
Compatibility
- WordPress
- since 5.5.1
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Return value
string- The current environment type.
Performance profile
How much work a call to wp_get_environment_type() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Trivial
- Scaling
- Constant
- Instructions
- 5–45
- Plugin surface
- None
- Called by
- 8
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 47.
Nothing here hands control to plugin code.
8 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
do_action()one call below wp_get_environment_type()
Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 5 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_environment_type() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!defined('WP_RUN_CORE_TESTS') | 5 | none |
!defined('WP_ENVIRONMENT_TYPES') | 16–23 | getenv() |
defined('WP_ENVIRONMENT_TYPES') && !function_exists() | 20–27 | function_exists(), getenv() |
defined('WP_ENVIRONMENT_TYPES') | 30–37 | function_exists(), function_exists(), _deprecated_argument(), getenv() |
defined('WP_ENVIRONMENT_TYPES') && function_exists() | 38–45 | function_exists(), function_exists(), __(), sprintf(), _deprecated_argument(), getenv() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 47 | 5–45 | 9 | |
| 8.5 | 47 | 5–45 | 9 | |
| 8.4 | 47 | 5–45 | 9 | 4 fewer instructions than PHP 8.3 |
| 8.3 | 51 | 5–45 | 9 | |
| 8.2 | 51 | 5–45 | 9 | |
| 8.1 | 51 | 5–45 | 9 | |
| 7.4 | 51 | 5–45 | 9 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 2
- __()Retrieves the translation of $text.
- _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
Used by · 8
- WP_Debug_Data::get_wp_core()Gets the WordPress core section of the debug data.
- WP_Site_Health::get_tests()Returns a set of tests that belong to the site status page.
- WP_Site_Health::is_development_environment()Checks if the current environment type is set to 'development' or 'local'.
- wp_initial_constants()Defines initial WordPress constants.
- wp_is_application_passwords_supported()Checks if Application Passwords is supported.
- wp_is_authorize_application_redirect_url_valid()Validates the redirect URL protocol scheme.
- wp_register_core_abilities()Registers the default core abilities.
- wp_should_disable_pings_for_environment()Determines whether pings should be disabled for the current environment.
Source code
function wp_get_environment_type() { static $current_env = ''; if ( ! defined( 'WP_RUN_CORE_TESTS' ) && $current_env ) { return $current_env; } $wp_environments = array( 'local', 'development', 'staging', 'production', ); // Add a note about the deprecated WP_ENVIRONMENT_TYPES constant. if ( defined( 'WP_ENVIRONMENT_TYPES' ) && function_exists( '_deprecated_argument' ) ) { if ( function_exists( '__' ) ) { /* translators: %s: WP_ENVIRONMENT_TYPES */ $message = sprintf( __( 'The %s constant is no longer supported.' ), 'WP_ENVIRONMENT_TYPES' ); } else { $message = sprintf( 'The %s constant is no longer supported.', 'WP_ENVIRONMENT_TYPES' ); } _deprecated_argument( 'define()', '5.5.1', $message ); } // Check if the environment variable has been set, if `getenv` is available on the system. if ( function_exists( 'getenv' ) ) { $has_env = getenv( 'WP_ENVIRONMENT_TYPE' ); if ( false !== $has_env ) { $current_env = $has_env; } } // Fetch the environment from a constant, this overrides the global system variable. if ( defined( 'WP_ENVIRONMENT_TYPE' ) && WP_ENVIRONMENT_TYPE ) { $current_env = WP_ENVIRONMENT_TYPE; } // Make sure the environment is an allowed one, and not accidentally set to an invalid value. if ( ! in_array( $current_env, $wp_environments, true ) ) { $current_env = 'production'; } return $current_env;}Changelog
Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/load.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.