Changeset 29763

Timestamp:

09/23/2014 06:48:31 PM (12 years ago)

Author:

DrewAPicture

Message:

Improve and clarify inline commenting inside the check_comment() function.

Adds logical explanations of what some of the various comment checks are checking for, as well as some general cleanup and syntax fixes.

Fixes #29734.

File:

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

trunk/src/wp-includes/comment.php

@@ -40 +40 @@
         global $wpdb;
 
+        // If manual moderation is enabled, skip all checks and return false.
         if ( 1 == get_option('comment_moderation') )
-                return false; // If moderation is set to manual
+                return false;
 
         /** This filter is documented in wp-includes/comment-template.php */
         $comment = apply_filters( 'comment_text', $comment );
 
-        // Check # of external links
+        // Check for the number of external links if a max allowed number is set.
         if ( $max_links = get_option( 'comment_max_links' ) ) {
                 $num_links = preg_match_all( '/<a [^>]*href/i', $comment, $out );
+
                 /**
                  * Filter the maximum number of links allowed in a comment.
@@ -58 +60 @@
                  */
                 $num_links = apply_filters( 'comment_max_links_url', $num_links, $url );
+
+                /*
+                 * If the number of links in the comment exceeds the allowed amount,
+                 * fail the check by returning false.
+                 */
                 if ( $num_links >= $max_links )
                         return false;
@@ -63 +70 @@
 
         $mod_keys = trim(get_option('moderation_keys'));
+
+        // If moderation 'keys' (keywords) are set, process them.
         if ( !empty($mod_keys) ) {
                 $words = explode("\n", $mod_keys );
@@ -69 +78 @@
                         $word = trim($word);
 
-                        // Skip empty lines
+                        // Skip empty lines.
                         if ( empty($word) )
                                 continue;
 
-                        // Do some escaping magic so that '#' chars in the
-                        // spam words don't break things:
+                        /*
+                         * Do some escaping magic so that '#' (number of) characters in the spam
+                         * words don't break things:
+                         */
                         $word = preg_quote($word, '#');
 
+                        /*
+                         * Check the comment fields for moderation keywords. If any are found,
+                         * fail the check for the given field by returning false.
+                         */
                         $pattern = "#$word#i";
                         if ( preg_match($pattern, $author) ) return false;
@@ -87 +102 @@
         }
 
-        // Comment whitelisting:
+        /*
+         * Check if the option to approve comments by previously-approved authors is enabled.
+         *
+         * If it is enabled, check whether the comment author has a previously-approved comment,
+         * as well as whether there are any moderation keywords (if set) present in the author
+         * email address. If both checks pass, return true. Otherwise, return false.
+         */
         if ( 1 == get_option('comment_whitelist')) {
                 if ( 'trackback' != $comment_type && 'pingback' != $comment_type && $author != '' && $email != '' ) {