Ticket #25662: class-wp-comments-list-table.2.patch

class-wp-comments-list-table.php

@@ -127 +127 @@
 
         function get_per_page( $comment_status = 'all' ) {
                 $comments_per_page = $this->get_items_per_page( 'edit_comments_per_page' );
+                /**
+                * Filter the number of comments listed per page in the comments list table.
+                *
+                * @since 2.6.0
+                *
+                * @param int $comments_per_page The number of comments to list per page.
+                * @param string $comment_status The comment status name. Default is 'All'.
+                */
                 $comments_per_page = apply_filters( 'comments_per_page', $comments_per_page, $comment_status );
                 return $comments_per_page;
         }
@@ -180 +188 @@
                                 number_format_i18n( $num_comments->$status )
                         ) . '</a>';
                 }
-
+                
+                /**
+                * Filter the comment status links.
+                *
+                * Allows the status links used to filter the comments list table to be modified. 
+                * The default comment statuses are 'All', 'Pending', 'Approved', 'Spam', and 'Trash'.
+                *
+                * @since 2.5.0
+                *
+                * @param array $status_links An array of fully-formed status links.
+                */
                 $status_links = apply_filters( 'comment_status_links', $status_links );
                 return $status_links;
         }
@@ -219 +237 @@
                         <select name="comment_type">
                                 <option value=""><?php _e( 'Show all comment types' ); ?></option>
 <?php
+                                /**
+                                * Filter the comment types drop down menu.
+                                *
+                                * Allows the options supplied to the comment types drop down in the Comments screen to be modified. 
+                                * The built-in comment type values are 'Comments' and 'Pings'.
+                                *
+                                * @since 2.7.0
+                                *
+                                * @param array An array of comment types to be used as options in the drop down.
+                                */
                                 $comment_types = apply_filters( 'admin_comment_types_dropdown', array(
                                         'comment' => __( 'Comments' ),
                                         'pings' => __( 'Pings' ),
@@ -229 +257 @@
                         ?>
                         </select>
 <?php
+                        /**
+                        * Fires just before the "Filter" submit button on the comments list table.
+                        *
+                        * Allows additional filtering capabilities for the comments list table.
+                        *
+                        * @since 3.5.0
+                        */
                         do_action( 'restrict_manage_comments' );
                         submit_button( __( 'Filter' ), 'button', false, false, array( 'id' => 'post-query-submit' ) );
                 }
@@ -238 +273 @@
                         $title = ( 'spam' == $comment_status ) ? esc_attr__( 'Empty Spam' ) : esc_attr__( 'Empty Trash' );
                         submit_button( $title, 'apply', 'delete_all', false );
                 }
+                /**
+                * Fires after the "Filter" submit button on the comments list table. 
+                *
+                * Allows the filtering options menu for the comments list table to be extended.
+                *
+                * @since 2.5.0
+                *
+                * @param string $comment_status The comment status name. Default is 'All'.
+                */
                 do_action( 'manage_comments_nav', $comment_status );
                 echo '</div>';
         }
@@ -373 +417 @@
                 comment_text();
                 if ( $user_can ) { ?>
                 <div id="inline-<?php echo $comment->comment_ID; ?>" class="hidden">
-                <textarea class="comment" rows="1" cols="1"><?php echo esc_textarea( apply_filters( 'comment_edit_pre', $comment->comment_content ) ); ?></textarea>
+                <textarea class="comment" rows="1" cols="1">
+                        <?php 
+                        /** This filter is documented in wp-admin/includes/comment.php */
+                        echo esc_textarea( apply_filters( 'comment_edit_pre', $comment->comment_content ) ); 
+                        ?>
+                </textarea>
                 <div class="author-email"><?php echo esc_attr( $comment->comment_author_email ); ?></div>
                 <div class="author"><?php echo esc_attr( $comment->comment_author ); ?></div>
                 <div class="author-url"><?php echo esc_attr( $comment->comment_author_url ); ?></div>
@@ -423 +472 @@
                                 $actions['reply'] = '<a onclick="commentReply.open( \''.$comment->comment_ID.'\',\''.$post->ID.'\' );return false;" class="vim-r" title="'.esc_attr__( 'Reply to this comment' ).'" href="#">' . __( 'Reply' ) . '</a>';
                         }
 
+                        /** This filter is documented in wp-admin/includes/dashboard.php */
                         $actions = apply_filters( 'comment_row_actions', array_filter( $actions ), $comment );
 
                         $i = 0;
@@ -510 +560 @@
         }
 
         function column_default( $comment, $column_name ) {
+                /**
+                * Fires in comments list table's custom columns.
+                *
+                * Allows content to be added to custom columns in the comments list table.
+                *
+                * @since 2.8.0
+                *
+                * @param string $column_name            The custom column's name.
+                * @param int $comment->comment_ID       The custom column's unique ID number.
+                */
                 do_action( 'manage_comments_custom_column', $column_name, $comment->comment_ID );
         }
 }