Check the value of WP_ENVIRONMENT_TYPE before using it

[dd32]

The constant WP_ENVIRONMENT_TYPE as used by ​wp_get_environment_type() doesn't validate the value of the constant before overriding the environment value.

This is problematic, especially during unit testing, as it becomes impossible to alter the environment during the unit test run, if the environment is forcefully setting the constant (​such as through wp-env).

While it could be possibly beneficial to validate that the value is within the whitelist, at least checking it's non-empty may ease testing for some configurations:

load.php

@@ -227 +227 @@
         }
 
         // Fetch the environment from a constant, this overrides the global system variable.
-        if ( defined( 'WP_ENVIRONMENT_TYPE' ) ) {
+        if ( defined( 'WP_ENVIRONMENT_TYPE' ) && WP_ENVIRONMENT_TYPE ) {
                 $current_env = WP_ENVIRONMENT_TYPE;
         }

As WP_ENVIRONMENT_TYPE variable declaration is a string type, so there must be some condition checking of values as well.

Trac ticket: 55741

[ramon fincken]

Went ahead and removed double code from class-wp-debug-data.php and upgraded the checks.

[ramon fincken]

55741 patch

[ramon fincken]

55741.20220604.2

[ramon fincken]

added patch 2, as the is_string is not needed anymore due to the in_array strict checker

[ramon fincken]

About the string strict check. You might add (via filter) a non string environment and if you have defined it at your wp-config.php the check will pass.
This is an edge case however, if you want to cover this in the wp_environment_is_allowed function you will need to add an is_string check

[desrosj]

Thanks for the patches!

While there is some potential for consolidation and flexibility through new filters, I think that deserves a broader discussion.

I think that 55741.diff​ is preferred here as it simply fixes the specific issue being reported without additional refactoring.

[desrosj]

In 54239:

Bootstrap/Load: Confirm the value of WP_ENVIRONMENT_TYPE before using.

This adjusts the check for the presence of the WP_ENVIRONMENT_TYPE constant to also confirm it is set to a non-empty value before using.

Props dd32, khokansardar, ramon-fincken.
Fixes #55741.

Merged in https://core.trac.wordpress.org/changeset/54239.

[ramon fincken]

Yes this will suffice @desrosj

I went perhaps a bit too far introducing the filter.

Will still love if the if/else/check was just 1 central function as having duplicate code will/might lead to issues later on.

[desrosj]

@ramon-fincken I’m still open to exploring it, but think it’s best in a new ticket.