Changeset 48188

Timestamp:

06/27/2020 10:34:02 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Bootstrap/Load: Make some adjustments to wp_get_environment_type():

• Rename the wp_approved_environment_types filter to wp_environment_types.
• Introduce WP_ENVIRONMENT_TYPES system variable and constant to complement the filter.
• Correct the argument type for the wp_environment_types filter.
• Cache the result in a static variable to ensure consistent return value.
• Rename the stage type to staging.

Follow-up to [47919].

Props dlh, dd32, TimothyBlynJacobs, johnbillion, pbiron.
See #33161.

File:

• trunk/src/wp-includes/load.php (modified) (5 diffs)

trunk/src/wp-includes/load.php

@@ -135 +135 @@
  * a constant of the same name, or the {@see 'wp_get_environment_type'} filter.
  *
- * Possible values include 'development', 'stage', 'production'. If not set,
+ * Possible values include 'development', 'staging', 'production'. If not set,
  * the type defaults to 'production'.
  *
@@ -143 +143 @@
  */
 function wp_get_environment_type() {
-    $approved_environments = array(
+    static $current_env = '';
+
+    if ( $current_env ) {
+        return $current_env;
+    }
+
+    $wp_environments = array(
         'development',
-        'stage',
+        'staging',
         'production',
     );
 
+    // Check if the environment variable has been set, if `getenv` is available on the system.
+    if ( function_exists( 'getenv' ) ) {
+        $has_env = getenv( 'WP_ENVIRONMENT_TYPES' );
+        if ( false !== $has_env ) {
+            $wp_environments = explode( ',', $has_env );
+        }
+    }
+
+    // Fetch the environment types from a constant, this overrides the global system variable.
+    if ( defined( 'WP_ENVIRONMENT_TYPES' ) ) {
+        $wp_environments = WP_ENVIRONMENT_TYPES;
+    }
+
     /**
-     * Filters the list of approved environment types.
+     * Filters the list of supported environment types.
      *
      * This filter runs before it can be used by plugins. It is designed for non-web runtimes.
@@ -156 +175 @@
      * @since 5.5.0
      *
-     * @param string $approved_environments The list of approved environment types. Possible values
-     *                                      include 'development', 'stage', 'production'.
+     * @param array $wp_environments The list of environment types. Possible values
+     *                               include 'development', 'staging', 'production'.
      */
-    $approved_environments = apply_filters( 'wp_approved_environment_types', $approved_environments );
-
-    $current_env = '';
-
-    // Check if a environment variable has been set for max flexibility, if `getenv` is available on the system.
+    $wp_environments = apply_filters( 'wp_environment_types', $wp_environments );
+
+    // 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' );
@@ -186 +203 @@
      *
      * @param string $current_env The current environment type. Possible values
-     *                            include 'development', 'stage', 'production'.
+     *                            include 'development', 'staging', 'production'.
      */
     $current_env = apply_filters( 'wp_get_environment_type', $current_env );
 
     // Make sure the environment is an allowed one, and not accidentally set to an invalid value.
-    if ( ! in_array( $current_env, $approved_environments, true ) ) {
+    if ( ! in_array( $current_env, $wp_environments, true ) ) {
         $current_env = 'production';
     }
@@ -268 +285 @@
     require ABSPATH . '.maintenance';
     // If the $upgrading timestamp is older than 10 minutes, consider maintenance over.
-    if ( ( time() - $upgrading ) >= 600 ) {
+    if ( ( time() - $upgrading ) >= 10 * MINUTE_IN_SECONDS ) {
         return false;
     }