Changeset 47122 for trunk/src/wp-includes/comment-template.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-includes/comment-template.php (modified) (11 diffs)

trunk/src/wp-includes/comment-template.php

@@ -431 +431 @@
  */
 function comment_class( $class = '', $comment = null, $post_id = null, $echo = true ) {
-    // Separates classes with a single space, collates classes for comment DIV
+    // Separates classes with a single space, collates classes for comment DIV.
     $class = 'class="' . join( ' ', get_comment_class( $class, $comment, $post_id ) ) . '"';
 
@@ -466 +466 @@
     }
 
-    // Get the comment type (comment, trackback),
+    // Get the comment type (comment, trackback).
     $classes[] = ( empty( $comment->comment_type ) ) ? 'comment' : $comment->comment_type;
 
@@ -474 +474 @@
         $classes[] = 'byuser';
         $classes[] = 'comment-author-' . sanitize_html_class( $user->user_nicename, $comment->user_id );
-        // For comment authors who are the author of the post
+        // For comment authors who are the author of the post.
         $post = get_post( $post_id );
         if ( $post ) {
@@ -502 +502 @@
     $comment_alt++;
 
-    // Alt for top-level comments
+    // Alt for top-level comments.
     if ( 1 == $comment_depth ) {
         if ( $comment_thread_alt % 2 ) {
@@ -908 +908 @@
             if ( 'on' === _x( 'off', 'Comment number declension: on or off' ) ) {
                 $text = preg_replace( '#<span class="screen-reader-text">.+?</span>#', '', $more );
-                $text = preg_replace( '/&.+?;/', '', $text ); // Kill entities
+                $text = preg_replace( '/&.+?;/', '', $text ); // Kill entities.
                 $text = trim( strip_tags( $text ), '% ' );
 
-                // Replace '% Comments' with a proper plural form
+                // Replace '% Comments' with a proper plural form.
                 if ( $text && ! preg_match( '/[0-9]+/', $text ) && false !== strpos( $more, '%' ) ) {
                     /* translators: %s: Number of comments. */
@@ -928 +928 @@
     } elseif ( $number == 0 ) {
         $output = ( false === $zero ) ? __( 'No Comments' ) : $zero;
-    } else { // must be one
+    } else { // Must be one.
         $output = ( false === $one ) ? __( '1 Comment' ) : $one;
     }
@@ -1527 +1527 @@
     } elseif ( file_exists( TEMPLATEPATH . $file ) ) {
         require( TEMPLATEPATH . $file );
-    } else { // Backward compat code will be removed in a future release
+    } else { // Backward compat code will be removed in a future release.
         require( ABSPATH . WPINC . '/theme-compat/comments.php' );
     }
@@ -2053 +2053 @@
     $parsed_args = apply_filters( 'wp_list_comments_args', $parsed_args );
 
-    // Figure out what comments we'll be looping through ($_comments)
+    // Figure out what comments we'll be looping through ($_comments).
     if ( null !== $comments ) {
         $comments = (array) $comments;
@@ -2177 +2177 @@
         }
     }
-    // Validation check
+    // Validation check.
     $parsed_args['page'] = intval( $parsed_args['page'] );
     if ( 0 == $parsed_args['page'] && 0 != $parsed_args['per_page'] ) {
@@ -2453 +2453 @@
     $args = array_merge( $defaults, $args );
 
-    // Remove aria-describedby from the email field if there's no associated description.
+    // Remove `aria-describedby` from the email field if there's no associated description.
     if ( isset( $args['fields']['email'] ) && false === strpos( $args['comment_notes_before'], 'id="email-notes"' ) ) {
         $args['fields']['email'] = str_replace(
@@ -2555 +2555 @@
             $comment_fields = apply_filters( 'comment_form_fields', $comment_fields );
 
-            // Get an array of field names, excluding the textarea
+            // Get an array of field names, excluding the textarea.
             $comment_field_keys = array_diff( array_keys( $comment_fields ), array( 'comment' ) );
 
-            // Get the first and the last field name, excluding the textarea
+            // Get the first and the last field name, excluding the textarea.
             $first_field = reset( $comment_field_keys );
             $last_field  = end( $comment_field_keys );