Changeset 56223

Timestamp:

07/13/2023 12:27:06 AM (17 months ago)

Author:

peterwilsoncc

Message:

General: Introduce all development mode.

Introduce the development mode all as a a cover-all mode for the existing theme, plugin and core development modes. Developers can use the all mode if they are developing both themes and plugins, for example.

Introduce the utility function wp_in_development_mode() allowing developers to detect the mode via a parameter. If the development mode is set to all this function will always return true. If the development mode is specific then only the chosen mode will return true.

Follow up to [56079,56042].

Props flixos90.
Fixes #57487.

Location:

trunk

Files:

• src/wp-includes/blocks/index.php (modified) (1 diff)
• src/wp-includes/default-constants.php (modified) (1 diff)
• src/wp-includes/deprecated.php (modified) (1 diff)
• src/wp-includes/global-styles-and-settings.php (modified) (4 diffs)
• src/wp-includes/load.php (modified) (3 diffs)
• tests/phpunit/tests/load/wpGetDevelopmentMode.php (modified) (2 diffs)

trunk/src/wp-includes/blocks/index.php

@@ -45 +45 @@
      * the core developer's workflow.
      */
-    if ( 'core' !== wp_get_development_mode() ) {
+    if ( ! wp_in_development_mode( 'core' ) ) {
         $transient_name = 'wp_core_block_css_files';
         $files          = get_transient( $transient_name );

trunk/src/wp-includes/default-constants.php

@@ -80 +80 @@
     /*
      * Add define( 'WP_DEVELOPMENT_MODE', 'core' ) or define( 'WP_DEVELOPMENT_MODE', 'plugin' ) or
-     * define( 'WP_DEVELOPMENT_MODE', 'theme' ) to wp-config.php to signify development mode for WordPress core, a
-     * plugin, or a theme respectively.
+     * define( 'WP_DEVELOPMENT_MODE', 'theme' ) or define( 'WP_DEVELOPMENT_MODE', 'all' ) to wp-config.php
+     * to signify development mode for WordPress core, a plugin, a theme, or all three types respectively.
      */
     if ( ! defined( 'WP_DEVELOPMENT_MODE' ) ) {

trunk/src/wp-includes/deprecated.php

@@ -5234 +5234 @@
      * developer's workflow.
      */
-    $can_use_cached = wp_get_development_mode() !== 'theme';
+    $can_use_cached = ! wp_in_development_mode( 'theme' );
     $cache_group    = 'theme_json';
     $cache_key      = 'wp_get_global_styles_svg_filters';

trunk/src/wp-includes/global-styles-and-settings.php

@@ -70 +70 @@
      * developer's workflow.
      */
-    $can_use_cached = wp_get_development_mode() !== 'theme';
+    $can_use_cached = ! wp_in_development_mode( 'theme' );
 
     $settings = false;
@@ -153 +153 @@
      * developer's workflow.
      */
-    $can_use_cached = empty( $types ) && wp_get_development_mode() !== 'theme';
+    $can_use_cached = empty( $types ) && ! wp_in_development_mode( 'theme' );
 
     /*
@@ -252 +252 @@
      * developer's workflow.
      */
-    $can_use_cached = wp_get_development_mode() !== 'theme';
+    $can_use_cached = ! wp_in_development_mode( 'theme' );
 
     /*
@@ -361 +361 @@
          * the theme developer's workflow.
          */
-        wp_get_development_mode() !== 'theme'
+        ! wp_in_development_mode( 'theme' )
     ) {
         return $theme_has_support[ $stylesheet ];

trunk/src/wp-includes/load.php

@@ -272 +272 @@
  * developing for WordPress.
  *
- * Valid developer modes are 'core', 'plugin', 'theme', or an empty string to disable developer mode.
+ * Valid development modes are 'core', 'plugin', 'theme', 'all', or an empty string to disable development mode.
+ * 'all' is a special value to signify that all three development modes 'core', 'plugin', and 'theme' are enabled.
  *
  * Developer mode is considered separately from `WP_DEBUG` and {@see wp_get_environment_type()}. It does not affect
  * debugging output, but rather functional nuances in WordPress.
+ *
+ * This function controls the currently set development mode value. To check for whether a specific development mode is
+ * enabled, use wp_in_development_mode().
  *
  * @since 6.3.0
@@ -299 +303 @@
         'plugin',
         'theme',
+        'all',
         '',
     );
@@ -308 +313 @@
 
     return $current_mode;
+}
+
+/**
+ * Checks whether the site is in the given development mode.
+ *
+ * @since 6.3.0
+ *
+ * @param string $mode Development mode to check for. Either 'core', 'plugin', 'theme', or 'all'.
+ * @return bool True if the given mode is covered by the current development mode, false otherwise.
+ */
+function wp_in_development_mode( $mode ) {
+    $current_mode = wp_get_development_mode();
+    if ( empty( $current_mode ) ) {
+        return false;
+    }
+
+    // Return true if the current mode encompasses all modes.
+    if ( 'all' === $current_mode ) {
+        return true;
+    }
+
+    // Return true if the current mode is the given mode.
+    return $mode === $current_mode;
 }
 

trunk/tests/phpunit/tests/load/wpGetDevelopmentMode.php

@@ -9 +9 @@
  * @group load.php
  * @covers ::wp_get_development_mode
+ * @covers ::wp_in_development_mode
  */
 class Test_WP_Get_Development_Mode extends WP_UnitTestCase {
@@ -44 +45 @@
         $this->assertSame( '', wp_get_development_mode() );
     }
+
+    /**
+     * Tests that `wp_in_development_mode()` returns expected results.
+     *
+     * @ticket 57487
+     * @dataProvider data_wp_in_development_mode
+     */
+    public function test_wp_in_development_mode( $current, $given, $expected ) {
+        global $_wp_tests_development_mode;
+
+        $_wp_tests_development_mode = $current;
+
+        if ( $expected ) {
+            $this->assertTrue( wp_in_development_mode( $given ), "{$given} is expected to pass in {$current} mode" );
+        } else {
+            $this->assertFalse( wp_in_development_mode( $given ), "{$given} is expected to fail in {$current} mode" );
+        }
+    }
+
+    /**
+     * Data provider that returns test scenarios for the `test_wp_in_development_mode()` method.
+     *
+     * @return array[]
+     */
+    public function data_wp_in_development_mode() {
+        return array(
+            'core mode, testing for core'              => array(
+                'core',
+                'core',
+                true,
+            ),
+            'plugin mode, testing for plugin'          => array(
+                'plugin',
+                'plugin',
+                true,
+            ),
+            'theme mode, testing for theme'            => array(
+                'theme',
+                'theme',
+                true,
+            ),
+            'core mode, testing for plugin'            => array(
+                'core',
+                'plugin',
+                false,
+            ),
+            'core mode, testing for theme'             => array(
+                'core',
+                'theme',
+                false,
+            ),
+            'plugin mode, testing for core'            => array(
+                'plugin',
+                'core',
+                false,
+            ),
+            'plugin mode, testing for theme'           => array(
+                'plugin',
+                'theme',
+                false,
+            ),
+            'theme mode, testing for core'             => array(
+                'theme',
+                'core',
+                false,
+            ),
+            'theme mode, testing for plugin'           => array(
+                'theme',
+                'plugin',
+                false,
+            ),
+            'all mode, testing for core'               => array(
+                'all',
+                'core',
+                true,
+            ),
+            'all mode, testing for plugin'             => array(
+                'all',
+                'plugin',
+                true,
+            ),
+            'all mode, testing for theme'              => array(
+                'all',
+                'theme',
+                true,
+            ),
+            'all mode, testing for all'                => array(
+                'all',
+                'all',
+                true,
+            ),
+            'all mode, testing for non-standard value' => array(
+                'all',
+                'random',
+                true,
+            ),
+            'invalid mode, testing for core'           => array(
+                'invalid',
+                'core',
+                false,
+            ),
+            'invalid mode, testing for plugin'         => array(
+                'invalid',
+                'plugin',
+                false,
+            ),
+            'invalid mode, testing for theme'          => array(
+                'invalid',
+                'theme',
+                false,
+            ),
+        );
+    }
 }