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.
Built from https://develop.svn.wordpress.org/trunk@59291


git-svn-id: http://core.svn.wordpress.org/trunk@58683 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2024-10-25 20:26:20 +00:00
parent db2845d2a0
commit aed49756e0
7 changed files with 15 additions and 8 deletions

View File

@ -3556,8 +3556,8 @@ function wp_ajax_get_revision_diffs() {
$return = array(); $return = array();
if ( function_exists( 'set_time_limit' ) ) {
// Increase the script timeout limit to allow ample time for diff UI setup. // Increase the script timeout limit to allow ample time for diff UI setup.
if ( function_exists( 'set_time_limit' ) ) {
set_time_limit( 5 * MINUTE_IN_SECONDS ); set_time_limit( 5 * MINUTE_IN_SECONDS );
} }

View File

@ -525,7 +525,11 @@ class WP_Upgrader {
$destination = $args['destination']; $destination = $args['destination'];
$clear_destination = $args['clear_destination']; $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' ) ) { if ( function_exists( 'set_time_limit' ) ) {
set_time_limit( 300 ); set_time_limit( 300 );
} }

View File

@ -970,8 +970,11 @@ $_new_bundled_files = array(
function update_core( $from, $to ) { function update_core( $from, $to ) {
global $wp_filesystem, $_old_files, $_old_requests_files, $_new_bundled_files, $wpdb; 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' ) ) { 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 ); set_time_limit( 300 );
} }

View File

@ -59,8 +59,8 @@ class POP3 {
if(!empty($timeout)) { if(!empty($timeout)) {
settype($timeout,"integer"); settype($timeout,"integer");
$this->TIMEOUT = $timeout; $this->TIMEOUT = $timeout;
// Extend POP3 request timeout to the specified TIMEOUT property.
if(function_exists("set_time_limit")){ if(function_exists("set_time_limit")){
// Extends POP3 request timeout to specified TIMEOUT property.
set_time_limit($timeout); set_time_limit($timeout);
} }
} }
@ -75,8 +75,8 @@ class POP3 {
} }
function update_timer () { function update_timer () {
// Extend POP3 request timeout to the specified TIMEOUT property.
if(function_exists("set_time_limit")){ 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); set_time_limit($this->TIMEOUT);
} }
return true; return true;

View File

@ -3120,8 +3120,8 @@ function pingback( $content, $post ) {
$pingback_server_url = discover_pingback_server_uri( $pagelinkedto ); $pingback_server_url = discover_pingback_server_uri( $pagelinkedto );
if ( $pingback_server_url ) { if ( $pingback_server_url ) {
// Allow an additional 60 seconds for each pingback to complete.
if ( function_exists( 'set_time_limit' ) ) { if ( function_exists( 'set_time_limit' ) ) {
// Allows an additional 60 seconds for each pingback to complete.
set_time_limit( 60 ); set_time_limit( 60 );
} }

View File

@ -3673,7 +3673,7 @@ function post_permalink( $post = 0 ) {
function wp_get_http( $url, $file_path = false, $red = 1 ) { function wp_get_http( $url, $file_path = false, $red = 1 ) {
_deprecated_function( __FUNCTION__, '4.4.0', 'WP_Http' ); _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' ) ) { if ( function_exists( 'set_time_limit' ) ) {
@set_time_limit( 60 ); @set_time_limit( 60 );
} }

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.8-alpha-59290'; $wp_version = '6.8-alpha-59291';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.