X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/41578db67d72562346e4dbb2a14889b23d522813..caeaf8dc94b5e3f75dc98ec92dc7b76049cdddb6:/wp-includes/comment.php diff --git a/wp-includes/comment.php b/wp-includes/comment.php index f7ddbc47..c8984f08 100644 --- a/wp-includes/comment.php +++ b/wp-includes/comment.php @@ -7,49 +7,49 @@ */ /** - * Checks whether a comment passes internal checks to be allowed to add. + * Check whether a comment passes internal checks to be allowed to add. * - * If comment moderation is set in the administration, then all comments, - * regardless of their type and whitelist will be set to false. If the number of - * links exceeds the amount in the administration, then the check fails. If any - * of the parameter contents match the blacklist of words, then the check fails. + * If manual comment moderation is set in the administration, then all checks, + * regardless of their type and whitelist, will fail and the function will + * return false. * * If the number of links exceeds the amount in the administration, then the * check fails. If any of the parameter contents match the blacklist of words, * then the check fails. * - * If the comment author was approved before, then the comment is - * automatically whitelisted. + * If the comment author was approved before, then the comment is automatically + * whitelisted. * - * If none of the checks fail, then the failback is to set the check to pass - * (return true). + * If all checks pass, the function will return true. * * @since 1.2.0 - * @uses $wpdb - * - * @param string $author Comment Author's name - * @param string $email Comment Author's email - * @param string $url Comment Author's URL - * @param string $comment Comment contents - * @param string $user_ip Comment Author's IP address - * @param string $user_agent Comment Author's User Agent - * @param string $comment_type Comment type, either user submitted comment, - * trackback, or pingback - * @return bool Whether the checks passed (true) and the comments should be - * displayed or set to moderated + * + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param string $author Comment author name. + * @param string $email Comment author email. + * @param string $url Comment author URL. + * @param string $comment Content of the comment. + * @param string $user_ip Comment author IP address. + * @param string $user_agent Comment author User-Agent. + * @param string $comment_type Comment type, either user-submitted comment, + * trackback, or pingback. + * @return bool If all checks pass, true, otherwise false. */ function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $comment_type) { global $wpdb; + // If manual moderation is enabled, skip all checks and return false. if ( 1 == get_option('comment_moderation') ) - return false; // If moderation is set to manual + return false; /** This filter is documented in wp-includes/comment-template.php */ $comment = apply_filters( 'comment_text', $comment ); - // Check # of external links + // Check for the number of external links if a max allowed number is set. if ( $max_links = get_option( 'comment_max_links' ) ) { $num_links = preg_match_all( '/]*href/i', $comment, $out ); + /** * Filter the maximum number of links allowed in a comment. * @@ -59,25 +59,38 @@ function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $ * @param string $url Comment author's URL. Included in allowed links total. */ $num_links = apply_filters( 'comment_max_links_url', $num_links, $url ); + + /* + * If the number of links in the comment exceeds the allowed amount, + * fail the check by returning false. + */ if ( $num_links >= $max_links ) return false; } $mod_keys = trim(get_option('moderation_keys')); + + // If moderation 'keys' (keywords) are set, process them. if ( !empty($mod_keys) ) { $words = explode("\n", $mod_keys ); foreach ( (array) $words as $word) { $word = trim($word); - // Skip empty lines + // Skip empty lines. if ( empty($word) ) continue; - // Do some escaping magic so that '#' chars in the - // spam words don't break things: + /* + * Do some escaping magic so that '#' (number of) characters in the spam + * words don't break things: + */ $word = preg_quote($word, '#'); + /* + * Check the comment fields for moderation keywords. If any are found, + * fail the check for the given field by returning false. + */ $pattern = "#$word#i"; if ( preg_match($pattern, $author) ) return false; if ( preg_match($pattern, $email) ) return false; @@ -88,7 +101,13 @@ function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $ } } - // Comment whitelisting: + /* + * Check if the option to approve comments by previously-approved authors is enabled. + * + * If it is enabled, check whether the comment author has a previously-approved comment, + * as well as whether there are any moderation keywords (if set) present in the author + * email address. If both checks pass, return true. Otherwise, return false. + */ if ( 1 == get_option('comment_whitelist')) { if ( 'trackback' != $comment_type && 'pingback' != $comment_type && $author != '' && $email != '' ) { // expected_slashed ($author, $email) @@ -109,14 +128,28 @@ function check_comment($author, $email, $url, $comment, $user_ip, $user_agent, $ * Retrieve the approved comments for post $post_id. * * @since 2.0.0 - * @uses $wpdb + * @since 4.1.0 Refactored to leverage {@see WP_Comment_Query} over a direct query. * - * @param int $post_id The ID of the post - * @return array $comments The approved comments + * @param int $post_id The ID of the post. + * @param array $args Optional. See {@see WP_Comment_Query::query()} for information + * on accepted arguments. + * @return int|array $comments The approved comments, or number of comments if `$count` + * argument is true. */ -function get_approved_comments($post_id) { - global $wpdb; - return $wpdb->get_results($wpdb->prepare("SELECT * FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1' ORDER BY comment_date", $post_id)); +function get_approved_comments( $post_id, $args = array() ) { + if ( ! $post_id ) { + return array(); + } + + $defaults = array( + 'status' => 1, + 'post_id' => $post_id, + 'order' => 'ASC', + ); + $r = wp_parse_args( $args, $defaults ); + + $query = new WP_Comment_Query; + return $query->query( $r ); } /** @@ -127,7 +160,8 @@ function get_approved_comments($post_id) { * comment variable will be used, if it is set. * * @since 2.0.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param object|string|int $comment Comment to retrieve. * @param string $output Optional. OBJECT or ARRAY_A or ARRAY_N constants. @@ -182,14 +216,13 @@ function get_comment(&$comment, $output = OBJECT) { * * The comment list can be for the blog as a whole or for an individual post. * - * The list of comment arguments are 'status', 'orderby', 'comment_date_gmt', - * 'order', 'number', 'offset', and 'post_id'. - * * @since 2.7.0 - * @uses $wpdb * - * @param mixed $args Optional. Array or string of options to override defaults. - * @return array List of comments. + * @global wpdb $wpdb WordPress database abstraction object. + * + * @param string|array $args Optional. Array or string of arguments. See {@see WP_Comment_Query::query()} + * for information on accepted arguments. Default empty. + * @return int|array List of comments or number of found comments if `$count` argument is true. */ function get_comments( $args = '' ) { $query = new WP_Comment_Query; @@ -199,9 +232,20 @@ function get_comments( $args = '' ) { /** * WordPress Comment Query class. * + * See {@see WP_Comment_Query::query()} for accepted arguments. + * * @since 3.1.0 */ class WP_Comment_Query { + /** + * SQL for database query. + * + * @since 4.0.1 + * @access public + * @var string + */ + public $request; + /** * Metadata query container * @@ -209,7 +253,7 @@ class WP_Comment_Query { * @access public * @var object WP_Meta_Query */ - var $meta_query = false; + public $meta_query = false; /** * Date query container @@ -218,37 +262,135 @@ class WP_Comment_Query { * @access public * @var object WP_Date_Query */ - var $date_query = false; + public $date_query = false; + + /** + * @var array + */ + public $query_vars; + + /** + * @var array + */ + public $comments; + + /** + * Make private/protected methods readable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param callable $name Method to call. + * @param array $arguments Arguments to pass when calling. + * @return mixed|bool Return value of the callback, false otherwise. + */ + public function __call( $name, $arguments ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } /** * Execute the query * * @since 3.1.0 - * - * @param string|array $query_vars - * @return int|array + * @since 4.1.0 Introduced 'comment__in', 'comment__not_in', 'post_author__in', + * 'post_author__not_in', 'author__in', 'author__not_in', 'post__in', + * 'post__not_in', 'include_unapproved', 'type__in', and 'type__not_in' + * arguments to $query_vars. + * + * @param string|array $query_vars { + * Optional. Array or query string of comment query parameters. + * + * @type string $author_email Comment author email address. Default empty. + * @type array $author__in Array of author IDs to include comments for. Default empty. + * @type array $author__not_in Array of author IDs to exclude comments for. Default empty. + * @type array $comment__in Array of comment IDs to include. Default empty. + * @type array $comment__not_in Array of comment IDs to exclude. Default empty. + * @type bool $count Whether to return a comment count (true) or array of comment + * objects (false). Default false. + * @type array $date_query Date query clauses to limit comments by. See {@see WP_Date_Query}. + * Default null. + * @type string $fields Comment fields to return. Accepts 'ids' for comment IDs only or + * empty for all fields. Default empty. + * @type int $ID Currently unused. + * @type array $include_unapproved Array of IDs or email addresses of users whose unapproved comments + * will be returned by the query regardless of `$status`. Default empty. + * @type int $karma Karma score to retrieve matching comments for. Default empty. + * @type string $meta_key Include comments with a matching comment meta key. Default empty. + * @type string $meta_value Include comments with a matching comment meta value. Requires + * `$meta_key` to be set. Default empty. + * @type array $meta_query Meta query clauses to limit retrieved comments by. + * See {@see WP_Meta_Query}. Default empty. + * @type int $number Maximum number of comments to retrieve. Default null (no limit). + * @type int $offset Number of comments to offset the query. Used to build LIMIT clause. + * Default 0. + * @type string|array $orderby Comment status or array of statuses. Accepts 'comment_agent', + * 'comment_approved', 'comment_author', 'comment_author_email', + * 'comment_author_IP', 'comment_author_url', 'comment_content', + * 'comment_date', 'comment_date_gmt', 'comment_ID', 'comment_karma', + * 'comment_parent', 'comment_post_ID', 'comment_type', 'user_id', + * 'meta_value', 'meta_value_num', or value of $meta_key. + * Also accepts false, empty array, or 'none' to disable `ORDER BY` + * clause. Default: 'comment_date_gmt'. + * @type string $order How to order retrieved comments. Accepts 'ASC', 'DESC'. + * Default: 'DESC'. + * @type int $parent Parent ID of comment to retrieve children of. Default empty. + * @type array $post_author__in Array of author IDs to retrieve comments for. Default empty. + * @type array $post_author__not_in Array of author IDs *not* to retrieve comments for. Default empty. + * @type int $post_ID Currently unused. + * @type int $post_id Limit results to those affiliated with a given post ID. Default 0. + * @type array $post__in Array of post IDs to include affiliated comments for. Default empty. + * @type array $post__not_in Array of post IDs to exclude affiliated comments for. Default empty. + * @type int $post_author Comment author ID to limit results by. Default empty. + * @type string $post_status Post status to retrieve affiliated comments for. Default empty. + * @type string $post_type Post type to retrieve affiliated comments for. Default empty. + * @type string $post_name Post name to retrieve affiliated comments for. Default empty. + * @type int $post_parent Post parent ID to retrieve affiliated comments for. Default empty. + * @type string $search Search term(s) to retrieve matching comments for. Default empty. + * @type string $status Comment status to limit results by. Accepts 'hold' + * (`comment_status=0`), 'approve' (`comment_status=1`), 'all', or a + * custom comment status. Default 'all'. + * @type string|array $type Include comments of a given type, or array of types. Accepts + * 'comment', 'pings' (includes 'pingback' and 'trackback'), or any + * custom type string. Default empty. + * @type array $type__in Include comments from a given array of comment types. Default empty. + * @type array $type__not_in Exclude comments from a given array of comment types. Default empty. + * @type int $user_id Include comments for a specific user ID. Default empty. + * } + * @return int|array Array of comments or number of found comments if `$count` is set to true. */ - function query( $query_vars ) { + public function query( $query_vars ) { global $wpdb; $defaults = array( 'author_email' => '', + 'author__in' => '', + 'author__not_in' => '', + 'include_unapproved' => '', + 'fields' => '', 'ID' => '', + 'comment__in' => '', + 'comment__not_in' => '', 'karma' => '', 'number' => '', 'offset' => '', 'orderby' => '', 'order' => 'DESC', 'parent' => '', + 'post_author__in' => '', + 'post_author__not_in' => '', 'post_ID' => '', 'post_id' => 0, + 'post__in' => '', + 'post__not_in' => '', 'post_author' => '', 'post_name' => '', 'post_parent' => '', 'post_status' => '', 'post_type' => '', - 'status' => '', + 'status' => 'all', 'type' => '', + 'type__in' => '', + 'type__not_in' => '', 'user_id' => '', 'search' => '', 'count' => false, @@ -274,10 +416,9 @@ class WP_Comment_Query { * @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference. */ do_action_ref_array( 'pre_get_comments', array( &$this ) ); - extract( $this->query_vars, EXTR_SKIP ); // $args can be whatever, only use the args defined in defaults to compute the key - $key = md5( serialize( compact(array_keys($defaults)) ) ); + $key = md5( serialize( wp_array_slice_assoc( $this->query_vars, array_keys( $defaults ) ) ) ); $last_changed = wp_cache_get( 'last_changed', 'comment' ); if ( ! $last_changed ) { $last_changed = microtime(); @@ -285,24 +426,91 @@ class WP_Comment_Query { } $cache_key = "get_comments:$key:$last_changed"; - if ( $cache = wp_cache_get( $cache_key, 'comment' ) ) + if ( $cache = wp_cache_get( $cache_key, 'comment' ) ) { return $cache; + } - $post_id = absint($post_id); + $where = array(); - if ( 'hold' == $status ) - $approved = "comment_approved = '0'"; - elseif ( 'approve' == $status ) - $approved = "comment_approved = '1'"; - elseif ( ! empty( $status ) && 'all' != $status ) - $approved = $wpdb->prepare( "comment_approved = %s", $status ); - else - $approved = "( comment_approved = '0' OR comment_approved = '1' )"; + // Assemble clauses related to 'comment_approved'. + $approved_clauses = array(); - $order = ( 'ASC' == strtoupper($order) ) ? 'ASC' : 'DESC'; + // 'status' accepts an array or a comma-separated string. + $status_clauses = array(); + $statuses = $this->query_vars['status']; + if ( ! is_array( $statuses ) ) { + $statuses = preg_split( '/[\s,]+/', $statuses ); + } + + // 'any' overrides other statuses. + if ( ! in_array( 'any', $statuses ) ) { + foreach ( $statuses as $status ) { + switch ( $status ) { + case 'hold' : + $status_clauses[] = "comment_approved = '0'"; + break; + + case 'approve' : + $status_clauses[] = "comment_approved = '1'"; + break; + + case 'all' : + case '' : + $status_clauses[] = "( comment_approved = '0' OR comment_approved = '1' )"; + break; + + default : + $status_clauses[] = $wpdb->prepare( "comment_approved = %s", $status ); + break; + } + } + + if ( ! empty( $status_clauses ) ) { + $approved_clauses[] = '( ' . implode( ' OR ', $status_clauses ) . ' )'; + } + } + + // User IDs or emails whose unapproved comments are included, regardless of $status. + if ( ! empty( $this->query_vars['include_unapproved'] ) ) { + $include_unapproved = $this->query_vars['include_unapproved']; + + // Accepts arrays or comma-separated strings. + if ( ! is_array( $include_unapproved ) ) { + $include_unapproved = preg_split( '/[\s,]+/', $include_unapproved ); + } + + $unapproved_ids = $unapproved_emails = array(); + foreach ( $include_unapproved as $unapproved_identifier ) { + // Numeric values are assumed to be user ids. + if ( is_numeric( $unapproved_identifier ) ) { + $approved_clauses[] = $wpdb->prepare( "( user_id = %d AND comment_approved = '0' )", $unapproved_identifier ); + + // Otherwise we match against email addresses. + } else { + $approved_clauses[] = $wpdb->prepare( "( comment_author_email = %s AND comment_approved = '0' )", $unapproved_identifier ); + } + } + } + + // Collapse comment_approved clauses into a single OR-separated clause. + if ( ! empty( $approved_clauses ) ) { + if ( 1 === count( $approved_clauses ) ) { + $where[] = $approved_clauses[0]; + } else { + $where[] = '( ' . implode( ' OR ', $approved_clauses ) . ' )'; + } + } + + $order = ( 'ASC' == strtoupper( $this->query_vars['order'] ) ) ? 'ASC' : 'DESC'; + + // Disable ORDER BY with 'none', an empty array, or boolean false. + if ( in_array( $this->query_vars['orderby'], array( 'none', array(), false ), true ) ) { + $orderby = ''; + } else if ( ! empty( $this->query_vars['orderby'] ) ) { + $ordersby = is_array( $this->query_vars['orderby'] ) ? + $this->query_vars['orderby'] : + preg_split( '/[,\s]/', $this->query_vars['orderby'] ); - if ( ! empty( $orderby ) ) { - $ordersby = is_array($orderby) ? $orderby : preg_split('/[,\s]/', $orderby); $allowed_keys = array( 'comment_agent', 'comment_approved', @@ -338,70 +546,184 @@ class WP_Comment_Query { $orderby = 'comment_date_gmt'; } - $number = absint($number); - $offset = absint($offset); + $number = absint( $this->query_vars['number'] ); + $offset = absint( $this->query_vars['offset'] ); - if ( !empty($number) ) { - if ( $offset ) + if ( ! empty( $number ) ) { + if ( $offset ) { $limits = 'LIMIT ' . $offset . ',' . $number; - else + } else { $limits = 'LIMIT ' . $number; + } } else { $limits = ''; } - if ( $count ) + if ( $this->query_vars['count'] ) { $fields = 'COUNT(*)'; - else - $fields = '*'; + } else { + switch ( strtolower( $this->query_vars['fields'] ) ) { + case 'ids': + $fields = "$wpdb->comments.comment_ID"; + break; + default: + $fields = "*"; + break; + } + } $join = ''; - $where = $approved; - - if ( ! empty($post_id) ) - $where .= $wpdb->prepare( ' AND comment_post_ID = %d', $post_id ); - if ( '' !== $author_email ) - $where .= $wpdb->prepare( ' AND comment_author_email = %s', $author_email ); - if ( '' !== $karma ) - $where .= $wpdb->prepare( ' AND comment_karma = %d', $karma ); - if ( 'comment' == $type ) { - $where .= " AND comment_type = ''"; - } elseif( 'pings' == $type ) { - $where .= ' AND comment_type IN ("pingback", "trackback")'; - } elseif ( ! empty( $type ) ) { - $where .= $wpdb->prepare( ' AND comment_type = %s', $type ); + + $post_id = absint( $this->query_vars['post_id'] ); + if ( ! empty( $post_id ) ) { + $where[] = $wpdb->prepare( 'comment_post_ID = %d', $post_id ); + } + + // Parse comment IDs for an IN clause. + if ( ! empty( $this->query_vars['comment__in'] ) ) { + $where[] = 'comment_ID IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['comment__in'] ) ) . ' )'; + } + + // Parse comment IDs for a NOT IN clause. + if ( ! empty( $this->query_vars['comment__not_in'] ) ) { + $where[] = 'comment_ID NOT IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['comment__not_in'] ) ) . ' )'; + } + + // Parse comment post IDs for an IN clause. + if ( ! empty( $this->query_vars['post__in'] ) ) { + $where[] = 'comment_post_ID IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['post__in'] ) ) . ' )'; + } + + // Parse comment post IDs for a NOT IN clause. + if ( ! empty( $this->query_vars['post__not_in'] ) ) { + $where[] = 'comment_post_ID NOT IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['post__not_in'] ) ) . ' )'; + } + + if ( '' !== $this->query_vars['author_email'] ) { + $where[] = $wpdb->prepare( 'comment_author_email = %s', $this->query_vars['author_email'] ); + } + + if ( '' !== $this->query_vars['karma'] ) { + $where[] = $wpdb->prepare( 'comment_karma = %d', $this->query_vars['karma'] ); + } + + // Filtering by comment_type: 'type', 'type__in', 'type__not_in'. + $raw_types = array( + 'IN' => array_merge( (array) $this->query_vars['type'], (array) $this->query_vars['type__in'] ), + 'NOT IN' => (array) $this->query_vars['type__not_in'], + ); + + $comment_types = array(); + foreach ( $raw_types as $operator => $_raw_types ) { + $_raw_types = array_unique( $_raw_types ); + + foreach ( $_raw_types as $type ) { + switch ( $type ) { + // An empty translates to 'all', for backward compatibility + case '': + case 'all' : + break; + + case 'comment': + case 'comments': + $comment_types[ $operator ][] = "''"; + break; + + case 'pings': + $comment_types[ $operator ][] = "'pingback'"; + $comment_types[ $operator ][] = "'trackback'"; + break; + + default: + $comment_types[ $operator ][] = $wpdb->prepare( '%s', $type ); + break; + } + } + + if ( ! empty( $comment_types[ $operator ] ) ) { + $types_sql = implode( ', ', $comment_types[ $operator ] ); + $where[] = "comment_type $operator ($types_sql)"; + } + } + + if ( '' !== $this->query_vars['parent'] ) { + $where[] = $wpdb->prepare( 'comment_parent = %d', $this->query_vars['parent'] ); + } + + if ( is_array( $this->query_vars['user_id'] ) ) { + $where[] = 'user_id IN (' . implode( ',', array_map( 'absint', $this->query_vars['user_id'] ) ) . ')'; + } elseif ( '' !== $this->query_vars['user_id'] ) { + $where[] = $wpdb->prepare( 'user_id = %d', $this->query_vars['user_id'] ); } - if ( '' !== $parent ) - $where .= $wpdb->prepare( ' AND comment_parent = %d', $parent ); - if ( is_array( $user_id ) ) { - $where .= ' AND user_id IN (' . implode( ',', array_map( 'absint', $user_id ) ) . ')'; - } elseif ( '' !== $user_id ) { - $where .= $wpdb->prepare( ' AND user_id = %d', $user_id ); + if ( '' !== $this->query_vars['search'] ) { + $search_sql = $this->get_search_sql( + $this->query_vars['search'], + array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_author_IP', 'comment_content' ) + ); + + // Strip leading 'AND'. + $where[] = preg_replace( '/^\s*AND\s*/', '', $search_sql ); } - if ( '' !== $search ) - $where .= $this->get_search_sql( $search, array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_author_IP', 'comment_content' ) ); + // If any post-related query vars are passed, join the posts table. + $join_posts_table = false; + $plucked = wp_array_slice_assoc( $this->query_vars, array( 'post_author', 'post_name', 'post_parent', 'post_status', 'post_type' ) ); + $post_fields = array_filter( $plucked ); - $post_fields = array_filter( compact( array( 'post_author', 'post_name', 'post_parent', 'post_status', 'post_type', ) ) ); if ( ! empty( $post_fields ) ) { + $join_posts_table = true; + foreach ( $post_fields as $field_name => $field_value ) { + $where[] = $wpdb->prepare( " {$wpdb->posts}.{$field_name} = %s", $field_value ); + } + } + + // Comment author IDs for an IN clause. + if ( ! empty( $this->query_vars['author__in'] ) ) { + $where[] = 'user_id IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['author__in'] ) ) . ' )'; + } + + // Comment author IDs for a NOT IN clause. + if ( ! empty( $this->query_vars['author__not_in'] ) ) { + $where[] = 'user_id NOT IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['author__not_in'] ) ) . ' )'; + } + + // Post author IDs for an IN clause. + if ( ! empty( $this->query_vars['post_author__in'] ) ) { + $join_posts_table = true; + $where[] = 'post_author IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['post_author__in'] ) ) . ' )'; + } + + // Post author IDs for a NOT IN clause. + if ( ! empty( $this->query_vars['post_author__not_in'] ) ) { + $join_posts_table = true; + $where[] = 'post_author NOT IN ( ' . implode( ',', wp_parse_id_list( $this->query_vars['post_author__not_in'] ) ) . ' )'; + } + + if ( $join_posts_table ) { $join = "JOIN $wpdb->posts ON $wpdb->posts.ID = $wpdb->comments.comment_post_ID"; - foreach( $post_fields as $field_name => $field_value ) - $where .= $wpdb->prepare( " AND {$wpdb->posts}.{$field_name} = %s", $field_value ); } if ( ! empty( $this->meta_query->queries ) ) { $clauses = $this->meta_query->get_sql( 'comment', $wpdb->comments, 'comment_ID', $this ); $join .= $clauses['join']; - $where .= $clauses['where']; - $groupby = "{$wpdb->comments}.comment_ID"; + + // Strip leading 'AND'. + $where[] = preg_replace( '/^\s*AND\s*/', '', $clauses['where'] ); + + if ( ! $this->query_vars['count'] ) { + $groupby = "{$wpdb->comments}.comment_ID"; + } } + $date_query = $this->query_vars['date_query']; if ( ! empty( $date_query ) && is_array( $date_query ) ) { $date_query_object = new WP_Date_Query( $date_query, 'comment_date' ); - $where .= $date_query_object->get_sql(); + $where[] = preg_replace( '/^\s*AND\s*/', '', $date_query_object->get_sql() ); } + $where = implode( ' AND ', $where ); + $pieces = array( 'fields', 'join', 'where', 'orderby', 'order', 'limits', 'groupby' ); /** * Filter the comment query clauses. @@ -412,27 +734,48 @@ class WP_Comment_Query { * @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference. */ $clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) ); - foreach ( $pieces as $piece ) - $$piece = isset( $clauses[ $piece ] ) ? $clauses[ $piece ] : ''; - if ( $groupby ) + $fields = isset( $clauses[ 'fields' ] ) ? $clauses[ 'fields' ] : ''; + $join = isset( $clauses[ 'join' ] ) ? $clauses[ 'join' ] : ''; + $where = isset( $clauses[ 'where' ] ) ? $clauses[ 'where' ] : ''; + $orderby = isset( $clauses[ 'orderby' ] ) ? $clauses[ 'orderby' ] : ''; + $order = isset( $clauses[ 'order' ] ) ? $clauses[ 'order' ] : ''; + $limits = isset( $clauses[ 'limits' ] ) ? $clauses[ 'limits' ] : ''; + $groupby = isset( $clauses[ 'groupby' ] ) ? $clauses[ 'groupby' ] : ''; + + if ( $where ) { + $where = 'WHERE ' . $where; + } + + if ( $groupby ) { $groupby = 'GROUP BY ' . $groupby; + } - $query = "SELECT $fields FROM $wpdb->comments $join WHERE $where $groupby ORDER BY $orderby $order $limits"; + if ( $orderby ) { + $orderby = "ORDER BY $orderby $order"; + } - if ( $count ) - return $wpdb->get_var( $query ); + $this->request = "SELECT $fields FROM $wpdb->comments $join $where $groupby $orderby $limits"; - $comments = $wpdb->get_results( $query ); + if ( $this->query_vars['count'] ) { + return $wpdb->get_var( $this->request ); + } + + if ( 'ids' == $this->query_vars['fields'] ) { + $this->comments = $wpdb->get_col( $this->request ); + return array_map( 'intval', $this->comments ); + } + + $results = $wpdb->get_results( $this->request ); /** * Filter the comment query results. * * @since 3.1.0 * - * @param array $comments An array of comments. + * @param array $results An array of comments. * @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference. */ - $comments = apply_filters_ref_array( 'the_comments', array( $comments, &$this ) ); + $comments = apply_filters_ref_array( 'the_comments', array( $results, &$this ) ); wp_cache_add( $cache_key, $comments, 'comment' ); @@ -449,12 +792,15 @@ class WP_Comment_Query { * @param array $cols * @return string */ - function get_search_sql( $string, $cols ) { - $string = esc_sql( like_escape( $string ) ); + protected function get_search_sql( $string, $cols ) { + global $wpdb; + + $like = '%' . $wpdb->esc_like( $string ) . '%'; $searches = array(); - foreach ( $cols as $col ) - $searches[] = "$col LIKE '%$string%'"; + foreach ( $cols as $col ) { + $searches[] = $wpdb->prepare( "$col LIKE %s", $like ); + } return ' AND (' . implode(' OR ', $searches) . ')'; } @@ -486,7 +832,8 @@ function get_comment_statuses() { * The date the last comment was modified. * * @since 1.5.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $timezone Which timezone to use in reference to 'gmt', 'blog', * or 'server' locations. @@ -526,7 +873,8 @@ function get_lastcommentmodified($timezone = 'server') { * caches, but this function does not. * * @since 2.0.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $post_id Optional. Comment amount in post if > 0, else total comments blog wide. * @return array The amount of spam, approved, awaiting moderation, and total comments. @@ -585,7 +933,6 @@ function get_comment_count( $post_id = 0 ) { * Add meta data field to a comment. * * @since 2.9.0 - * @uses add_metadata * @link http://codex.wordpress.org/Function_Reference/add_comment_meta * * @param int $comment_id Comment ID. @@ -606,7 +953,6 @@ function add_comment_meta($comment_id, $meta_key, $meta_value, $unique = false) * allows removing all metadata matching key, if needed. * * @since 2.9.0 - * @uses delete_metadata * @link http://codex.wordpress.org/Function_Reference/delete_comment_meta * * @param int $comment_id comment ID @@ -622,7 +968,6 @@ function delete_comment_meta($comment_id, $meta_key, $meta_value = '') { * Retrieve comment meta field for a comment. * * @since 2.9.0 - * @uses get_metadata * @link http://codex.wordpress.org/Function_Reference/get_comment_meta * * @param int $comment_id Comment ID. @@ -644,7 +989,6 @@ function get_comment_meta($comment_id, $key = '', $single = false) { * If the meta field for the comment does not exist, it will be added. * * @since 2.9.0 - * @uses update_metadata * @link http://codex.wordpress.org/Function_Reference/update_comment_meta * * @param int $comment_id Comment ID. @@ -678,9 +1022,10 @@ function wp_set_comment_cookies($comment, $user) { * @param int $seconds Comment cookie lifetime. Default 30000000. */ $comment_cookie_lifetime = apply_filters( 'comment_cookie_lifetime', 30000000 ); - setcookie('comment_author_' . COOKIEHASH, $comment->comment_author, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN); - setcookie('comment_author_email_' . COOKIEHASH, $comment->comment_author_email, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN); - setcookie('comment_author_url_' . COOKIEHASH, esc_url($comment->comment_author_url), time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN); + $secure = ( 'https' === parse_url( home_url(), PHP_URL_SCHEME ) ); + setcookie( 'comment_author_' . COOKIEHASH, $comment->comment_author, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure ); + setcookie( 'comment_author_email_' . COOKIEHASH, $comment->comment_author_email, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure ); + setcookie( 'comment_author_url_' . COOKIEHASH, esc_url($comment->comment_author_url), time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN, $secure ); } /** @@ -747,22 +1092,34 @@ function sanitize_comment_cookies() { * Validates whether this comment is allowed to be made. * * @since 2.0.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param array $commentdata Contains information on the comment * @return mixed Signifies the approval status (0|1|'spam') */ -function wp_allow_comment($commentdata) { +function wp_allow_comment( $commentdata ) { global $wpdb; - extract($commentdata, EXTR_SKIP); // Simple duplicate check // expected_slashed ($comment_post_ID, $comment_author, $comment_author_email, $comment_content) - $dupe = $wpdb->prepare( "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_parent = %s AND comment_approved != 'trash' AND ( comment_author = %s ", wp_unslash( $comment_post_ID ), wp_unslash( $comment_parent ), wp_unslash( $comment_author ) ); - if ( $comment_author_email ) - $dupe .= $wpdb->prepare( "OR comment_author_email = %s ", wp_unslash( $comment_author_email ) ); - $dupe .= $wpdb->prepare( ") AND comment_content = %s LIMIT 1", wp_unslash( $comment_content ) ); - if ( $wpdb->get_var($dupe) ) { + $dupe = $wpdb->prepare( + "SELECT comment_ID FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_parent = %s AND comment_approved != 'trash' AND ( comment_author = %s ", + wp_unslash( $commentdata['comment_post_ID'] ), + wp_unslash( $commentdata['comment_parent'] ), + wp_unslash( $commentdata['comment_author'] ) + ); + if ( $commentdata['comment_author_email'] ) { + $dupe .= $wpdb->prepare( + "OR comment_author_email = %s ", + wp_unslash( $commentdata['comment_author_email'] ) + ); + } + $dupe .= $wpdb->prepare( + ") AND comment_content = %s LIMIT 1", + wp_unslash( $commentdata['comment_content'] ) + ); + if ( $wpdb->get_var( $dupe ) ) { /** * Fires immediately after a duplicate comment is detected. * @@ -771,10 +1128,10 @@ function wp_allow_comment($commentdata) { * @param array $commentdata Comment data. */ do_action( 'comment_duplicate_trigger', $commentdata ); - if ( defined('DOING_AJAX') ) + if ( defined( 'DOING_AJAX' ) ) { die( __('Duplicate comment detected; it looks as though you’ve already said that!') ); - - wp_die( __('Duplicate comment detected; it looks as though you’ve already said that!') ); + } + wp_die( __( 'Duplicate comment detected; it looks as though you’ve already said that!' ), 409 ); } /** @@ -788,24 +1145,50 @@ function wp_allow_comment($commentdata) { * @param string $comment_author_email Comment author's email. * @param string $comment_date_gmt GMT date the comment was posted. */ - do_action( 'check_comment_flood', $comment_author_IP, $comment_author_email, $comment_date_gmt ); + do_action( + 'check_comment_flood', + $commentdata['comment_author_IP'], + $commentdata['comment_author_email'], + $commentdata['comment_date_gmt'] + ); - if ( ! empty( $user_id ) ) { - $user = get_userdata( $user_id ); - $post_author = $wpdb->get_var($wpdb->prepare("SELECT post_author FROM $wpdb->posts WHERE ID = %d LIMIT 1", $comment_post_ID)); + if ( ! empty( $commentdata['user_id'] ) ) { + $user = get_userdata( $commentdata['user_id'] ); + $post_author = $wpdb->get_var( $wpdb->prepare( + "SELECT post_author FROM $wpdb->posts WHERE ID = %d LIMIT 1", + $commentdata['comment_post_ID'] + ) ); } - if ( isset( $user ) && ( $user_id == $post_author || $user->has_cap( 'moderate_comments' ) ) ) { + if ( isset( $user ) && ( $commentdata['user_id'] == $post_author || $user->has_cap( 'moderate_comments' ) ) ) { // The author and the admins get respect. $approved = 1; } else { // Everyone else's comments will be checked. - if ( check_comment($comment_author, $comment_author_email, $comment_author_url, $comment_content, $comment_author_IP, $comment_agent, $comment_type) ) + if ( check_comment( + $commentdata['comment_author'], + $commentdata['comment_author_email'], + $commentdata['comment_author_url'], + $commentdata['comment_content'], + $commentdata['comment_author_IP'], + $commentdata['comment_agent'], + $commentdata['comment_type'] + ) ) { $approved = 1; - else + } else { $approved = 0; - if ( wp_blacklist_check($comment_author, $comment_author_email, $comment_author_url, $comment_content, $comment_author_IP, $comment_agent) ) + } + + if ( wp_blacklist_check( + $commentdata['comment_author'], + $commentdata['comment_author_email'], + $commentdata['comment_author_url'], + $commentdata['comment_content'], + $commentdata['comment_author_IP'], + $commentdata['comment_agent'] + ) ) { $approved = 'spam'; + } } /** @@ -827,7 +1210,8 @@ function wp_allow_comment($commentdata) { * administrators. * * @since 2.3.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $ip Comment IP. * @param string $email Comment author email address. @@ -865,7 +1249,7 @@ function check_comment_flood_db( $ip, $email, $date ) { if ( defined('DOING_AJAX') ) die( __('You are posting comments too quickly. Slow down.') ); - wp_die( __('You are posting comments too quickly. Slow down.'), '', array('response' => 403) ); + wp_die( __( 'You are posting comments too quickly. Slow down.' ), 429 ); } } } @@ -944,9 +1328,6 @@ function get_comment_pages_count( $comments = null, $per_page = null, $threaded * Calculate what page number a comment will appear on for comment paging. * * @since 2.7.0 - * @uses get_comment() Gets the full comment of the $comment_ID parameter. - * @uses get_option() Get various settings to control function and defaults. - * @uses get_page_of_comment() Used to loop up to top level comment. * * @param int $comment_ID Comment ID. * @param array $args Optional args. @@ -1133,8 +1514,8 @@ function wp_count_comments( $post_id = 0 ) { * post ID available. * * @since 2.0.0 - * @uses $wpdb - * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $comment_id Comment ID * @param bool $force_delete Whether to bypass trash and force deletion. Default is false. @@ -1187,15 +1568,9 @@ function wp_delete_comment($comment_id, $force_delete = false) { clean_comment_cache($comment_id); - /** - * Fires immediately before changing the comment's status to 'delete'. - * - * @since 1.5.0 - * - * @param int $comment_id The comment ID. - * @param string $status The new 'delete' comment status. - */ + /** This action is documented in wp-includes/comment.php */ do_action( 'wp_set_comment_status', $comment_id, 'delete' ); + wp_transition_comment_status('delete', $comment->comment_approved, $comment); return true; } @@ -1207,8 +1582,6 @@ function wp_delete_comment($comment_id, $force_delete = false) { * * @since 2.9.0 * - * @uses wp_delete_comment() if trash is disabled - * * @param int $comment_id Comment ID. * @return bool True on success, false on failure. */ @@ -1372,7 +1745,7 @@ function wp_unspam_comment($comment_id) { * @since 1.0.0 * * @param int $comment_id Comment ID - * @return string|bool Status might be 'trash', 'approved', 'unapproved', 'spam'. False on failure. + * @return false|string Status might be 'trash', 'approved', 'unapproved', 'spam'. False on failure. */ function wp_get_comment_status($comment_id) { $comment = get_comment($comment_id); @@ -1445,7 +1818,7 @@ function wp_transition_comment_status($new_status, $old_status, $comment) { /** * Fires when the comment status is in transition from one specific status to another. * - * The dynamic portions of the hook name, $old_status, and $new_status, + * The dynamic portions of the hook name, `$old_status`, and `$new_status`, * refer to the old and new comment statuses, respectively. * * @since 2.7.0 @@ -1457,7 +1830,7 @@ function wp_transition_comment_status($new_status, $old_status, $comment) { /** * Fires when the status of a specific comment type is in transition. * - * The dynamic portions of the hook name, $new_status, and $comment->comment_type, + * The dynamic portions of the hook name, `$new_status`, and `$comment->comment_type`, * refer to the new comment status, and the type of comment, respectively. * * Typical comment types include an empty string (standard comment), 'pingback', @@ -1517,41 +1890,45 @@ function wp_get_current_commenter() { * 'comment_date_gmt', 'comment_parent', 'comment_approved', and 'user_id'. * * @since 2.0.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param array $commentdata Contains information on the comment. - * @return int The new comment's ID. + * @return int|bool The new comment's ID on success, false on failure. */ -function wp_insert_comment($commentdata) { +function wp_insert_comment( $commentdata ) { global $wpdb; - extract(wp_unslash($commentdata), EXTR_SKIP); - - if ( ! isset($comment_author_IP) ) - $comment_author_IP = ''; - if ( ! isset($comment_date) ) - $comment_date = current_time('mysql'); - if ( ! isset($comment_date_gmt) ) - $comment_date_gmt = get_gmt_from_date($comment_date); - if ( ! isset($comment_parent) ) - $comment_parent = 0; - if ( ! isset($comment_approved) ) - $comment_approved = 1; - if ( ! isset($comment_karma) ) - $comment_karma = 0; - if ( ! isset($user_id) ) - $user_id = 0; - if ( ! isset($comment_type) ) - $comment_type = ''; - - $data = compact('comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_author_IP', 'comment_date', 'comment_date_gmt', 'comment_content', 'comment_karma', 'comment_approved', 'comment_agent', 'comment_type', 'comment_parent', 'user_id'); - $wpdb->insert($wpdb->comments, $data); + $data = wp_unslash( $commentdata ); - $id = (int) $wpdb->insert_id; + $comment_author = ! isset( $data['comment_author'] ) ? '' : $data['comment_author']; + $comment_author_email = ! isset( $data['comment_author_email'] ) ? '' : $data['comment_author_email']; + $comment_author_url = ! isset( $data['comment_author_url'] ) ? '' : $data['comment_author_url']; + $comment_author_IP = ! isset( $data['comment_author_IP'] ) ? '' : $data['comment_author_IP']; + + $comment_date = ! isset( $data['comment_date'] ) ? current_time( 'mysql' ) : $data['comment_date']; + $comment_date_gmt = ! isset( $data['comment_date_gmt'] ) ? get_gmt_from_date( $comment_date ) : $data['comment_date_gmt']; + + $comment_post_ID = ! isset( $data['comment_post_ID'] ) ? '' : $data['comment_post_ID']; + $comment_content = ! isset( $data['comment_content'] ) ? '' : $data['comment_content']; + $comment_karma = ! isset( $data['comment_karma'] ) ? 0 : $data['comment_karma']; + $comment_approved = ! isset( $data['comment_approved'] ) ? 1 : $data['comment_approved']; + $comment_agent = ! isset( $data['comment_agent'] ) ? '' : $data['comment_agent']; + $comment_type = ! isset( $data['comment_type'] ) ? '' : $data['comment_type']; + $comment_parent = ! isset( $data['comment_parent'] ) ? 0 : $data['comment_parent']; + + $user_id = ! isset( $data['user_id'] ) ? 0 : $data['user_id']; + + $compacted = compact( 'comment_post_ID', 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_author_IP', 'comment_date', 'comment_date_gmt', 'comment_content', 'comment_karma', 'comment_approved', 'comment_agent', 'comment_type', 'comment_parent', 'user_id' ); + if ( ! $wpdb->insert( $wpdb->comments, $compacted ) ) { + return false; + } - if ( $comment_approved == 1 ) - wp_update_comment_count($comment_post_ID); + $id = (int) $wpdb->insert_id; - $comment = get_comment($id); + if ( $comment_approved == 1 ) { + wp_update_comment_count( $comment_post_ID ); + } + $comment = get_comment( $id ); /** * Fires immediately after a comment is inserted into the database. @@ -1660,13 +2037,19 @@ function wp_throttle_comment_flood($block, $time_lastcomment, $time_newcomment) * * We use REMOTE_ADDR here directly. If you are behind a proxy, you should ensure * that it is properly set, such as in wp-config.php, for your environment. - * See {@link http://core.trac.wordpress.org/ticket/9235} + * See {@link https://core.trac.wordpress.org/ticket/9235} * * @since 1.5.0 * @param array $commentdata Contains information on the comment. - * @return int The ID of the comment after adding. + * @return int|bool The ID of the comment on success, false on failure. */ function wp_new_comment( $commentdata ) { + if ( isset( $commentdata['user_ID'] ) ) { + $commentdata['user_id'] = $commentdata['user_ID'] = (int) $commentdata['user_ID']; + } + + $prefiltered_user_id = ( isset( $commentdata['user_id'] ) ) ? (int) $commentdata['user_id'] : 0; + /** * Filter a comment's data before it is sanitized and inserted into the database. * @@ -1677,10 +2060,11 @@ function wp_new_comment( $commentdata ) { $commentdata = apply_filters( 'preprocess_comment', $commentdata ); $commentdata['comment_post_ID'] = (int) $commentdata['comment_post_ID']; - if ( isset($commentdata['user_ID']) ) + if ( isset( $commentdata['user_ID'] ) && $prefiltered_user_id !== (int) $commentdata['user_ID'] ) { $commentdata['user_id'] = $commentdata['user_ID'] = (int) $commentdata['user_ID']; - elseif ( isset($commentdata['user_id']) ) + } elseif ( isset( $commentdata['user_id'] ) ) { $commentdata['user_id'] = (int) $commentdata['user_id']; + } $commentdata['comment_parent'] = isset($commentdata['comment_parent']) ? absint($commentdata['comment_parent']) : 0; $parent_status = ( 0 < $commentdata['comment_parent'] ) ? wp_get_comment_status($commentdata['comment_parent']) : ''; @@ -1697,6 +2081,9 @@ function wp_new_comment( $commentdata ) { $commentdata['comment_approved'] = wp_allow_comment($commentdata); $comment_ID = wp_insert_comment($commentdata); + if ( ! $comment_ID ) { + return false; + } /** * Fires immediately after a comment is inserted into the database. @@ -1730,7 +2117,6 @@ function wp_new_comment( $commentdata ) { * If the comment status is not in the list, then false is returned. * * @since 1.0.0 - * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object * * @param int $comment_id Comment ID. * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'. @@ -1740,7 +2126,6 @@ function wp_new_comment( $commentdata ) { function wp_set_comment_status($comment_id, $comment_status, $wp_error = false) { global $wpdb; - $status = '0'; switch ( $comment_status ) { case 'hold': case '0': @@ -1777,17 +2162,17 @@ function wp_set_comment_status($comment_id, $comment_status, $wp_error = false) $comment = get_comment($comment_id); /** - * Fires after a comment status has been updated in the database. - * - * The hook also fires immediately before comment status transition hooks are fired. + * Fires immediately before transitioning a comment's status from one to another + * in the database. * * @since 1.5.0 * - * @param int $comment_id The comment ID. - * @param string|bool $comment_status The comment status. Possible values include 'hold', - * 'approve', 'spam', 'trash', or false. + * @param int $comment_id Comment ID. + * @param string|bool $comment_status Current comment status. Possible values include + * 'hold', 'approve', 'spam', 'trash', or false. */ do_action( 'wp_set_comment_status', $comment_id, $comment_status ); + wp_transition_comment_status($comment_status, $comment_old->comment_approved, $comment); wp_update_comment_count($comment->comment_post_ID); @@ -1801,8 +2186,8 @@ function wp_set_comment_status($comment_id, $comment_status, $wp_error = false) * Filters the comment and makes sure certain fields are valid before updating. * * @since 2.0.0 - * @uses $wpdb - * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param array $commentarr Contains information on the comment. * @return int Comment was updated if value is 1, or was not updated if value is 0. @@ -1812,9 +2197,9 @@ function wp_update_comment($commentarr) { // First, get all of the original fields $comment = get_comment($commentarr['comment_ID'], ARRAY_A); - if ( empty( $comment ) ) + if ( empty( $comment ) ) { return 0; - + } // Escape data pulled from DB. $comment = wp_slash($comment); @@ -1826,7 +2211,7 @@ function wp_update_comment($commentarr) { $commentarr = wp_filter_comment( $commentarr ); // Now extract the merged array. - extract(wp_unslash($commentarr), EXTR_SKIP); + $data = wp_unslash( $commentarr ); /** * Filter the comment content before it is updated in the database. @@ -1835,22 +2220,26 @@ function wp_update_comment($commentarr) { * * @param string $comment_content The comment data. */ - $comment_content = apply_filters( 'comment_save_pre', $comment_content ); + $data['comment_content'] = apply_filters( 'comment_save_pre', $data['comment_content'] ); - $comment_date_gmt = get_gmt_from_date($comment_date); + $data['comment_date_gmt'] = get_gmt_from_date( $data['comment_date'] ); - if ( !isset($comment_approved) ) - $comment_approved = 1; - else if ( 'hold' == $comment_approved ) - $comment_approved = 0; - else if ( 'approve' == $comment_approved ) - $comment_approved = 1; + if ( ! isset( $data['comment_approved'] ) ) { + $data['comment_approved'] = 1; + } else if ( 'hold' == $data['comment_approved'] ) { + $data['comment_approved'] = 0; + } else if ( 'approve' == $data['comment_approved'] ) { + $data['comment_approved'] = 1; + } - $data = compact( 'comment_content', 'comment_author', 'comment_author_email', 'comment_approved', 'comment_karma', 'comment_author_url', 'comment_date', 'comment_date_gmt', 'comment_parent' ); + $comment_ID = $data['comment_ID']; + $comment_post_ID = $data['comment_post_ID']; + $keys = array( 'comment_content', 'comment_author', 'comment_author_email', 'comment_approved', 'comment_karma', 'comment_author_url', 'comment_date', 'comment_date_gmt', 'comment_parent' ); + $data = wp_array_slice_assoc( $data, $keys ); $rval = $wpdb->update( $wpdb->comments, $data, compact( 'comment_ID' ) ); - clean_comment_cache($comment_ID); - wp_update_comment_count($comment_post_ID); + clean_comment_cache( $comment_ID ); + wp_update_comment_count( $comment_post_ID ); /** * Fires immediately after a comment is updated in the database. * @@ -1878,7 +2267,7 @@ function wp_update_comment($commentarr) { * @staticvar bool $_defer * * @param bool $defer - * @return unknown + * @return bool */ function wp_defer_comment_counting($defer=null) { static $_defer = false; @@ -1909,7 +2298,7 @@ function wp_defer_comment_counting($defer=null) { * * @param int $post_id Post ID * @param bool $do_deferred Whether to process previously deferred post comment counts - * @return bool True on success, false on failure + * @return bool|null True on success, false on failure */ function wp_update_comment_count($post_id, $do_deferred=false) { static $_deferred = array(); @@ -1936,7 +2325,8 @@ function wp_update_comment_count($post_id, $do_deferred=false) { * Updates the comment count for the post. * * @since 2.5.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $post_id Post ID * @return bool True on success, false on '0' $post_id or if post with ID does not exist. @@ -1986,7 +2376,7 @@ function wp_update_comment_count_now($post_id) { * * @param string $url URL to ping. * @param int $deprecated Not Used. - * @return bool|string False on failure, string containing URI on success. + * @return false|string False on failure, string containing URI on success. */ function discover_pingback_server_uri( $url, $deprecated = '' ) { if ( !empty( $deprecated ) ) @@ -2050,7 +2440,8 @@ function discover_pingback_server_uri( $url, $deprecated = '' ) { * Perform all pingbacks, enclosures, trackbacks, and send to pingback services. * * @since 2.1.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. */ function do_all_pings() { global $wpdb; @@ -2081,7 +2472,8 @@ function do_all_pings() { * Perform trackbacks. * * @since 1.5.0 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param int $post_id Post ID to do trackbacks on. */ @@ -2097,10 +2489,10 @@ function do_trackbacks($post_id) { } if ( empty($post->post_excerpt) ) { - /** This filter is documented in wp-admin/post-template.php */ + /** This filter is documented in wp-includes/post-template.php */ $excerpt = apply_filters( 'the_content', $post->post_content, $post->ID ); } else { - /** This filter is documented in wp-admin/post-template.php */ + /** This filter is documented in wp-includes/post-template.php */ $excerpt = apply_filters( 'the_excerpt', $post->post_excerpt ); } @@ -2129,10 +2521,10 @@ function do_trackbacks($post_id) { * * @since 1.2.0 * - * @param int $post_id Post ID. Not actually used. + * @param int $post_id Post ID. * @return int Same as Post ID from parameter */ -function generic_ping($post_id = 0) { +function generic_ping( $post_id = 0 ) { $services = get_option('ping_sites'); $services = explode("\n", $services); @@ -2150,7 +2542,6 @@ function generic_ping($post_id = 0) { * * @since 0.71 * @uses $wp_version - * @uses IXR_Client * * @param string $content Post content to check for links. * @param int $post_ID Post ID. @@ -2256,7 +2647,8 @@ function privacy_ping_filter($sites) { * Updates database when sending trackback to prevent duplicates. * * @since 0.71 - * @uses $wpdb + * + * @global wpdb $wpdb WordPress database abstraction object. * * @param string $trackback_url URL to send trackbacks. * @param string $title Title of post. @@ -2293,7 +2685,6 @@ function trackback($trackback_url, $title, $excerpt, $ID) { * * @since 1.2.0 * @uses $wp_version - * @uses IXR_Client * * @param string $server Host of blog to connect to. * @param string $path Path to send the ping.