Changeset 59291

Timestamp:

10/25/2024 08:24:08 PM (2 years ago)

Author:

SergeyBiryukov

Message:

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 [59039], [59288].

See #62281.

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();
 
+        // Increase the script timeout limit to allow ample time for diff UI setup.
         if ( function_exists( 'set_time_limit' ) ) {
-                // Increase the script timeout limit to allow ample time for diff UI setup.
                 set_time_limit( 5 * MINUTE_IN_SECONDS );
         }

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

@@ -526 +526 @@
                 $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.
+                /*
+                 * 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

@@ -971 +971 @@
         global $wp_filesystem, $_old_files, $_old_requests_files, $_new_bundled_files, $wpdb;
 
+        /*
+         * Give core update script an additional 300 seconds (5 minutes)
+         * to finish updating large files when running on slower servers.
+         */
         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

@@ -60 +60 @@
             settype($timeout,"integer");
             $this->TIMEOUT = $timeout;
+            // Extend POP3 request timeout to the specified TIMEOUT property.
             if(function_exists("set_time_limit")){
-                // Extends POP3 request timeout to specified TIMEOUT property.
                 set_time_limit($timeout);
             }
@@ -76 +76 @@
 
     function update_timer () {
+        // Extend POP3 request timeout to the specified TIMEOUT property.
         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

@@ -3121 +3121 @@
 
                 if ( $pingback_server_url ) {
+                        // Allow an additional 60 seconds for each pingback to complete.
                         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.
+        // Add 60 seconds to the script timeout to ensure the remote request has enough time.
         if ( function_exists( 'set_time_limit' ) ) {
                 @set_time_limit( 60 );