<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[48188] trunk/src/wp-includes/load.php: Bootstrap/Load: Make some adjustments to `wp_get_environment_type()`:</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/48188">48188</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/48188","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-27 10:34:02 +0000 (Sat, 27 Jun 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/changeset/47919">[47919]</a>.
Props dlh, dd32, TimothyBlynJacobs, johnbillion, pbiron.
See <a href="https://core.trac.wordpress.org/ticket/33161">#33161</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesloadphp">trunk/src/wp-includes/load.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesloadphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/load.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/load.php 2020-06-26 22:29:27 UTC (rev 48187)
+++ trunk/src/wp-includes/load.php 2020-06-27 10:34:02 UTC (rev 48188)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -134,7 +134,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The type can be set via the `WP_ENVIRONMENT_TYPE` global system variable,
</span><span class="cx" style="display: block; padding: 0 10px"> * a constant of the same name, or the {@see 'wp_get_environment_type'} filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Possible values include 'development', 'stage', 'production'. If not set,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Possible values include 'development', 'staging', 'production'. If not set,
</ins><span class="cx" style="display: block; padding: 0 10px"> * the type defaults to 'production'.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -142,27 +142,44 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The current environment type.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_environment_type() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $approved_environments = array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ static $current_env = '';
+
+ if ( $current_env ) {
+ return $current_env;
+ }
+
+ $wp_environments = array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'development',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'stage',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'staging',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'production',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 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;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filters the list of approved environment types.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the list of supported environment types.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This filter runs before it can be used by plugins. It is designed for non-web runtimes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $approved_environments The list of approved environment types. Possible values
- * include 'development', 'stage', 'production'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $wp_environments The list of environment types. Possible values
+ * include 'development', 'staging', 'production'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $approved_environments = apply_filters( 'wp_approved_environment_types', $approved_environments );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $wp_environments = apply_filters( 'wp_environment_types', $wp_environments );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $current_env = '';
-
- // Check if a environment variable has been set for max flexibility, if `getenv` is available on the system.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check if the environment variable has been set, if `getenv` is available on the system.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'getenv' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $has_env = getenv( 'WP_ENVIRONMENT_TYPE' );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== $has_env ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -185,12 +202,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $current_env The current environment type. Possible values
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * include 'development', 'stage', 'production'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * include 'development', 'staging', 'production'.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $current_env = apply_filters( 'wp_get_environment_type', $current_env );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Make sure the environment is an allowed one, and not accidentally set to an invalid value.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! in_array( $current_env, $approved_environments, true ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! in_array( $current_env, $wp_environments, true ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $current_env = 'production';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -267,7 +284,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . '.maintenance';
</span><span class="cx" style="display: block; padding: 0 10px"> // If the $upgrading timestamp is older than 10 minutes, consider maintenance over.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ( time() - $upgrading ) >= 600 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ( time() - $upgrading ) >= 10 * MINUTE_IN_SECONDS ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>