Changeset 59039

Timestamp:

09/17/2024 10:39:58 PM (4 weeks ago)

Author:

jorbin

Message:

Bootstrap/Load: Ensure uses of set_time_limit are documented why.

set_time_limit can cause unexpected behavior so it general should be avoided. There are instances though where they should be used so those instances should be properly documented.

Props Rcrayno, ryan, kurtpayne, jorbin.
Fixes #21521. See #19487.

Location:

trunk/src

Files:

• wp-admin/includes/ajax-actions.php (modified) (1 diff)
• wp-admin/includes/class-wp-upgrader.php (modified) (1 diff)
• wp-admin/includes/update-core.php (modified) (1 diff)
• wp-includes/class-pop3.php (modified) (2 diffs)
• wp-includes/comment.php (modified) (1 diff)
• wp-includes/deprecated.php (modified) (1 diff)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -3557 +3557 @@
     $return = array();
 
+    // Removes the script timeout limit by setting it to 0 allowing ample time for diff UI setup.
     if ( function_exists( 'set_time_limit' ) ) {
         set_time_limit( 0 );

trunk/src/wp-admin/includes/class-wp-upgrader.php

@@ -525 +525 @@
         $clear_destination = $args['clear_destination'];
 
+        // 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.
         if ( function_exists( 'set_time_limit' ) ) {
             set_time_limit( 300 );

trunk/src/wp-admin/includes/update-core.php

@@ -963 +963 @@
 
     if ( function_exists( 'set_time_limit' ) ) {
+        // Gives core update script time an additional 300 seconds(5 minutes) to finish updating large files or run on slower servers.
         set_time_limit( 300 );
     }

trunk/src/wp-includes/class-pop3.php

@@ -61 +61 @@
             $this->TIMEOUT = $timeout;
             if(function_exists("set_time_limit")){
+                // Extends POP3 request timeout to specified TIMEOUT property.
                 set_time_limit($timeout);
             }
@@ -76 +77 @@
     function update_timer () {
         if(function_exists("set_time_limit")){
+            // Allows additional extension of POP3 request timeout to specified TIMEOUT property when update_timer is called.
             set_time_limit($this->TIMEOUT);
         }

trunk/src/wp-includes/comment.php

@@ -3117 +3117 @@
         if ( $pingback_server_url ) {
             if ( function_exists( 'set_time_limit' ) ) {
+                // Allows an additional 60 seconds for each pingback to complete.
                 set_time_limit( 60 );
             }

trunk/src/wp-includes/deprecated.php

@@ -3674 +3674 @@
     _deprecated_function( __FUNCTION__, '4.4.0', 'WP_Http' );
 
+    // Adds an additional 60 seconds to the script timeout to ensure the remote request has enough time.
     if ( function_exists( 'set_time_limit' ) ) {
         @set_time_limit( 60 );