vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-12 12:50:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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.

Browse Source 
* 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@33891 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Scott Taylor
2015-09-03 18:16:35 +00:00
parent 52f31a77e9
commit 60ba8b05e4
16 changed files with 247 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/comment-functions.php
+24 -32
View File
@@ -164,30 +164,25 @@ function get_approved_comments( $post_id, $args = array() ) {
* @global wpdb $wpdb WordPress database abstraction object.
* @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 ) && isset( $GLOBALS['comment'] ) ) {
$comment = $GLOBALS['comment'];
}
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 ( $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;
}
/**
@@ -202,14 +197,11 @@ function get_comment(&$comment, $output = OBJECT) {
if ( $output == OBJECT ) {
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;
}
/**
@@ -479,8 +471,8 @@ function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value =
* Sets the cookies used to store an unauthenticated commentator's identity. Typically used
* 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
*/
@@ -760,7 +752,7 @@ function separate_comments(&$comments) {
*
* @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.
* @return int Number of comment pages.
@@ -1288,7 +1280,7 @@ function wp_transition_comment_status($new_status, $old_status, $comment) {
*
* @since 2.7.0
*
* @param object $comment Comment object.
* @param WP_Comment $comment Comment object.
*/
do_action( "comment_{$old_status}_to_{$new_status}", $comment );
}
@@ -1303,8 +1295,8 @@ function wp_transition_comment_status($new_status, $old_status, $comment) {
*
* @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 );
}
@@ -1423,8 +1415,8 @@ function wp_insert_comment( $commentdata ) {
*
* @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 );