Changeset 54113

Timestamp:

09/09/2022 08:14:43 AM (4 years ago)

Author:

audrasjb

Message:

Coding Standards: Clarify time units for various timeout or expiration values.

This changeset implements a clearer and more consistent timeout/duration/expiration format. It updates time durations used in various files, as per WordPress coding standards:

• If the value can be represented as an integer (not a fractional) number of minutes (hours, etc.), use the appropriate constant (e.g.: MINUTE_IN_SECONDS) multiplied by that number.
• Otherwise, keep the value as is and add a comment with the units for clarity.

Follow-up to [11823], [13177], [21996], [37747], [53714].

Props hztyfoon, audrasjb, arrasel403, krupalpanchal, GaryJ, SergeyBiryukov, peterwilsoncc, rudlinkon, costdev, robinwpdeveloper.
Fixes #56293.
See #55647.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-debug-data.php (modified) (1 diff)
• wp-admin/includes/class-wp-site-health.php (modified) (2 diffs)
• wp-admin/includes/file.php (modified) (2 diffs)
• wp-admin/options-permalink.php (modified) (1 diff)
• wp-admin/options.php (modified) (1 diff)
• wp-includes/update.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-debug-data.php

@@ -1598 +1598 @@
                 // We still want to limit it below.
                 if ( empty( $max_execution_time ) ) {
-                        $max_execution_time = 30;
+                        $max_execution_time = 30; // 30 seconds.
                 }
 

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -2030 +2030 @@
 
                 $cookies = wp_unslash( $_COOKIE );
-                $timeout = 10;
+                $timeout = 10; // 10 seconds.
                 $headers = array(
                         'Cache-Control' => 'no-cache',
@@ -2886 +2886 @@
                 $body    = array( 'site-health' => 'loopback-test' );
                 $cookies = wp_unslash( $_COOKIE );
-                $timeout = 10;
+                $timeout = 10; // 10 seconds.
                 $headers = array(
                         'Cache-Control' => 'no-cache',

trunk/src/wp-admin/includes/file.php

@@ -540 +540 @@
 
                 // Make sure PHP process doesn't die before loopback requests complete.
-                set_time_limit( 300 );
+                set_time_limit( 5 * MINUTE_IN_SECONDS );
 
                 // Time to wait for loopback requests to finish.
-                $timeout = 100;
+                $timeout = 100; // 100 seconds.
 
                 $needle_start = "###### wp_scraping_result_start:$scrape_key ######";
@@ -2008 +2008 @@
          */
         if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {
-                define( 'FS_CONNECT_TIMEOUT', MINUTE_IN_SECONDS / 2 );
+                define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds.
         }
         if ( ! defined( 'FS_TIMEOUT' ) ) {
-                define( 'FS_TIMEOUT', MINUTE_IN_SECONDS / 2 );
+                define( 'FS_TIMEOUT', 30 ); // 30 seconds.
         }
 

trunk/src/wp-admin/options-permalink.php

@@ -204 +204 @@
         }
 
-        set_transient( 'settings_errors', get_settings_errors(), MINUTE_IN_SECONDS / 2 );
+        set_transient( 'settings_errors', get_settings_errors(), 30 ); // 30 seconds.
 
         wp_redirect( admin_url( 'options-permalink.php?settings-updated=true' ) );

trunk/src/wp-admin/options.php

@@ -346 +346 @@
         }
 
-        set_transient( 'settings_errors', get_settings_errors(), MINUTE_IN_SECONDS / 2 );
+        set_transient( 'settings_errors', get_settings_errors(), 30 ); // 30 seconds.
 
         // Redirect back to the settings page that was submitted.

trunk/src/wp-includes/update.php

@@ -406 +406 @@
 
         if ( $doing_cron ) {
-                $timeout = 30;
+                $timeout = 30; // 30 seconds.
         } else {
                 // Three seconds, plus one extra second for every 10 plugins.
@@ -688 +688 @@
 
         if ( $doing_cron ) {
-                $timeout = 30;
+                $timeout = 30; // 30 seconds.
         } else {
                 // Three seconds, plus one extra second for every 10 themes.