Changeset 33891 for trunk/src/wp-includes/comment-functions.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-includes/comment-functions.php (modified) (7 diffs)

trunk/src/wp-includes/comment-functions.php

@@ -165 +165 @@
  * @global object $comment
  *
- * @param object|string|int $comment Comment to retrieve.
+ * @param WP_Comment|string|int $comment Comment to retrieve.
  * @param string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants.
- * @return object|array|null Depends on $output value.
+ * @return WP_Comment|array|null Depends on $output value.
  */
 function get_comment(&$comment, $output = OBJECT) {
-    global $wpdb;
-
-    if ( empty($comment) ) {
-        if ( isset($GLOBALS['comment']) )
-            $_comment = & $GLOBALS['comment'];
-        else
-            $_comment = null;
-    } elseif ( is_object($comment) ) {
-        wp_cache_add($comment->comment_ID, $comment, 'comment');
+    if ( empty( $comment ) && isset( $GLOBALS['comment'] ) ) {
+        $comment = $GLOBALS['comment'];
+    }
+
+    if ( $comment instanceof WP_Comment ) {
         $_comment = $comment;
+    } elseif ( is_object( $comment ) ) {
+        $_comment = new WP_Comment( $comment );
     } else {
-        if ( isset($GLOBALS['comment']) && ($GLOBALS['comment']->comment_ID == $comment) ) {
-            $_comment = & $GLOBALS['comment'];
-        } elseif ( ! $_comment = wp_cache_get($comment, 'comment') ) {
-            $_comment = $wpdb->get_row($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_ID = %d LIMIT 1", $comment));
-            if ( ! $_comment )
-                return null;
-            wp_cache_add($_comment->comment_ID, $_comment, 'comment');
-        }
+        $_comment = WP_Comment::get_instance( $comment );
+    }
+
+    if ( ! $_comment ) {
+        return null;
     }
 
@@ -203 +198 @@
         return $_comment;
     } elseif ( $output == ARRAY_A ) {
-        $__comment = get_object_vars($_comment);
-        return $__comment;
+        return $_comment->to_array();
     } elseif ( $output == ARRAY_N ) {
-        $__comment = array_values(get_object_vars($_comment));
-        return $__comment;
-    } else {
-        return $_comment;
-    }
+        return array_values( $_comment->to_array() );
+    }
+    return $_comment;
 }
 
@@ -480 +472 @@
  * to recall previous comments by this commentator that are still held in moderation.
  *
- * @param object $comment Comment object.
- * @param object $user Comment author's object.
+ * @param WP_Comment $comment Comment object.
+ * @param object     $user    Comment author's object.
  *
  * @since 3.4.0
@@ -761 +753 @@
  * @global WP_Query $wp_query
  *
- * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments
+ * @param array $comments Optional array of WP_Comment objects. Defaults to $wp_query->comments
  * @param int   $per_page Optional comments per page.
  * @param bool  $threaded Optional control over flat or threaded comments.
@@ -1289 +1281 @@
          * @since 2.7.0
          *
-         * @param object $comment Comment object.
+         * @param WP_Comment $comment Comment object.
          */
         do_action( "comment_{$old_status}_to_{$new_status}", $comment );
@@ -1304 +1296 @@
      * @since 2.7.0
      *
-     * @param int $comment_ID The comment ID.
-     * @param obj $comment    Comment object.
+     * @param int        $comment_ID The comment ID.
+     * @param WP_Comment $comment    Comment object.
      */
     do_action( "comment_{$new_status}_{$comment->comment_type}", $comment->comment_ID, $comment );
@@ -1424 +1416 @@
      * @since 2.8.0
      *
-     * @param int $id      The comment ID.
-     * @param obj $comment Comment object.
+     * @param int        $id      The comment ID.
+     * @param WP_Comment $comment Comment object.
      */
     do_action( 'wp_insert_comment', $id, $comment );