Changeset 26138 for trunk/src/wp-admin/includes/class-wp-comments-list-table.php

Timestamp:

11/13/2013 07:46:20 PM (13 years ago)

Author:

SergeyBiryukov

Message:

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

props siobhyb, kpdesign.
fixes #25662.

File:

• trunk/src/wp-admin/includes/class-wp-comments-list-table.php (modified) (8 diffs)

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

@@ -128 +128 @@
         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;
@@ -182 +190 @@
                 }
 
+                /**
+                 * 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;
@@ -220 +236 @@
                                 <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' ),
@@ -230 +253 @@
                         </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' ) );
@@ -239 +267 @@
                         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>';
@@ -375 +410 @@
                 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>
@@ -425 +465 @@
                         }
 
+                        /** This filter is documented in wp-admin/includes/dashboard.php */
                         $actions = apply_filters( 'comment_row_actions', array_filter( $actions ), $comment );
 
@@ -512 +553 @@
 
         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 );
         }