Changeset 47122 for trunk/src/wp-mail.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/src/wp-mail.php (modified) (5 diffs)

trunk/src/wp-mail.php

@@ -34 +34 @@
 /** Only check at this interval for new messages. */
 if ( ! defined( 'WP_MAIL_INTERVAL' ) ) {
-    define( 'WP_MAIL_INTERVAL', 300 ); // 5 minutes
+    define( 'WP_MAIL_INTERVAL', 5 * MINUTE_IN_SECONDS );
 }
 
@@ -110 +110 @@
                 $subject = trim( $line );
                 $subject = substr( $subject, 9, strlen( $subject ) - 9 );
-                // Captures any text in the subject before $phone_delim as the subject
+                // Captures any text in the subject before $phone_delim as the subject.
                 if ( function_exists( 'iconv_mime_decode' ) ) {
                     $subject = iconv_mime_decode( $subject, 2, get_option( 'blog_charset' ) );
@@ -142 +142 @@
             }
 
-            if ( preg_match( '/Date: /i', $line ) ) { // of the form '20 Mar 2002 20:32:37 +0100'
-                $ddate           = str_replace( 'Date: ', '', trim( $line ) );
-                $ddate           = preg_replace( '!\s*\(.+\)\s*$!', '', $ddate ); // remove parenthesised timezone string if it exists, as this confuses strtotime
+            if ( preg_match( '/Date: /i', $line ) ) { // Of the form '20 Mar 2002 20:32:37 +0100'.
+                $ddate = str_replace( 'Date: ', '', trim( $line ) );
+                // Remove parenthesised timezone string if it exists, as this confuses strtotime().
+                $ddate           = preg_replace( '!\s*\(.+\)\s*$!', '', $ddate );
                 $ddate_timestamp = strtotime( $ddate );
                 $post_date       = gmdate( 'Y-m-d H:i:s', $ddate_timestamp + $time_difference );
@@ -152 +153 @@
     }
 
-    // Set $post_status based on $author_found and on author's publish_posts capability
+    // Set $post_status based on $author_found and on author's publish_posts capability.
     if ( $author_found ) {
         $user        = new WP_User( $post_author );
@@ -196 +197 @@
     }
 
-    // Captures any text in the body after $phone_delim as the body
+    // Captures any text in the body after $phone_delim as the body.
     $content = explode( $phone_delim, $content );
     $content = empty( $content[1] ) ? $content[0] : $content[1];