Changeset 33891 for trunk/src/wp-comments-post.php

Timestamp:

09/03/2015 06:16:35 PM (9 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-comments-post.php (modified) (2 diffs)

trunk/src/wp-comments-post.php

@@ -147 +147 @@
  * @since 3.4.0
  *
- * @param object $comment Comment object.
- * @param WP_User $user   User object. The user may not exist.
+ * @param WP_Comment $comment Comment object.
+ * @param WP_User    $user    User object. The user may not exist.
  */
 do_action( 'set_comment_cookies', $comment, $user );
@@ -159 +159 @@
  * @since 2.0.5
  *
- * @param string $location The 'redirect_to' URI sent via $_POST.
- * @param object $comment  Comment object.
+ * @param string     $location The 'redirect_to' URI sent via $_POST.
+ * @param WP_Comment $comment  Comment object.
  */
 $location = apply_filters( 'comment_post_redirect', $location, $comment );