<!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>[59291] trunk/src: Docs: Adjust comments about `set_time_limit()` per the documentation standards.</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/59291">59291</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/59291","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>2024-10-25 20:24:08 +0000 (Fri, 25 Oct 2024)</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'>Docs: Adjust comments about `set_time_limit()` per the documentation standards.
Includes splitting long comments into multiple lines and moving a few comments above the `function_exists()` check for more consistent placement.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/59039">[59039]</a>, <a href="https://core.trac.wordpress.org/changeset/59288">[59288]</a>.
See <a href="https://core.trac.wordpress.org/ticket/62281">#62281</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesajaxactionsphp">trunk/src/wp-admin/includes/ajax-actions.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpupgraderphp">trunk/src/wp-admin/includes/class-wp-upgrader.php</a></li>
<li><a href="#trunksrcwpadminincludesupdatecorephp">trunk/src/wp-admin/includes/update-core.php</a></li>
<li><a href="#trunksrcwpincludesclasspop3php">trunk/src/wp-includes/class-pop3.php</a></li>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
<li><a href="#trunksrcwpincludesdeprecatedphp">trunk/src/wp-includes/deprecated.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesajaxactionsphp"></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/ajax-actions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ajax-actions.php 2024-10-25 01:18:54 UTC (rev 59290)
+++ trunk/src/wp-admin/includes/ajax-actions.php 2024-10-25 20:24:08 UTC (rev 59291)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3556,8 +3556,8 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $return = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Increase the script timeout limit to allow ample time for diff UI setup.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'set_time_limit' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Increase the script timeout limit to allow ample time for diff UI setup.
</del><span class="cx" style="display: block; padding: 0 10px"> set_time_limit( 5 * MINUTE_IN_SECONDS );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpupgraderphp"></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-upgrader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-upgrader.php 2024-10-25 01:18:54 UTC (rev 59290)
+++ trunk/src/wp-admin/includes/class-wp-upgrader.php 2024-10-25 20:24:08 UTC (rev 59291)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -525,7 +525,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $destination = $args['destination'];
</span><span class="cx" style="display: block; padding: 0 10px"> $clear_destination = $args['clear_destination'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Give the upgrade an additional 300 seconds(5 minutes) to ensure the install doesn't prematurely timeout having used up the maximum script execution time upacking and downloading in WP_Upgrader->run.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Give the upgrade an additional 300 seconds (5 minutes) to ensure the install
+ * doesn't prematurely timeout having used up the maximum script execution time
+ * upacking and downloading in WP_Upgrader->run().
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'set_time_limit' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> set_time_limit( 300 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpadminincludesupdatecorephp"></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/update-core.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/update-core.php 2024-10-25 01:18:54 UTC (rev 59290)
+++ trunk/src/wp-admin/includes/update-core.php 2024-10-25 20:24:08 UTC (rev 59291)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -970,8 +970,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function update_core( $from, $to ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filesystem, $_old_files, $_old_requests_files, $_new_bundled_files, $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Give core update script an additional 300 seconds (5 minutes)
+ * to finish updating large files when running on slower servers.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'set_time_limit' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Gives core update script time an additional 300 seconds(5 minutes) to finish updating large files or run on slower servers.
</del><span class="cx" style="display: block; padding: 0 10px"> set_time_limit( 300 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesclasspop3php"></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/class-pop3.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-pop3.php 2024-10-25 01:18:54 UTC (rev 59290)
+++ trunk/src/wp-includes/class-pop3.php 2024-10-25 20:24:08 UTC (rev 59291)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,8 +59,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if(!empty($timeout)) {
</span><span class="cx" style="display: block; padding: 0 10px"> settype($timeout,"integer");
</span><span class="cx" style="display: block; padding: 0 10px"> $this->TIMEOUT = $timeout;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Extend POP3 request timeout to the specified TIMEOUT property.
</ins><span class="cx" style="display: block; padding: 0 10px"> if(function_exists("set_time_limit")){
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Extends POP3 request timeout to specified TIMEOUT property.
</del><span class="cx" style="display: block; padding: 0 10px"> set_time_limit($timeout);
</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">@@ -75,8 +75,8 @@
</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"> function update_timer () {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Extend POP3 request timeout to the specified TIMEOUT property.
</ins><span class="cx" style="display: block; padding: 0 10px"> if(function_exists("set_time_limit")){
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allows additional extension of POP3 request timeout to specified TIMEOUT property when update_timer is called.
</del><span class="cx" style="display: block; padding: 0 10px"> set_time_limit($this->TIMEOUT);
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span></span></pre></div>
<a id="trunksrcwpincludescommentphp"></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/comment.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/comment.php 2024-10-25 01:18:54 UTC (rev 59290)
+++ trunk/src/wp-includes/comment.php 2024-10-25 20:24:08 UTC (rev 59291)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3120,8 +3120,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $pingback_server_url = discover_pingback_server_uri( $pagelinkedto );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $pingback_server_url ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Allow an additional 60 seconds for each pingback to complete.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'set_time_limit' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allows an additional 60 seconds for each pingback to complete.
</del><span class="cx" style="display: block; padding: 0 10px"> set_time_limit( 60 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesdeprecatedphp"></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/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/deprecated.php 2024-10-25 01:18:54 UTC (rev 59290)
+++ trunk/src/wp-includes/deprecated.php 2024-10-25 20:24:08 UTC (rev 59291)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3673,7 +3673,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_get_http( $url, $file_path = false, $red = 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '4.4.0', 'WP_Http' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Adds an additional 60 seconds to the script timeout to ensure the remote request has enough time.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add 60 seconds to the script timeout to ensure the remote request has enough time.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'set_time_limit' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> @set_time_limit( 60 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>