Inline documentation for hooks in wp-admin/includes/class-wp-comments-list-table.php.

props siobhyb, kpdesign.
fixes #25662.

git-svn-id: https://develop.svn.wordpress.org/trunk@26138 602fd350-edb4-49c9-b593-d223f7449a82

src/wp-admin/includes/class-wp-comments-list-table.php

@@ -127,6 +127,14 @@ class WP_Comments_List_Table extends WP_List_Table {
 
 	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 'All'.
+		 */
 		$comments_per_page = apply_filters( 'comments_per_page', $comments_per_page, $comment_status );
 		return $comments_per_page;
 	}
@@ -181,6 +189,14 @@ class WP_Comments_List_Table extends WP_List_Table {
 			) . '</a>';
 		}
 
+		/**
+		 * Filter the comment status links.
+		 *
+		 * @since 2.5.0
+		 *
+		 * @param array $status_links An array of fully-formed status links. Default 'All'.
+		 *                            Accepts 'All', 'Pending', 'Approved', 'Spam', and 'Trash'.
+		 */
 		$status_links = apply_filters( 'comment_status_links', $status_links );
 		return $status_links;
 	}
@@ -219,6 +235,13 @@ class WP_Comments_List_Table extends WP_List_Table {
 			<select name="comment_type">
 				<option value=""><?php _e( 'Show all comment types' ); ?></option>
 <?php
+				/**
+				 * Filter the comment types dropdown menu.
+				 *
+				 * @since 2.7.0
+				 *
+				 * @param array $comment_types An array of comment types. Accepts 'Comments', 'Pings'.
+				 */
 				$comment_types = apply_filters( 'admin_comment_types_dropdown', array(
 					'comment' => __( 'Comments' ),
 					'pings' => __( 'Pings' ),
@@ -229,6 +252,11 @@ class WP_Comments_List_Table extends WP_List_Table {
 			?>
 			</select>
 <?php
+			/**
+			 * Fires just before the Filter submit button for comment types.
+			 *
+			 * @since 3.5.0
+			 */
 			do_action( 'restrict_manage_comments' );
 			submit_button( __( 'Filter' ), 'button', false, false, array( 'id' => 'post-query-submit' ) );
 		}
@@ -238,6 +266,13 @@ class WP_Comments_List_Table extends WP_List_Table {
 			$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 for comment types.
+		 *
+		 * @since 2.5.0
+		 *
+		 * @param string $comment_status The comment status name. Default 'All'.
+		 */
 		do_action( 'manage_comments_nav', $comment_status );
 		echo '</div>';
 	}
@@ -374,7 +409,12 @@ class WP_Comments_List_Table extends WP_List_Table {
 		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>
@@ -424,6 +464,7 @@ class WP_Comments_List_Table extends WP_List_Table {
 				$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;
@@ -511,6 +552,14 @@ class WP_Comments_List_Table extends WP_List_Table {
 	}
 
 	function column_default( $comment, $column_name ) {
+		/**
+		 * Fires when the default column output is displayed for a single row.
+		 *
+		 * @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 );
 	}
 }