Changeset 33891 for trunk/src/wp-admin/includes/dashboard.php

Timestamp:

09/03/2015 06:16:35 PM (6 years ago)

Author:

wonderboymusic

Message:

Introduce WP_Comment class to model/strongly-type rows from the comments database table. Inclusion of this class is a pre-req for some more general comment cleanup and sanity.

• Takes inspiration from WP_Post and adds sanity to comment caching.
• Clarifies when the current global value for $comment is returned. The current implementation in get_comment() introduces side effects and an occasion stale global value for $comment when comment caches are cleaned.
• Strongly-types @param docs
• This class is marked final for now

Props wonderboymusic, nacin.

See #32619.

File:

• trunk/src/wp-admin/includes/dashboard.php (modified) (2 diffs)

trunk/src/wp-admin/includes/dashboard.php

@@ -549 +549 @@
 
 /**
- * @global object $comment
- *
- * @param object $comment
- * @param bool   $show_date
+ * @global WP_Comment $comment
+ *
+ * @param WP_Comment $comment
+ * @param bool       $show_date
  */
 function _wp_dashboard_recent_comments_row( &$comment, $show_date = true ) {
@@ -604 +604 @@
          * @since 2.6.0
          *
-         * @param array  $actions An array of comment actions. Default actions include:
-         *                        'Approve', 'Unapprove', 'Edit', 'Reply', 'Spam',
-         *                        'Delete', and 'Trash'.
-         * @param object $comment The comment object.
+         * @param array      $actions An array of comment actions. Default actions include:
+         *                            'Approve', 'Unapprove', 'Edit', 'Reply', 'Spam',
+         *                            'Delete', and 'Trash'.
+         * @param WP_Comment $comment The comment object.
          */
         $actions = apply_filters( 'comment_row_actions', array_filter($actions), $comment );