<!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>[54113] trunk/src: Coding Standards: Clarify time units for various timeout or expiration values.</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/54113">54113</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/54113","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-09-09 08:14:43 +0000 (Fri, 09 Sep 2022)</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'>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 <a href="https://core.trac.wordpress.org/changeset/11823">[11823]</a>, <a href="https://core.trac.wordpress.org/changeset/13177">[13177]</a>, <a href="https://core.trac.wordpress.org/changeset/21996">[21996]</a>, <a href="https://core.trac.wordpress.org/changeset/37747">[37747]</a>, <a href="https://core.trac.wordpress.org/changeset/53714">[53714]</a>.
Props hztyfoon, audrasjb, arrasel403, krupalpanchal, GaryJ, SergeyBiryukov, peterwilsoncc, rudlinkon, costdev, robinwpdeveloper.
Fixes <a href="https://core.trac.wordpress.org/ticket/56293">#56293</a>.
See <a href="https://core.trac.wordpress.org/ticket/55647">#55647</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpdebugdataphp">trunk/src/wp-admin/includes/class-wp-debug-data.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpsitehealthphp">trunk/src/wp-admin/includes/class-wp-site-health.php</a></li>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
<li><a href="#trunksrcwpadminoptionspermalinkphp">trunk/src/wp-admin/options-permalink.php</a></li>
<li><a href="#trunksrcwpadminoptionsphp">trunk/src/wp-admin/options.php</a></li>
<li><a href="#trunksrcwpincludesupdatephp">trunk/src/wp-includes/update.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpdebugdataphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-debug-data.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-debug-data.php 2022-09-09 02:17:33 UTC (rev 54112)
+++ trunk/src/wp-admin/includes/class-wp-debug-data.php 2022-09-09 08:14:43 UTC (rev 54113)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1597,7 +1597,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // The max_execution_time defaults to 0 when PHP runs from cli.
</span><span class="cx" style="display: block; padding: 0 10px"> // We still want to limit it below.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $max_execution_time ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $max_execution_time = 30;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $max_execution_time = 30; // 30 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $max_execution_time > 20 ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpsitehealthphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-site-health.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-site-health.php 2022-09-09 02:17:33 UTC (rev 54112)
+++ trunk/src/wp-admin/includes/class-wp-site-health.php 2022-09-09 08:14:43 UTC (rev 54113)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2029,7 +2029,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $cookies = wp_unslash( $_COOKIE );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timeout = 10;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $timeout = 10; // 10 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> $headers = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'Cache-Control' => 'no-cache',
</span><span class="cx" style="display: block; padding: 0 10px"> 'X-WP-Nonce' => wp_create_nonce( 'wp_rest' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2885,7 +2885,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function can_perform_loopback() {
</span><span class="cx" style="display: block; padding: 0 10px"> $body = array( 'site-health' => 'loopback-test' );
</span><span class="cx" style="display: block; padding: 0 10px"> $cookies = wp_unslash( $_COOKIE );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timeout = 10;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $timeout = 10; // 10 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> $headers = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'Cache-Control' => 'no-cache',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre></div>
<a id="trunksrcwpadminincludesfilephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/file.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php 2022-09-09 02:17:33 UTC (rev 54112)
+++ trunk/src/wp-admin/includes/file.php 2022-09-09 08:14:43 UTC (rev 54113)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -539,10 +539,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Make sure PHP process doesn't die before loopback requests complete.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- set_time_limit( 300 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ set_time_limit( 5 * MINUTE_IN_SECONDS );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Time to wait for loopback requests to finish.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timeout = 100;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $timeout = 100; // 100 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $needle_start = "###### wp_scraping_result_start:$scrape_key ######";
</span><span class="cx" style="display: block; padding: 0 10px"> $needle_end = "###### wp_scraping_result_end:$scrape_key ######";
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2007,10 +2007,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * to allow for per-transport overriding of the default.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! defined( 'FS_CONNECT_TIMEOUT' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- define( 'FS_CONNECT_TIMEOUT', MINUTE_IN_SECONDS / 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ define( 'FS_CONNECT_TIMEOUT', 30 ); // 30 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! defined( 'FS_TIMEOUT' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- define( 'FS_TIMEOUT', MINUTE_IN_SECONDS / 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ define( 'FS_TIMEOUT', 30 ); // 30 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $wp_filesystem->errors ) && $wp_filesystem->errors->has_errors() ) {
</span></span></pre></div>
<a id="trunksrcwpadminoptionspermalinkphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/options-permalink.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/options-permalink.php 2022-09-09 02:17:33 UTC (rev 54112)
+++ trunk/src/wp-admin/options-permalink.php 2022-09-09 08:14:43 UTC (rev 54113)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,7 +203,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_settings_error( 'general', 'settings_updated', $message, 'success' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- set_transient( 'settings_errors', get_settings_errors(), MINUTE_IN_SECONDS / 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ set_transient( 'settings_errors', get_settings_errors(), 30 ); // 30 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_redirect( admin_url( 'options-permalink.php?settings-updated=true' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> exit;
</span></span></pre></div>
<a id="trunksrcwpadminoptionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/options.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/options.php 2022-09-09 02:17:33 UTC (rev 54112)
+++ trunk/src/wp-admin/options.php 2022-09-09 08:14:43 UTC (rev 54113)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,7 +345,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_settings_error( 'general', 'settings_updated', __( 'Settings saved.' ), 'success' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- set_transient( 'settings_errors', get_settings_errors(), MINUTE_IN_SECONDS / 2 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ set_transient( 'settings_errors', get_settings_errors(), 30 ); // 30 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Redirect back to the settings page that was submitted.
</span><span class="cx" style="display: block; padding: 0 10px"> $goback = add_query_arg( 'settings-updated', 'true', wp_get_referer() );
</span></span></pre></div>
<a id="trunksrcwpincludesupdatephp"></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/update.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/update.php 2022-09-09 02:17:33 UTC (rev 54112)
+++ trunk/src/wp-includes/update.php 2022-09-09 08:14:43 UTC (rev 54113)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -405,7 +405,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $locales = array_unique( $locales );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $doing_cron ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timeout = 30;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $timeout = 30; // 30 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // Three seconds, plus one extra second for every 10 plugins.
</span><span class="cx" style="display: block; padding: 0 10px"> $timeout = 3 + (int) ( count( $plugins ) / 10 );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -687,7 +687,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $locales = array_unique( $locales );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $doing_cron ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $timeout = 30;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $timeout = 30; // 30 seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> // Three seconds, plus one extra second for every 10 themes.
</span><span class="cx" style="display: block; padding: 0 10px"> $timeout = 3 + (int) ( count( $themes ) / 10 );
</span></span></pre>
</div>
</div>
</body>
</html>