wp_get_environment_type(): string

Retrieves the current environment type.

Contents

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’.

Top ↑

Return

string The current environment type.

Top ↑

More Information

  • This function allows plugin and theme authors to more easily differentiate how they handle specific functionality between production and development sites in a standardized way.
  • When development is returned by wp_get_environment_type() , WP_DEBUG will be set to true if it is not defined in the wp-config.php file of the site.
  • All hosts that support setting up staging environments are requested to set this feature to staging on those staging environments. Similarly, all developers with development environments shall set this value to development appropriately.

Example Usage:

switch ( wp_get_environment_type() ) {
    case 'local':
    case 'development':
        do_nothing();
        break;

    case 'staging':
        do_staging_thing();
        break;

    case 'production':
    default:
        do_production_thing();
        break;
}

Top ↑

Source

File: wp-includes/load.php. View all references 

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;
}

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
__() wp-includes/l10n.php

Retrieves the translation of $text.
_deprecated_argument() wp-includes/functions.php

Marks a function argument as deprecated and inform when it has been used.

Top ↑

Used By

Used By
Used By Description
wp_is_authorize_application_redirect_url_valid() wp-admin/includes/user.php

Validates the redirect URL protocol scheme. The protocol can be anything except http and javascript.
wp_is_application_passwords_supported() wp-includes/user.php

Checks if Application Passwords is supported.
WP_Site_Health::is_development_environment() wp-admin/includes/class-wp-site-health.php

Checks if the current environment type is set to ‘development’ or ‘local’.
WP_Debug_Data::debug_data() wp-admin/includes/class-wp-debug-data.php

Static function for generating site debug data when required.
WP_Site_Health::get_tests() wp-admin/includes/class-wp-site-health.php

Returns a set of tests that belong to the site status page.
wp_initial_constants() wp-includes/default-constants.php

Defines initial WordPress constants.
Show 1 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
5.5.1 Removed the ability to alter the list of types.
5.5.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 5You must log in to vote on the helpfulness of this note
    Contributed by Khoi Pro —

    See case from rtCamp. They placed in mu-plugins/non-production.php.

    <?php
/**
 *  Non-production environment functionality.
 */

if ( 'production' !== wp_get_environment_type() ) {

	// Block crawling.
	add_filter( 'robots_txt', 'wpdocs_name_block_crawling', 999 );

	// Enable "Discourage search engines from indexing this site" option.
	add_filter( 'pre_option_blog_public', '__return_zero', 999 );

}

/**
 * Filters the robots.txt output to block crawling on non-production environment.
 *
 * @param string $output The robots.txt output.
 */
function wpdocs_name_block_crawling( $output ) {

	$output = '# Crawling is blocked for non-production environment' . PHP_EOL;
	$output .= 'User-agent: *' . PHP_EOL;
	$output .= 'Disallow: /';

	return $output;
}
  2. Skip to note 2 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
    Contributed by Ludwig C. —

    Setting the environment type by .htaccess or Apache configuration

    # Rules to set WP_ENVIRONMENT_TYPE based on hostname
    RewriteCond %{HTTP_HOST} [.]?localhost$
    RewriteRule .? - [E=WP_ENVIRONMENT_TYPE:local]
    RewriteCond %{HTTP_HOST} ^staging.domain.com$
    RewriteRule .? - [E=WP_ENVIRONMENT_TYPE:staging]
    RewriteCond %{HTTP_HOST} ^www.domain.com$
    RewriteRule .? - [E=WP_ENVIRONMENT_TYPE:production]

    Setting the environment type by Nginx configuration (best inside the php location)
    fastcgi_param WP_ENVIRONMENT_TYPE staging;

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by ashkanahmadi —

    You can turn this into various functions to use specifically in certain environments:

    function is_local_environment() {
   $env = wp_get_environment_type();
   return (defined('WP_ENVIRONMENT_TYPE') && $env === 'local');
}

    And then use that in your code. Example:

    if ( is_local_environment() ) {
  // do something only in local environment
}

You must log in before being able to contribute a note or feedback.