<?php
/**
- * Manages WordPress comments
+ * Core Comment API
*
* @package WordPress
* @subpackage Comment
*/
/**
- * 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( '/<a [^>]*href/i', $comment, $out );
- $num_links = apply_filters( 'comment_max_links_url', $num_links, $url ); // provide for counting of $url as a link
+
+ /**
+ * Filters the number of links found in a comment.
+ *
+ * @since 3.0.0
+ * @since 4.7.0 Added the `$comment` parameter.
+ *
+ * @param int $num_links The number of links found.
+ * @param string $url Comment author's URL. Included in allowed links total.
+ * @param string $comment Content of the comment.
+ */
+ $num_links = apply_filters( 'comment_max_links_url', $num_links, $url, $comment );
+
+ /*
+ * 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;
}
}
- // 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)
- $ok_to_comment = $wpdb->get_var("SELECT comment_approved FROM $wpdb->comments WHERE comment_author = '$author' AND comment_author_email = '$email' and comment_approved = '1' LIMIT 1");
+ $comment_user = get_user_by( 'email', wp_unslash( $email ) );
+ if ( ! empty( $comment_user->ID ) ) {
+ $ok_to_comment = $wpdb->get_var( $wpdb->prepare( "SELECT comment_approved FROM $wpdb->comments WHERE user_id = %d AND comment_approved = '1' LIMIT 1", $comment_user->ID ) );
+ } else {
+ // expected_slashed ($author, $email)
+ $ok_to_comment = $wpdb->get_var( $wpdb->prepare( "SELECT comment_approved FROM $wpdb->comments WHERE comment_author = %s AND comment_author_email = %s and comment_approved = '1' LIMIT 1", $author, $email ) );
+ }
if ( ( 1 == $ok_to_comment ) &&
( empty($mod_keys) || false === strpos( $email, $mod_keys) ) )
return true;
* Retrieve the approved comments for post $post_id.
*
* @since 2.0.0
- * @uses $wpdb
+ * @since 4.1.0 Refactored to leverage 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 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 );
}
/**
* after being passed through a filter. If the comment is empty, then the global
* comment variable will be used, if it is set.
*
- * If the comment is empty, then the global comment variable will be used, if it
- * is set.
- *
* @since 2.0.0
- * @uses $wpdb
*
- * @param object|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.
+ * @global WP_Comment $comment
+ *
+ * @param WP_Comment|string|int $comment Comment to retrieve.
+ * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Comment object, an associative array, or a numeric array, respectively. Default OBJECT.
+ * @return WP_Comment|array|null Depends on $output value.
*/
-function get_comment(&$comment, $output = OBJECT) {
- global $wpdb;
- $null = null;
+function get_comment( &$comment = null, $output = OBJECT ) {
+ 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;
}
- $_comment = apply_filters('get_comment', $_comment);
+ /**
+ * Fires after a comment is retrieved.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $_comment Comment data.
+ */
+ $_comment = apply_filters( 'get_comment', $_comment );
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;
}
/**
*
* 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.
+ * @param string|array $args Optional. Array or string of arguments. See WP_Comment_Query::parse_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;
return $query->query( $args );
}
-/**
- * WordPress Comment Query class.
- *
- * @since 3.1.0
- */
-class WP_Comment_Query {
- /**
- * Metadata query container
- *
- * @since 3.5.0
- * @access public
- * @var object WP_Meta_Query
- */
- var $meta_query = false;
-
- /**
- * Execute the query
- *
- * @since 3.1.0
- *
- * @param string|array $query_vars
- * @return int|array
- */
- function query( $query_vars ) {
- global $wpdb;
-
- $defaults = array(
- 'author_email' => '',
- 'ID' => '',
- 'karma' => '',
- 'number' => '',
- 'offset' => '',
- 'orderby' => '',
- 'order' => 'DESC',
- 'parent' => '',
- 'post_ID' => '',
- 'post_id' => 0,
- 'post_author' => '',
- 'post_name' => '',
- 'post_parent' => '',
- 'post_status' => '',
- 'post_type' => '',
- 'status' => '',
- 'type' => '',
- 'user_id' => '',
- 'search' => '',
- 'count' => false,
- 'meta_key' => '',
- 'meta_value' => '',
- 'meta_query' => '',
- );
-
- $groupby = '';
-
- $this->query_vars = wp_parse_args( $query_vars, $defaults );
-
- // Parse meta query
- $this->meta_query = new WP_Meta_Query();
- $this->meta_query->parse_query_vars( $this->query_vars );
-
- 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)) ) );
- $last_changed = wp_cache_get( 'last_changed', 'comment' );
- if ( ! $last_changed ) {
- $last_changed = microtime();
- wp_cache_set( 'last_changed', $last_changed, 'comment' );
- }
- $cache_key = "get_comments:$key:$last_changed";
-
- if ( $cache = wp_cache_get( $cache_key, 'comment' ) )
- return $cache;
-
- $post_id = absint($post_id);
-
- 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' )";
-
- $order = ( 'ASC' == strtoupper($order) ) ? 'ASC' : 'DESC';
-
- if ( ! empty( $orderby ) ) {
- $ordersby = is_array($orderby) ? $orderby : preg_split('/[,\s]/', $orderby);
- $allowed_keys = array(
- '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',
- );
- if ( ! empty( $this->query_vars['meta_key'] ) ) {
- $allowed_keys[] = $this->query_vars['meta_key'];
- $allowed_keys[] = 'meta_value';
- $allowed_keys[] = 'meta_value_num';
- }
- $ordersby = array_intersect( $ordersby, $allowed_keys );
- foreach ( $ordersby as $key => $value ) {
- if ( $value == $this->query_vars['meta_key'] || $value == 'meta_value' ) {
- $ordersby[ $key ] = "$wpdb->commentmeta.meta_value";
- } elseif ( $value == 'meta_value_num' ) {
- $ordersby[ $key ] = "$wpdb->commentmeta.meta_value+0";
- }
- }
- $orderby = empty( $ordersby ) ? 'comment_date_gmt' : implode(', ', $ordersby);
- } else {
- $orderby = 'comment_date_gmt';
- }
-
- $number = absint($number);
- $offset = absint($offset);
-
- if ( !empty($number) ) {
- if ( $offset )
- $limits = 'LIMIT ' . $offset . ',' . $number;
- else
- $limits = 'LIMIT ' . $number;
- } else {
- $limits = '';
- }
-
- if ( $count )
- $fields = 'COUNT(*)';
- else
- $fields = '*';
-
- $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 );
- }
- if ( '' !== $parent )
- $where .= $wpdb->prepare( ' AND comment_parent = %d', $parent );
- if ( '' !== $user_id )
- $where .= $wpdb->prepare( ' AND user_id = %d', $user_id );
- if ( '' !== $search )
- $where .= $this->get_search_sql( $search, array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_author_IP', 'comment_content' ) );
-
- $post_fields = array_filter( compact( array( 'post_author', 'post_name', 'post_parent', 'post_status', 'post_type', ) ) );
- if ( ! empty( $post_fields ) ) {
- $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";
- }
-
- $pieces = array( 'fields', 'join', 'where', 'orderby', 'order', 'limits', 'groupby' );
- $clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) );
- foreach ( $pieces as $piece )
- $$piece = isset( $clauses[ $piece ] ) ? $clauses[ $piece ] : '';
-
- if ( $groupby )
- $groupby = 'GROUP BY ' . $groupby;
-
- $query = "SELECT $fields FROM $wpdb->comments $join WHERE $where $groupby ORDER BY $orderby $order $limits";
-
- if ( $count )
- return $wpdb->get_var( $query );
-
- $comments = $wpdb->get_results( $query );
- $comments = apply_filters_ref_array( 'the_comments', array( $comments, &$this ) );
-
- wp_cache_add( $cache_key, $comments, 'comment' );
-
- return $comments;
- }
-
- /*
- * Used internally to generate an SQL string for searching across multiple columns
- *
- * @access protected
- * @since 3.1.0
- *
- * @param string $string
- * @param array $cols
- * @return string
- */
- function get_search_sql( $string, $cols ) {
- $string = esc_sql( like_escape( $string ) );
-
- $searches = array();
- foreach ( $cols as $col )
- $searches[] = "$col LIKE '%$string%'";
-
- return ' AND (' . implode(' OR ', $searches) . ')';
- }
-}
-
/**
* Retrieve all of the WordPress supported comment statuses.
*
* Comments have a limited set of valid status values, this provides the comment
* status values and descriptions.
*
- * @package WordPress
- * @subpackage Post
* @since 2.7.0
*
* @return array List of comment statuses.
*/
function get_comment_statuses() {
$status = array(
- 'hold' => __('Unapproved'),
- /* translators: comment status */
- 'approve' => _x('Approved', 'adjective'),
- /* translators: comment status */
- 'spam' => _x('Spam', 'adjective'),
+ 'hold' => __( 'Unapproved' ),
+ 'approve' => _x( 'Approved', 'comment status' ),
+ 'spam' => _x( 'Spam', 'comment status' ),
+ 'trash' => _x( 'Trash', 'comment status' ),
);
return $status;
}
+/**
+ * Gets the default comment status for a post type.
+ *
+ * @since 4.3.0
+ *
+ * @param string $post_type Optional. Post type. Default 'post'.
+ * @param string $comment_type Optional. Comment type. Default 'comment'.
+ * @return string Expected return value is 'open' or 'closed'.
+ */
+function get_default_comment_status( $post_type = 'post', $comment_type = 'comment' ) {
+ switch ( $comment_type ) {
+ case 'pingback' :
+ case 'trackback' :
+ $supports = 'trackbacks';
+ $option = 'ping';
+ break;
+ default :
+ $supports = 'comments';
+ $option = 'comment';
+ }
+
+ // Set the status.
+ if ( 'page' === $post_type ) {
+ $status = 'closed';
+ } elseif ( post_type_supports( $post_type, $supports ) ) {
+ $status = get_option( "default_{$option}_status" );
+ } else {
+ $status = 'closed';
+ }
+
+ /**
+ * Filters the default comment status for the given post type.
+ *
+ * @since 4.3.0
+ *
+ * @param string $status Default status for the given post type,
+ * either 'open' or 'closed'.
+ * @param string $post_type Post type. Default is `post`.
+ * @param string $comment_type Type of comment. Default is `comment`.
+ */
+ return apply_filters( 'get_default_comment_status' , $status, $post_type, $comment_type );
+}
+
/**
* The date the last comment was modified.
*
* @since 1.5.0
- * @uses $wpdb
+ * @since 4.7.0 Replaced caching the modified date in a local static variable
+ * with the Object Cache API.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $timezone Which timezone to use in reference to 'gmt', 'blog',
- * or 'server' locations.
- * @return string Last comment modified date.
+ * @param string $timezone Which timezone to use in reference to 'gmt', 'blog', or 'server' locations.
+ * @return string|false Last comment modified date on success, false on failure.
*/
-function get_lastcommentmodified($timezone = 'server') {
+function get_lastcommentmodified( $timezone = 'server' ) {
global $wpdb;
- static $cache_lastcommentmodified = array();
- if ( isset($cache_lastcommentmodified[$timezone]) )
- return $cache_lastcommentmodified[$timezone];
+ $timezone = strtolower( $timezone );
+ $key = "lastcommentmodified:$timezone";
- $add_seconds_server = date('Z');
+ $comment_modified_date = wp_cache_get( $key, 'timeinfo' );
+ if ( false !== $comment_modified_date ) {
+ return $comment_modified_date;
+ }
- switch ( strtolower($timezone)) {
+ switch ( $timezone ) {
case 'gmt':
- $lastcommentmodified = $wpdb->get_var("SELECT comment_date_gmt FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1");
+ $comment_modified_date = $wpdb->get_var( "SELECT comment_date_gmt FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1" );
break;
case 'blog':
- $lastcommentmodified = $wpdb->get_var("SELECT comment_date FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1");
+ $comment_modified_date = $wpdb->get_var( "SELECT comment_date FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1" );
break;
case 'server':
- $lastcommentmodified = $wpdb->get_var($wpdb->prepare("SELECT DATE_ADD(comment_date_gmt, INTERVAL %s SECOND) FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1", $add_seconds_server));
+ $add_seconds_server = date( 'Z' );
+
+ $comment_modified_date = $wpdb->get_var( $wpdb->prepare( "SELECT DATE_ADD(comment_date_gmt, INTERVAL %s SECOND) FROM $wpdb->comments WHERE comment_approved = '1' ORDER BY comment_date_gmt DESC LIMIT 1", $add_seconds_server ) );
break;
}
- $cache_lastcommentmodified[$timezone] = $lastcommentmodified;
+ if ( $comment_modified_date ) {
+ wp_cache_set( $key, $comment_modified_date, 'timeinfo' );
- return $lastcommentmodified;
+ return $comment_modified_date;
+ }
+
+ return false;
}
/**
* The amount of comments in a post or total comments.
*
- * A lot like {@link wp_count_comments()}, in that they both return comment
- * stats (albeit with different types). The {@link wp_count_comments()} actual
- * caches, but this function does not.
+ * A lot like wp_count_comments(), in that they both return comment stats (albeit with different types).
+ * The wp_count_comments() actually 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.
", ARRAY_A);
$comment_count = array(
- "approved" => 0,
- "awaiting_moderation" => 0,
- "spam" => 0,
- "total_comments" => 0
+ 'approved' => 0,
+ 'awaiting_moderation' => 0,
+ 'spam' => 0,
+ 'trash' => 0,
+ 'post-trashed' => 0,
+ 'total_comments' => 0,
+ 'all' => 0,
);
foreach ( $totals as $row ) {
switch ( $row['comment_approved'] ) {
+ case 'trash':
+ $comment_count['trash'] = $row['total'];
+ break;
+ case 'post-trashed':
+ $comment_count['post-trashed'] = $row['total'];
+ break;
case 'spam':
$comment_count['spam'] = $row['total'];
- $comment_count["total_comments"] += $row['total'];
+ $comment_count['total_comments'] += $row['total'];
break;
- case 1:
+ case '1':
$comment_count['approved'] = $row['total'];
$comment_count['total_comments'] += $row['total'];
+ $comment_count['all'] += $row['total'];
break;
- case 0:
+ case '0':
$comment_count['awaiting_moderation'] = $row['total'];
$comment_count['total_comments'] += $row['total'];
+ $comment_count['all'] += $row['total'];
break;
default:
break;
* Add meta data field to a comment.
*
* @since 2.9.0
- * @uses add_metadata
- * @link http://codex.wordpress.org/Function_Reference/add_comment_meta
+ * @link https://codex.wordpress.org/Function_Reference/add_comment_meta
*
* @param int $comment_id Comment ID.
* @param string $meta_key Metadata name.
* 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
+ * @link https://codex.wordpress.org/Function_Reference/delete_comment_meta
*
* @param int $comment_id comment ID
* @param string $meta_key Metadata name.
* Retrieve comment meta field for a comment.
*
* @since 2.9.0
- * @uses get_metadata
- * @link http://codex.wordpress.org/Function_Reference/get_comment_meta
+ * @link https://codex.wordpress.org/Function_Reference/get_comment_meta
*
* @param int $comment_id Comment ID.
* @param string $key Optional. The meta key to retrieve. By default, returns data for all keys.
* 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
+ * @link https://codex.wordpress.org/Function_Reference/update_comment_meta
*
* @param int $comment_id Comment ID.
* @param string $meta_key Metadata key.
* @param mixed $meta_value Metadata value.
* @param mixed $prev_value Optional. Previous value to check before removing.
- * @return bool True on success, false on failure.
+ * @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
*/
function update_comment_meta($comment_id, $meta_key, $meta_value, $prev_value = '') {
return update_metadata('comment', $comment_id, $meta_key, $meta_value, $prev_value);
}
+/**
+ * Queues comments for metadata lazy-loading.
+ *
+ * @since 4.5.0
+ *
+ * @param array $comments Array of comment objects.
+ */
+function wp_queue_comments_for_comment_meta_lazyload( $comments ) {
+ // Don't use `wp_list_pluck()` to avoid by-reference manipulation.
+ $comment_ids = array();
+ if ( is_array( $comments ) ) {
+ foreach ( $comments as $comment ) {
+ if ( $comment instanceof WP_Comment ) {
+ $comment_ids[] = $comment->comment_ID;
+ }
+ }
+ }
+
+ if ( $comment_ids ) {
+ $lazyloader = wp_metadata_lazyloader();
+ $lazyloader->queue_objects( 'comment', $comment_ids );
+ }
+}
+
/**
* 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
*/
if ( $user->exists() )
return;
- $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);
+ /**
+ * Filters the lifetime of the comment cookie in seconds.
+ *
+ * @since 2.8.0
+ *
+ * @param int $seconds Comment cookie lifetime. Default 30000000.
+ */
+ $comment_cookie_lifetime = apply_filters( 'comment_cookie_lifetime', 30000000 );
+ $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 );
}
/**
* @since 2.0.4
*/
function sanitize_comment_cookies() {
- if ( isset($_COOKIE['comment_author_'.COOKIEHASH]) ) {
- $comment_author = apply_filters('pre_comment_author_name', $_COOKIE['comment_author_'.COOKIEHASH]);
+ if ( isset( $_COOKIE['comment_author_' . COOKIEHASH] ) ) {
+ /**
+ * Filters the comment author's name cookie before it is set.
+ *
+ * When this filter hook is evaluated in wp_filter_comment(),
+ * the comment author's name string is passed.
+ *
+ * @since 1.5.0
+ *
+ * @param string $author_cookie The comment author name cookie.
+ */
+ $comment_author = apply_filters( 'pre_comment_author_name', $_COOKIE['comment_author_' . COOKIEHASH] );
$comment_author = wp_unslash($comment_author);
$comment_author = esc_attr($comment_author);
- $_COOKIE['comment_author_'.COOKIEHASH] = $comment_author;
+ $_COOKIE['comment_author_' . COOKIEHASH] = $comment_author;
}
- if ( isset($_COOKIE['comment_author_email_'.COOKIEHASH]) ) {
- $comment_author_email = apply_filters('pre_comment_author_email', $_COOKIE['comment_author_email_'.COOKIEHASH]);
+ if ( isset( $_COOKIE['comment_author_email_' . COOKIEHASH] ) ) {
+ /**
+ * Filters the comment author's email cookie before it is set.
+ *
+ * When this filter hook is evaluated in wp_filter_comment(),
+ * the comment author's email string is passed.
+ *
+ * @since 1.5.0
+ *
+ * @param string $author_email_cookie The comment author email cookie.
+ */
+ $comment_author_email = apply_filters( 'pre_comment_author_email', $_COOKIE['comment_author_email_' . COOKIEHASH] );
$comment_author_email = wp_unslash($comment_author_email);
$comment_author_email = esc_attr($comment_author_email);
$_COOKIE['comment_author_email_'.COOKIEHASH] = $comment_author_email;
}
- if ( isset($_COOKIE['comment_author_url_'.COOKIEHASH]) ) {
- $comment_author_url = apply_filters('pre_comment_author_url', $_COOKIE['comment_author_url_'.COOKIEHASH]);
+ if ( isset( $_COOKIE['comment_author_url_' . COOKIEHASH] ) ) {
+ /**
+ * Filters the comment author's URL cookie before it is set.
+ *
+ * When this filter hook is evaluated in wp_filter_comment(),
+ * the comment author's URL string is passed.
+ *
+ * @since 1.5.0
+ *
+ * @param string $author_url_cookie The comment author URL cookie.
+ */
+ $comment_author_url = apply_filters( 'pre_comment_author_url', $_COOKIE['comment_author_url_' . COOKIEHASH] );
$comment_author_url = wp_unslash($comment_author_url);
$_COOKIE['comment_author_url_'.COOKIEHASH] = $comment_author_url;
}
* Validates whether this comment is allowed to be made.
*
* @since 2.0.0
- * @uses $wpdb
- * @uses apply_filters() Calls 'pre_comment_approved' hook on the type of comment
- * @uses apply_filters() Calls 'comment_duplicate_trigger' hook on commentdata.
- * @uses do_action() Calls 'check_comment_flood' hook on $comment_author_IP, $comment_author_email, and $comment_date_gmt
+ * @since 4.7.0 The `$avoid_die` parameter was added, allowing the function to
+ * return a WP_Error object instead of dying.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param array $commentdata Contains information on the comment
- * @return mixed Signifies the approval status (0|1|'spam')
+ * @param array $commentdata Contains information on the comment.
+ * @param bool $avoid_die When true, a disallowed comment will result in the function
+ * returning a WP_Error object, rather than executing wp_die().
+ * Default false.
+ * @return int|string|WP_Error Allowed comments return the approval status (0|1|'spam').
+ * If `$avoid_die` is true, disallowed comments return a WP_Error.
*/
-function wp_allow_comment($commentdata) {
+function wp_allow_comment( $commentdata, $avoid_die = false ) {
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(
+ "AND comment_author_email = %s ",
+ wp_unslash( $commentdata['comment_author_email'] )
+ );
+ }
+ $dupe .= $wpdb->prepare(
+ ") AND comment_content = %s LIMIT 1",
+ wp_unslash( $commentdata['comment_content'] )
+ );
+
+ $dupe_id = $wpdb->get_var( $dupe );
+
+ /**
+ * Filters the ID, if any, of the duplicate comment found when creating a new comment.
+ *
+ * Return an empty value from this filter to allow what WP considers a duplicate comment.
+ *
+ * @since 4.4.0
+ *
+ * @param int $dupe_id ID of the comment identified as a duplicate.
+ * @param array $commentdata Data for the comment being created.
+ */
+ $dupe_id = apply_filters( 'duplicate_comment_id', $dupe_id, $commentdata );
+
+ if ( $dupe_id ) {
+ /**
+ * Fires immediately after a duplicate comment is detected.
+ *
+ * @since 3.0.0
+ *
+ * @param array $commentdata Comment data.
+ */
do_action( 'comment_duplicate_trigger', $commentdata );
- if ( defined('DOING_AJAX') )
- die( __('Duplicate comment detected; it looks as though you’ve already said that!') );
+ if ( true === $avoid_die ) {
+ return new WP_Error( 'comment_duplicate', __( 'Duplicate comment detected; it looks as though you’ve already said that!' ), 409 );
+ } else {
+ if ( wp_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 );
+ }
}
- do_action( 'check_comment_flood', $comment_author_IP, $comment_author_email, $comment_date_gmt );
+ /**
+ * Fires immediately before a comment is marked approved.
+ *
+ * Allows checking for comment flooding.
+ *
+ * @since 2.3.0
+ * @since 4.7.0 The `$avoid_die` parameter was added.
+ *
+ * @param string $comment_author_IP Comment author's IP address.
+ * @param string $comment_author_email Comment author's email.
+ * @param string $comment_date_gmt GMT date the comment was posted.
+ * @param bool $avoid_die Whether to prevent executing wp_die()
+ * or die() if a comment flood is occurring.
+ */
+ do_action(
+ 'check_comment_flood',
+ $commentdata['comment_author_IP'],
+ $commentdata['comment_author_email'],
+ $commentdata['comment_date_gmt'],
+ $avoid_die
+ );
+
+ /**
+ * Filters whether a comment is part of a comment flood.
+ *
+ * The default check is wp_check_comment_flood(). See check_comment_flood_db().
+ *
+ * @since 4.7.0
+ *
+ * @param bool $is_flood Is a comment flooding occurring? Default false.
+ * @param string $comment_author_IP Comment author's IP address.
+ * @param string $comment_author_email Comment author's email.
+ * @param string $comment_date_gmt GMT date the comment was posted.
+ * @param bool $avoid_die Whether to prevent executing wp_die()
+ * or die() if a comment flood is occurring.
+ */
+ $is_flood = apply_filters(
+ 'wp_is_comment_flood',
+ false,
+ $commentdata['comment_author_IP'],
+ $commentdata['comment_author_email'],
+ $commentdata['comment_date_gmt'],
+ $avoid_die
+ );
+
+ if ( $is_flood ) {
+ return new WP_Error( 'comment_flood', __( 'You are posting comments too quickly. Slow down.' ), 429 );
+ }
- 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 {
+ } 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) )
- $approved = 'spam';
+ }
+
+ 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 = EMPTY_TRASH_DAYS ? 'trash' : 'spam';
+ }
}
+ /**
+ * Filters a comment's approval status before it is set.
+ *
+ * @since 2.1.0
+ *
+ * @param bool|string $approved The approval status. Accepts 1, 0, or 'spam'.
+ * @param array $commentdata Comment data.
+ */
$approved = apply_filters( 'pre_comment_approved', $approved, $commentdata );
return $approved;
}
/**
- * Check whether comment flooding is occurring.
+ * Hooks WP's native database-based comment-flood check.
+ *
+ * This wrapper maintains backward compatibility with plugins that expect to
+ * be able to unhook the legacy check_comment_flood_db() function from
+ * 'check_comment_flood' using remove_action().
+ *
+ * @since 2.3.0
+ * @since 4.7.0 Converted to be an add_filter() wrapper.
+ */
+function check_comment_flood_db() {
+ add_filter( 'wp_is_comment_flood', 'wp_check_comment_flood', 10, 5 );
+}
+
+/**
+ * Checks whether comment flooding is occurring.
*
* Won't run, if current user can manage options, so to not block
* administrators.
*
- * @since 2.3.0
- * @uses $wpdb
- * @uses apply_filters() Calls 'comment_flood_filter' filter with first
- * parameter false, last comment timestamp, new comment timestamp.
- * @uses do_action() Calls 'comment_flood_trigger' action with parameters with
- * last comment timestamp and new comment timestamp.
- *
- * @param string $ip Comment IP.
- * @param string $email Comment author email address.
- * @param string $date MySQL time string.
+ * @since 4.7.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param bool $is_flood Is a comment flooding occurring?
+ * @param string $ip Comment IP.
+ * @param string $email Comment author email address.
+ * @param string $date MySQL time string.
+ * @param bool $avoid_die When true, a disallowed comment will result in the function
+ * returning a WP_Error object, rather than executing wp_die().
+ * Default false.
+ * @return bool Whether comment flooding is occurring.
*/
-function check_comment_flood_db( $ip, $email, $date ) {
+function wp_check_comment_flood( $is_flood, $ip, $email, $date, $avoid_die = false ) {
+
global $wpdb;
- if ( current_user_can( 'manage_options' ) )
- return; // don't throttle admins
+
+ // Another callback has declared a flood. Trust it.
+ if ( true === $is_flood ) {
+ return $is_flood;
+ }
+
+ // don't throttle admins or moderators
+ if ( current_user_can( 'manage_options' ) || current_user_can( 'moderate_comments' ) ) {
+ return false;
+ }
$hour_ago = gmdate( 'Y-m-d H:i:s', time() - HOUR_IN_SECONDS );
- if ( $lasttime = $wpdb->get_var( $wpdb->prepare( "SELECT `comment_date_gmt` FROM `$wpdb->comments` WHERE `comment_date_gmt` >= %s AND ( `comment_author_IP` = %s OR `comment_author_email` = %s ) ORDER BY `comment_date_gmt` DESC LIMIT 1", $hour_ago, $ip, $email ) ) ) {
+
+ if ( is_user_logged_in() ) {
+ $user = get_current_user_id();
+ $check_column = '`user_id`';
+ } else {
+ $user = $ip;
+ $check_column = '`comment_author_IP`';
+ }
+
+ $sql = $wpdb->prepare(
+ "SELECT `comment_date_gmt` FROM `$wpdb->comments` WHERE `comment_date_gmt` >= %s AND ( $check_column = %s OR `comment_author_email` = %s ) ORDER BY `comment_date_gmt` DESC LIMIT 1",
+ $hour_ago,
+ $user,
+ $email
+ );
+ $lasttime = $wpdb->get_var( $sql );
+ if ( $lasttime ) {
$time_lastcomment = mysql2date('U', $lasttime, false);
$time_newcomment = mysql2date('U', $date, false);
- $flood_die = apply_filters('comment_flood_filter', false, $time_lastcomment, $time_newcomment);
+ /**
+ * Filters the comment flood status.
+ *
+ * @since 2.1.0
+ *
+ * @param bool $bool Whether a comment flood is occurring. Default false.
+ * @param int $time_lastcomment Timestamp of when the last comment was posted.
+ * @param int $time_newcomment Timestamp of when the new comment was posted.
+ */
+ $flood_die = apply_filters( 'comment_flood_filter', false, $time_lastcomment, $time_newcomment );
if ( $flood_die ) {
- do_action('comment_flood_trigger', $time_lastcomment, $time_newcomment);
-
- if ( defined('DOING_AJAX') )
- die( __('You are posting comments too quickly. Slow down.') );
+ /**
+ * Fires before the comment flood message is triggered.
+ *
+ * @since 1.5.0
+ *
+ * @param int $time_lastcomment Timestamp of when the last comment was posted.
+ * @param int $time_newcomment Timestamp of when the new comment was posted.
+ */
+ do_action( 'comment_flood_trigger', $time_lastcomment, $time_newcomment );
+ if ( true === $avoid_die ) {
+ return true;
+ } else {
+ if ( wp_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 );
+ }
}
}
+
+ return false;
}
/**
* Calculate the total number of comment pages.
*
* @since 2.7.0
- * @uses get_query_var() Used to fill in the default for $per_page parameter.
- * @uses get_option() Used to fill in defaults for parameters.
+ *
* @uses Walker_Comment
*
- * @param array $comments Optional array of comment objects. Defaults to $wp_query->comments
- * @param int $per_page Optional comments per page.
- * @param boolean $threaded Optional control over flat or threaded comments.
+ * @global WP_Query $wp_query
+ *
+ * @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.
*/
function get_comment_pages_count( $comments = null, $per_page = null, $threaded = null ) {
if ( null === $comments && null === $per_page && null === $threaded && !empty($wp_query->max_num_comment_pages) )
return $wp_query->max_num_comment_pages;
- if ( !$comments || !is_array($comments) )
+ if ( ( ! $comments || ! is_array( $comments ) ) && ! empty( $wp_query->comments ) )
$comments = $wp_query->comments;
if ( empty($comments) )
return 0;
+ if ( ! get_option( 'page_comments' ) ) {
+ return 1;
+ }
+
if ( !isset($per_page) )
$per_page = (int) get_query_var('comments_per_page');
if ( 0 === $per_page )
* 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.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int $comment_ID Comment ID.
+ * @param array $args {
+ * Array of optional arguments.
+ * @type string $type Limit paginated comments to those matching a given type. Accepts 'comment',
+ * 'trackback', 'pingback', 'pings' (trackbacks and pingbacks), or 'all'.
+ * Default is 'all'.
+ * @type int $per_page Per-page count to use when calculating pagination. Defaults to the value of the
+ * 'comments_per_page' option.
+ * @type int|string $max_depth If greater than 1, comment page will be determined for the top-level parent of
+ * `$comment_ID`. Defaults to the value of the 'thread_comments_depth' option.
+ * } *
* @return int|null Comment page number or null on error.
*/
function get_page_of_comment( $comment_ID, $args = array() ) {
global $wpdb;
+ $page = null;
+
if ( !$comment = get_comment( $comment_ID ) )
return;
$defaults = array( 'type' => 'all', 'page' => '', 'per_page' => '', 'max_depth' => '' );
$args = wp_parse_args( $args, $defaults );
+ $original_args = $args;
+
+ // Order of precedence: 1. `$args['per_page']`, 2. 'comments_per_page' query_var, 3. 'comments_per_page' option.
+ if ( get_option( 'page_comments' ) ) {
+ if ( '' === $args['per_page'] ) {
+ $args['per_page'] = get_query_var( 'comments_per_page' );
+ }
+
+ if ( '' === $args['per_page'] ) {
+ $args['per_page'] = get_option( 'comments_per_page' );
+ }
+ }
- if ( '' === $args['per_page'] && get_option('page_comments') )
- $args['per_page'] = get_query_var('comments_per_page');
if ( empty($args['per_page']) ) {
$args['per_page'] = 0;
$args['page'] = 0;
}
- if ( $args['per_page'] < 1 )
- return 1;
- if ( '' === $args['max_depth'] ) {
- if ( get_option('thread_comments') )
- $args['max_depth'] = get_option('thread_comments_depth');
- else
- $args['max_depth'] = -1;
+ if ( $args['per_page'] < 1 ) {
+ $page = 1;
}
- // Find this comment's top level parent if threading is enabled
- if ( $args['max_depth'] > 1 && 0 != $comment->comment_parent )
- return get_page_of_comment( $comment->comment_parent, $args );
+ if ( null === $page ) {
+ if ( '' === $args['max_depth'] ) {
+ if ( get_option('thread_comments') )
+ $args['max_depth'] = get_option('thread_comments_depth');
+ else
+ $args['max_depth'] = -1;
+ }
+
+ // Find this comment's top level parent if threading is enabled
+ if ( $args['max_depth'] > 1 && 0 != $comment->comment_parent )
+ return get_page_of_comment( $comment->comment_parent, $args );
+
+ if ( 'desc' === get_option( 'comment_order' ) ) {
+ $compare = 'after';
+ } else {
+ $compare = 'before';
+ }
+
+ $comment_args = array(
+ 'type' => $args['type'],
+ 'post_id' => $comment->comment_post_ID,
+ 'fields' => 'ids',
+ 'count' => true,
+ 'status' => 'approve',
+ 'parent' => 0,
+ 'date_query' => array(
+ array(
+ 'column' => "$wpdb->comments.comment_date_gmt",
+ $compare => $comment->comment_date_gmt,
+ )
+ ),
+ );
+
+ $comment_query = new WP_Comment_Query();
+ $older_comment_count = $comment_query->query( $comment_args );
+
+ // No older comments? Then it's page #1.
+ if ( 0 == $older_comment_count ) {
+ $page = 1;
+
+ // Divide comments older than this one by comments per page to get this comment's page number
+ } else {
+ $page = ceil( ( $older_comment_count + 1 ) / $args['per_page'] );
+ }
+ }
+
+ /**
+ * Filters the calculated page on which a comment appears.
+ *
+ * @since 4.4.0
+ * @since 4.7.0 Introduced the `$comment_ID` parameter.
+ *
+ * @param int $page Comment page.
+ * @param array $args {
+ * Arguments used to calculate pagination. These include arguments auto-detected by the function,
+ * based on query vars, system settings, etc. For pristine arguments passed to the function,
+ * see `$original_args`.
+ *
+ * @type string $type Type of comments to count.
+ * @type int $page Calculated current page.
+ * @type int $per_page Calculated number of comments per page.
+ * @type int $max_depth Maximum comment threading depth allowed.
+ * }
+ * @param array $original_args {
+ * Array of arguments passed to the function. Some or all of these may not be set.
+ *
+ * @type string $type Type of comments to count.
+ * @type int $page Current comment page.
+ * @type int $per_page Number of comments per page.
+ * @type int $max_depth Maximum comment threading depth allowed.
+ * }
+ * @param int $comment_ID ID of the comment.
+ */
+ return apply_filters( 'get_page_of_comment', (int) $page, $args, $original_args, $comment_ID );
+}
+
+/**
+ * Retrieves the maximum character lengths for the comment form fields.
+ *
+ * @since 4.5.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @return array Maximum character length for the comment form fields.
+ */
+function wp_get_comment_fields_max_lengths() {
+ global $wpdb;
- $allowedtypes = array(
- 'comment' => '',
- 'pingback' => 'pingback',
- 'trackback' => 'trackback',
+ $lengths = array(
+ 'comment_author' => 245,
+ 'comment_author_email' => 100,
+ 'comment_author_url' => 200,
+ 'comment_content' => 65525,
);
- $comtypewhere = ( 'all' != $args['type'] && isset($allowedtypes[$args['type']]) ) ? " AND comment_type = '" . $allowedtypes[$args['type']] . "'" : '';
+ if ( $wpdb->is_mysql ) {
+ foreach ( $lengths as $column => $length ) {
+ $col_length = $wpdb->get_col_length( $wpdb->comments, $column );
+ $max_length = 0;
+
+ // No point if we can't get the DB column lengths
+ if ( is_wp_error( $col_length ) ) {
+ break;
+ }
- // Count comments older than this one
- $oldercoms = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(comment_ID) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_parent = 0 AND comment_approved = '1' AND comment_date_gmt < '%s'" . $comtypewhere, $comment->comment_post_ID, $comment->comment_date_gmt ) );
+ if ( ! is_array( $col_length ) && (int) $col_length > 0 ) {
+ $max_length = (int) $col_length;
+ } elseif ( is_array( $col_length ) && isset( $col_length['length'] ) && intval( $col_length['length'] ) > 0 ) {
+ $max_length = (int) $col_length['length'];
- // No older comments? Then it's page #1.
- if ( 0 == $oldercoms )
- return 1;
+ if ( ! empty( $col_length['type'] ) && 'byte' === $col_length['type'] ) {
+ $max_length = $max_length - 10;
+ }
+ }
+
+ if ( $max_length > 0 ) {
+ $lengths[ $column ] = $max_length;
+ }
+ }
+ }
- // Divide comments older than this one by comments per page to get this comment's page number
- return ceil( ( $oldercoms + 1 ) / $args['per_page'] );
+ /**
+ * Filters the lengths for the comment form fields.
+ *
+ * @since 4.5.0
+ *
+ * @param array $lengths Associative array `'field_name' => 'maximum length'`.
+ */
+ return apply_filters( 'wp_get_comment_fields_max_lengths', $lengths );
+}
+
+/**
+ * Compares the lengths of comment data against the maximum character limits.
+ *
+ * @since 4.7.0
+ *
+ * @param array $comment_data Array of arguments for inserting a comment.
+ * @return WP_Error|true WP_Error when a comment field exceeds the limit,
+ * otherwise true.
+ */
+function wp_check_comment_data_max_lengths( $comment_data ) {
+ $max_lengths = wp_get_comment_fields_max_lengths();
+
+ if ( isset( $comment_data['comment_author'] ) && mb_strlen( $comment_data['comment_author'], '8bit' ) > $max_lengths['comment_author'] ) {
+ return new WP_Error( 'comment_author_column_length', __( '<strong>ERROR</strong>: your name is too long.' ), 200 );
+ }
+
+ if ( isset( $comment_data['comment_author_email'] ) && strlen( $comment_data['comment_author_email'] ) > $max_lengths['comment_author_email'] ) {
+ return new WP_Error( 'comment_author_email_column_length', __( '<strong>ERROR</strong>: your email address is too long.' ), 200 );
+ }
+
+ if ( isset( $comment_data['comment_author_url'] ) && strlen( $comment_data['comment_author_url'] ) > $max_lengths['comment_author_url'] ) {
+ return new WP_Error( 'comment_author_url_column_length', __( '<strong>ERROR</strong>: your url is too long.' ), 200 );
+ }
+
+ if ( isset( $comment_data['comment_content'] ) && mb_strlen( $comment_data['comment_content'], '8bit' ) > $max_lengths['comment_content'] ) {
+ return new WP_Error( 'comment_content_column_length', __( '<strong>ERROR</strong>: your comment is too long.' ), 200 );
+ }
+
+ return true;
}
/**
* Does comment contain blacklisted characters or words.
*
* @since 1.5.0
- * @uses do_action() Calls 'wp_blacklist_check' hook for all parameters.
*
* @param string $author The author of the comment
* @param string $email The email of the comment
* @return bool True if comment contains blacklisted content, false if comment does not
*/
function wp_blacklist_check($author, $email, $url, $comment, $user_ip, $user_agent) {
- do_action('wp_blacklist_check', $author, $email, $url, $comment, $user_ip, $user_agent);
+ /**
+ * Fires before the comment is tested for blacklisted characters or words.
+ *
+ * @since 1.5.0
+ *
+ * @param string $author Comment author.
+ * @param string $email Comment author's email.
+ * @param string $url Comment author's URL.
+ * @param string $comment Comment content.
+ * @param string $user_ip Comment author's IP address.
+ * @param string $user_agent Comment author's browser user agent.
+ */
+ do_action( 'wp_blacklist_check', $author, $email, $url, $comment, $user_ip, $user_agent );
$mod_keys = trim( get_option('blacklist_keys') );
if ( '' == $mod_keys )
return false; // If moderation keys are empty
+
+ // Ensure HTML tags are not being used to bypass the blacklist.
+ $comment_without_html = wp_strip_all_tags( $comment );
+
$words = explode("\n", $mod_keys );
foreach ( (array) $words as $word ) {
|| preg_match($pattern, $email)
|| preg_match($pattern, $url)
|| preg_match($pattern, $comment)
+ || preg_match($pattern, $comment_without_html)
|| preg_match($pattern, $user_ip)
|| preg_match($pattern, $user_agent)
)
* @since 2.5.0
*
* @param int $post_id Optional. Post ID.
- * @return object Comment stats.
+ * @return object|array Comment stats.
*/
function wp_count_comments( $post_id = 0 ) {
- global $wpdb;
-
$post_id = (int) $post_id;
- $stats = apply_filters('wp_count_comments', array(), $post_id);
- if ( !empty($stats) )
- return $stats;
-
- $count = wp_cache_get("comments-{$post_id}", 'counts');
+ /**
+ * Filters the comments count for a given post.
+ *
+ * @since 2.7.0
+ *
+ * @param array $count An empty array.
+ * @param int $post_id The post ID.
+ */
+ $filtered = apply_filters( 'wp_count_comments', array(), $post_id );
+ if ( ! empty( $filtered ) ) {
+ return $filtered;
+ }
- if ( false !== $count )
+ $count = wp_cache_get( "comments-{$post_id}", 'counts' );
+ if ( false !== $count ) {
return $count;
-
- $where = '';
- if ( $post_id > 0 )
- $where = $wpdb->prepare( "WHERE comment_post_ID = %d", $post_id );
-
- $count = $wpdb->get_results( "SELECT comment_approved, COUNT( * ) AS num_comments FROM {$wpdb->comments} {$where} GROUP BY comment_approved", ARRAY_A );
-
- $total = 0;
- $approved = array('0' => 'moderated', '1' => 'approved', 'spam' => 'spam', 'trash' => 'trash', 'post-trashed' => 'post-trashed');
- foreach ( (array) $count as $row ) {
- // Don't count post-trashed toward totals
- if ( 'post-trashed' != $row['comment_approved'] && 'trash' != $row['comment_approved'] )
- $total += $row['num_comments'];
- if ( isset( $approved[$row['comment_approved']] ) )
- $stats[$approved[$row['comment_approved']]] = $row['num_comments'];
}
- $stats['total_comments'] = $total;
- foreach ( $approved as $key ) {
- if ( empty($stats[$key]) )
- $stats[$key] = 0;
- }
+ $stats = get_comment_count( $post_id );
+ $stats['moderated'] = $stats['awaiting_moderation'];
+ unset( $stats['awaiting_moderation'] );
- $stats = (object) $stats;
- wp_cache_set("comments-{$post_id}", $stats, 'counts');
+ $stats_object = (object) $stats;
+ wp_cache_set( "comments-{$post_id}", $stats_object, 'counts' );
- return $stats;
+ return $stats_object;
}
/**
* post ID available.
*
* @since 2.0.0
- * @uses $wpdb
- * @uses do_action() Calls 'delete_comment' hook on comment ID
- * @uses do_action() Calls 'deleted_comment' hook on comment ID after deletion, on success
- * @uses do_action() Calls 'wp_set_comment_status' hook on comment ID with 'delete' set for the second parameter
- * @uses wp_transition_comment_status() Passes new and old comment status along with $comment object
- *
- * @param int $comment_id Comment ID
- * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
+ * @param bool $force_delete Whether to bypass trash and force deletion. Default is false.
* @return bool True on success, false on failure.
*/
function wp_delete_comment($comment_id, $force_delete = false) {
if (!$comment = get_comment($comment_id))
return false;
- if ( !$force_delete && EMPTY_TRASH_DAYS && !in_array( wp_get_comment_status($comment_id), array( 'trash', 'spam' ) ) )
+ if ( !$force_delete && EMPTY_TRASH_DAYS && !in_array( wp_get_comment_status( $comment ), array( 'trash', 'spam' ) ) )
return wp_trash_comment($comment_id);
- do_action('delete_comment', $comment_id);
+ /**
+ * Fires immediately before a comment is deleted from the database.
+ *
+ * @since 1.2.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'delete_comment', $comment->comment_ID );
// Move children up a level.
- $children = $wpdb->get_col( $wpdb->prepare("SELECT comment_ID FROM $wpdb->comments WHERE comment_parent = %d", $comment_id) );
+ $children = $wpdb->get_col( $wpdb->prepare("SELECT comment_ID FROM $wpdb->comments WHERE comment_parent = %d", $comment->comment_ID) );
if ( !empty($children) ) {
- $wpdb->update($wpdb->comments, array('comment_parent' => $comment->comment_parent), array('comment_parent' => $comment_id));
+ $wpdb->update($wpdb->comments, array('comment_parent' => $comment->comment_parent), array('comment_parent' => $comment->comment_ID));
clean_comment_cache($children);
}
// Delete metadata
- $meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->commentmeta WHERE comment_id = %d", $comment_id ) );
+ $meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->commentmeta WHERE comment_id = %d", $comment->comment_ID ) );
foreach ( $meta_ids as $mid )
delete_metadata_by_mid( 'comment', $mid );
- if ( ! $wpdb->delete( $wpdb->comments, array( 'comment_ID' => $comment_id ) ) )
+ if ( ! $wpdb->delete( $wpdb->comments, array( 'comment_ID' => $comment->comment_ID ) ) )
return false;
- do_action('deleted_comment', $comment_id);
+
+ /**
+ * Fires immediately after a comment is deleted from the database.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'deleted_comment', $comment->comment_ID );
$post_id = $comment->comment_post_ID;
if ( $post_id && $comment->comment_approved == 1 )
wp_update_comment_count($post_id);
- clean_comment_cache($comment_id);
+ clean_comment_cache( $comment->comment_ID );
+
+ /** This action is documented in wp-includes/comment.php */
+ do_action( 'wp_set_comment_status', $comment->comment_ID, 'delete' );
- do_action('wp_set_comment_status', $comment_id, 'delete');
wp_transition_comment_status('delete', $comment->comment_approved, $comment);
return true;
}
* If trash is disabled, comment is permanently deleted.
*
* @since 2.9.0
- * @uses do_action() on 'trash_comment' before trashing
- * @uses do_action() on 'trashed_comment' after trashing
- * @uses wp_delete_comment() if trash is disabled
*
- * @param int $comment_id Comment ID.
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
* @return bool True on success, false on failure.
*/
function wp_trash_comment($comment_id) {
if ( !$comment = get_comment($comment_id) )
return false;
- do_action('trash_comment', $comment_id);
-
- if ( wp_set_comment_status($comment_id, 'trash') ) {
- add_comment_meta($comment_id, '_wp_trash_meta_status', $comment->comment_approved);
- add_comment_meta($comment_id, '_wp_trash_meta_time', time() );
- do_action('trashed_comment', $comment_id);
+ /**
+ * Fires immediately before a comment is sent to the Trash.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'trash_comment', $comment->comment_ID );
+
+ if ( wp_set_comment_status( $comment, 'trash' ) ) {
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
+ add_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', $comment->comment_approved );
+ add_comment_meta( $comment->comment_ID, '_wp_trash_meta_time', time() );
+
+ /**
+ * Fires immediately after a comment is sent to Trash.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'trashed_comment', $comment->comment_ID );
return true;
}
* Removes a comment from the Trash
*
* @since 2.9.0
- * @uses do_action() on 'untrash_comment' before untrashing
- * @uses do_action() on 'untrashed_comment' after untrashing
*
- * @param int $comment_id Comment ID.
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
* @return bool True on success, false on failure.
*/
function wp_untrash_comment($comment_id) {
- if ( ! (int)$comment_id )
+ $comment = get_comment( $comment_id );
+ if ( ! $comment ) {
return false;
+ }
- do_action('untrash_comment', $comment_id);
+ /**
+ * Fires immediately before a comment is restored from the Trash.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'untrash_comment', $comment->comment_ID );
- $status = (string) get_comment_meta($comment_id, '_wp_trash_meta_status', true);
+ $status = (string) get_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', true );
if ( empty($status) )
$status = '0';
- if ( wp_set_comment_status($comment_id, $status) ) {
- delete_comment_meta($comment_id, '_wp_trash_meta_time');
- delete_comment_meta($comment_id, '_wp_trash_meta_status');
- do_action('untrashed_comment', $comment_id);
+ if ( wp_set_comment_status( $comment, $status ) ) {
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
+ /**
+ * Fires immediately after a comment is restored from the Trash.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'untrashed_comment', $comment->comment_ID );
return true;
}
* Marks a comment as Spam
*
* @since 2.9.0
- * @uses do_action() on 'spam_comment' before spamming
- * @uses do_action() on 'spammed_comment' after spamming
*
- * @param int $comment_id Comment ID.
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
* @return bool True on success, false on failure.
*/
-function wp_spam_comment($comment_id) {
- if ( !$comment = get_comment($comment_id) )
+function wp_spam_comment( $comment_id ) {
+ $comment = get_comment( $comment_id );
+ if ( ! $comment ) {
return false;
+ }
- do_action('spam_comment', $comment_id);
-
- if ( wp_set_comment_status($comment_id, 'spam') ) {
- add_comment_meta($comment_id, '_wp_trash_meta_status', $comment->comment_approved);
- do_action('spammed_comment', $comment_id);
+ /**
+ * Fires immediately before a comment is marked as Spam.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'spam_comment', $comment->comment_ID );
+
+ if ( wp_set_comment_status( $comment, 'spam' ) ) {
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
+ add_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', $comment->comment_approved );
+ add_comment_meta( $comment->comment_ID, '_wp_trash_meta_time', time() );
+ /**
+ * Fires immediately after a comment is marked as Spam.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'spammed_comment', $comment->comment_ID );
return true;
}
* Removes a comment from the Spam
*
* @since 2.9.0
- * @uses do_action() on 'unspam_comment' before unspamming
- * @uses do_action() on 'unspammed_comment' after unspamming
*
- * @param int $comment_id Comment ID.
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
* @return bool True on success, false on failure.
*/
-function wp_unspam_comment($comment_id) {
- if ( ! (int)$comment_id )
+function wp_unspam_comment( $comment_id ) {
+ $comment = get_comment( $comment_id );
+ if ( ! $comment ) {
return false;
+ }
- do_action('unspam_comment', $comment_id);
+ /**
+ * Fires immediately before a comment is unmarked as Spam.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'unspam_comment', $comment->comment_ID );
- $status = (string) get_comment_meta($comment_id, '_wp_trash_meta_status', true);
+ $status = (string) get_comment_meta( $comment->comment_ID, '_wp_trash_meta_status', true );
if ( empty($status) )
$status = '0';
- if ( wp_set_comment_status($comment_id, $status) ) {
- delete_comment_meta($comment_id, '_wp_trash_meta_status');
- do_action('unspammed_comment', $comment_id);
+ if ( wp_set_comment_status( $comment, $status ) ) {
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_status' );
+ delete_comment_meta( $comment->comment_ID, '_wp_trash_meta_time' );
+ /**
+ * Fires immediately after a comment is unmarked as Spam.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'unspammed_comment', $comment->comment_ID );
return true;
}
*
* @since 1.0.0
*
- * @param int $comment_id Comment ID
- * @return string|bool Status might be 'trash', 'approved', 'unapproved', 'spam'. False on failure.
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object
+ * @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);
*
* Calls hooks for comment status transitions. If the new comment status is not the same
* as the previous comment status, then two hooks will be ran, the first is
- * 'transition_comment_status' with new status, old status, and comment data. The
- * next action called is 'comment_OLDSTATUS_to_NEWSTATUS' the NEWSTATUS is the
- * $new_status parameter and the OLDSTATUS is $old_status parameter; it has the
+ * {@see 'transition_comment_status'} with new status, old status, and comment data. The
+ * next action called is {@see comment_$old_status_to_$new_status'}. It has the
* comment data.
*
* The final action will run whether or not the comment statuses are the same. The
- * action is named 'comment_NEWSTATUS_COMMENTTYPE', NEWSTATUS is from the $new_status
- * parameter and COMMENTTYPE is comment_type comment data.
+ * action is named {@see 'comment_$new_status_$comment->comment_type'}.
*
* @since 2.7.0
*
* @param object $comment Comment data.
*/
function wp_transition_comment_status($new_status, $old_status, $comment) {
- // Translate raw statuses to human readable formats for the hooks
- // This is not a complete list of comment status, it's only the ones that need to be renamed
+ /*
+ * Translate raw statuses to human readable formats for the hooks.
+ * This is not a complete list of comment status, it's only the ones
+ * that need to be renamed
+ */
$comment_statuses = array(
0 => 'unapproved',
'hold' => 'unapproved', // wp_set_comment_status() uses "hold"
// Call the hooks
if ( $new_status != $old_status ) {
- do_action('transition_comment_status', $new_status, $old_status, $comment);
- do_action("comment_{$old_status}_to_{$new_status}", $comment);
+ /**
+ * Fires when the comment status is in transition.
+ *
+ * @since 2.7.0
+ *
+ * @param int|string $new_status The new comment status.
+ * @param int|string $old_status The old comment status.
+ * @param object $comment The comment data.
+ */
+ do_action( '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`,
+ * refer to the old and new comment statuses, respectively.
+ *
+ * @since 2.7.0
+ *
+ * @param WP_Comment $comment Comment object.
+ */
+ do_action( "comment_{$old_status}_to_{$new_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`,
+ * refer to the new comment status, and the type of comment, respectively.
+ *
+ * Typical comment types include an empty string (standard comment), 'pingback',
+ * or 'trackback'.
+ *
+ * @since 2.7.0
+ *
+ * @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 );
+}
+
+/**
+ * Clear the lastcommentmodified cached value when a comment status is changed.
+ *
+ * Deletes the lastcommentmodified cache key when a comment enters or leaves
+ * 'approved' status.
+ *
+ * @since 4.7.0
+ * @access private
+ *
+ * @param string $new_status The new comment status.
+ * @param string $old_status The old comment status.
+ */
+function _clear_modified_cache_on_transition_comment_status( $new_status, $old_status ) {
+ if ( 'approved' === $new_status || 'approved' === $old_status ) {
+ foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
+ wp_cache_delete( "lastcommentmodified:$timezone", 'timeinfo' );
+ }
}
- do_action("comment_{$new_status}_{$comment->comment_type}", $comment->comment_ID, $comment);
}
/**
if ( isset($_COOKIE['comment_author_url_'.COOKIEHASH]) )
$comment_author_url = $_COOKIE['comment_author_url_'.COOKIEHASH];
- return apply_filters('wp_get_current_commenter', compact('comment_author', 'comment_author_email', 'comment_author_url'));
+ /**
+ * Filters the current commenter's name, email, and URL.
+ *
+ * @since 3.1.0
+ *
+ * @param array $comment_author_data {
+ * An array of current commenter variables.
+ *
+ * @type string $comment_author The name of the author of the comment. Default empty.
+ * @type string $comment_author_email The email address of the `$comment_author`. Default empty.
+ * @type string $comment_author_url The URL address of the `$comment_author`. Default empty.
+ * }
+ */
+ return apply_filters( 'wp_get_current_commenter', compact('comment_author', 'comment_author_email', 'comment_author_url') );
}
/**
- * Inserts a comment to the database.
- *
- * The available comment data key names are 'comment_author_IP', 'comment_date',
- * 'comment_date_gmt', 'comment_parent', 'comment_approved', and 'user_id'.
+ * Inserts a comment into the database.
*
* @since 2.0.0
- * @uses $wpdb
- *
- * @param array $commentdata Contains information on the comment.
- * @return int The new comment's ID.
+ * @since 4.4.0 Introduced `$comment_meta` argument.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $commentdata {
+ * Array of arguments for inserting a new comment.
+ *
+ * @type string $comment_agent The HTTP user agent of the `$comment_author` when
+ * the comment was submitted. Default empty.
+ * @type int|string $comment_approved Whether the comment has been approved. Default 1.
+ * @type string $comment_author The name of the author of the comment. Default empty.
+ * @type string $comment_author_email The email address of the `$comment_author`. Default empty.
+ * @type string $comment_author_IP The IP address of the `$comment_author`. Default empty.
+ * @type string $comment_author_url The URL address of the `$comment_author`. Default empty.
+ * @type string $comment_content The content of the comment. Default empty.
+ * @type string $comment_date The date the comment was submitted. To set the date
+ * manually, `$comment_date_gmt` must also be specified.
+ * Default is the current time.
+ * @type string $comment_date_gmt The date the comment was submitted in the GMT timezone.
+ * Default is `$comment_date` in the site's GMT timezone.
+ * @type int $comment_karma The karma of the comment. Default 0.
+ * @type int $comment_parent ID of this comment's parent, if any. Default 0.
+ * @type int $comment_post_ID ID of the post that relates to the comment, if any.
+ * Default 0.
+ * @type string $comment_type Comment type. Default empty.
+ * @type array $comment_meta Optional. Array of key/value pairs to be stored in commentmeta for the
+ * new comment.
+ * @type int $user_id ID of the user who submitted the comment. Default 0.
+ * }
+ * @return int|false 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 );
+
+ $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'] ) ? 0 : $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;
+ }
+
+ $id = (int) $wpdb->insert_id;
+
+ if ( $comment_approved == 1 ) {
+ wp_update_comment_count( $comment_post_ID );
- $id = (int) $wpdb->insert_id;
+ foreach ( array( 'server', 'gmt', 'blog' ) as $timezone ) {
+ wp_cache_delete( "lastcommentmodified:$timezone", 'timeinfo' );
+ }
+ }
- if ( $comment_approved == 1 )
- wp_update_comment_count($comment_post_ID);
+ clean_comment_cache( $id );
- $comment = get_comment($id);
- do_action('wp_insert_comment', $id, $comment);
+ $comment = get_comment( $id );
- wp_cache_set( 'last_changed', microtime(), 'comment' );
+ // If metadata is provided, store it.
+ if ( isset( $commentdata['comment_meta'] ) && is_array( $commentdata['comment_meta'] ) ) {
+ foreach ( $commentdata['comment_meta'] as $meta_key => $meta_value ) {
+ add_comment_meta( $comment->comment_ID, $meta_key, $meta_value, true );
+ }
+ }
+
+ /**
+ * Fires immediately after a comment is inserted into the database.
+ *
+ * @since 2.8.0
+ *
+ * @param int $id The comment ID.
+ * @param WP_Comment $comment Comment object.
+ */
+ do_action( 'wp_insert_comment', $id, $comment );
return $id;
}
* filtering the same comment more than once.
*
* @since 2.0.0
- * @uses apply_filters() Calls 'pre_user_id' hook on comment author's user ID
- * @uses apply_filters() Calls 'pre_comment_user_agent' hook on comment author's user agent
- * @uses apply_filters() Calls 'pre_comment_author_name' hook on comment author's name
- * @uses apply_filters() Calls 'pre_comment_content' hook on the comment's content
- * @uses apply_filters() Calls 'pre_comment_user_ip' hook on comment author's IP
- * @uses apply_filters() Calls 'pre_comment_author_url' hook on comment author's URL
- * @uses apply_filters() Calls 'pre_comment_author_email' hook on comment author's email address
*
* @param array $commentdata Contains information on the comment.
* @return array Parsed comment information.
*/
function wp_filter_comment($commentdata) {
- if ( isset($commentdata['user_ID']) )
- $commentdata['user_id'] = apply_filters('pre_user_id', $commentdata['user_ID']);
- elseif ( isset($commentdata['user_id']) )
- $commentdata['user_id'] = apply_filters('pre_user_id', $commentdata['user_id']);
- $commentdata['comment_agent'] = apply_filters('pre_comment_user_agent', ( isset( $commentdata['comment_agent'] ) ? $commentdata['comment_agent'] : '' ) );
- $commentdata['comment_author'] = apply_filters('pre_comment_author_name', $commentdata['comment_author']);
- $commentdata['comment_content'] = apply_filters('pre_comment_content', $commentdata['comment_content']);
- $commentdata['comment_author_IP'] = apply_filters('pre_comment_user_ip', $commentdata['comment_author_IP']);
- $commentdata['comment_author_url'] = apply_filters('pre_comment_author_url', $commentdata['comment_author_url']);
- $commentdata['comment_author_email'] = apply_filters('pre_comment_author_email', $commentdata['comment_author_email']);
+ if ( isset( $commentdata['user_ID'] ) ) {
+ /**
+ * Filters the comment author's user id before it is set.
+ *
+ * The first time this filter is evaluated, 'user_ID' is checked
+ * (for back-compat), followed by the standard 'user_id' value.
+ *
+ * @since 1.5.0
+ *
+ * @param int $user_ID The comment author's user ID.
+ */
+ $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_ID'] );
+ } elseif ( isset( $commentdata['user_id'] ) ) {
+ /** This filter is documented in wp-includes/comment.php */
+ $commentdata['user_id'] = apply_filters( 'pre_user_id', $commentdata['user_id'] );
+ }
+
+ /**
+ * Filters the comment author's browser user agent before it is set.
+ *
+ * @since 1.5.0
+ *
+ * @param string $comment_agent The comment author's browser user agent.
+ */
+ $commentdata['comment_agent'] = apply_filters( 'pre_comment_user_agent', ( isset( $commentdata['comment_agent'] ) ? $commentdata['comment_agent'] : '' ) );
+ /** This filter is documented in wp-includes/comment.php */
+ $commentdata['comment_author'] = apply_filters( 'pre_comment_author_name', $commentdata['comment_author'] );
+ /**
+ * Filters the comment content before it is set.
+ *
+ * @since 1.5.0
+ *
+ * @param string $comment_content The comment content.
+ */
+ $commentdata['comment_content'] = apply_filters( 'pre_comment_content', $commentdata['comment_content'] );
+ /**
+ * Filters the comment author's IP before it is set.
+ *
+ * @since 1.5.0
+ *
+ * @param string $comment_author_ip The comment author's IP.
+ */
+ $commentdata['comment_author_IP'] = apply_filters( 'pre_comment_user_ip', $commentdata['comment_author_IP'] );
+ /** This filter is documented in wp-includes/comment.php */
+ $commentdata['comment_author_url'] = apply_filters( 'pre_comment_author_url', $commentdata['comment_author_url'] );
+ /** This filter is documented in wp-includes/comment.php */
+ $commentdata['comment_author_email'] = apply_filters( 'pre_comment_author_email', $commentdata['comment_author_email'] );
$commentdata['filtered'] = true;
return $commentdata;
}
/**
- * Whether comment should be blocked because of comment flood.
+ * Whether a comment should be blocked because of comment flood.
*
* @since 2.1.0
*
* Adds a new comment to the database.
*
* Filters new comment to ensure that the fields are sanitized and valid before
- * inserting comment into database. Calls 'comment_post' action with comment ID
- * and whether comment is approved by WordPress. Also has 'preprocess_comment'
+ * inserting comment into database. Calls {@see 'comment_post'} action with comment ID
+ * and whether comment is approved by WordPress. Also has {@see 'preprocess_comment'}
* filter for processing the comment data before the function handles it.
*
- * We use REMOTE_ADDR here directly. If you are behind a proxy, you should ensure
+ * 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}
*
- * @since 1.5.0
- * @uses apply_filters() Calls 'preprocess_comment' hook on $commentdata parameter array before processing
- * @uses do_action() Calls 'comment_post' hook on $comment_ID returned from adding the comment and if the comment was approved.
- * @uses wp_filter_comment() Used to filter comment before adding comment.
- * @uses wp_allow_comment() checks to see if comment is approved.
- * @uses wp_insert_comment() Does the actual comment insertion to the database.
+ * See {@link https://core.trac.wordpress.org/ticket/9235}
*
- * @param array $commentdata Contains information on the comment.
- * @return int The ID of the comment after adding.
+ * @since 1.5.0
+ * @since 4.3.0 'comment_agent' and 'comment_author_IP' can be set via `$commentdata`.
+ * @since 4.7.0 The `$avoid_die` parameter was added, allowing the function to
+ * return a WP_Error object instead of dying.
+ *
+ * @see wp_insert_comment()
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $commentdata {
+ * Comment data.
+ *
+ * @type string $comment_author The name of the comment author.
+ * @type string $comment_author_email The comment author email address.
+ * @type string $comment_author_url The comment author URL.
+ * @type string $comment_content The content of the comment.
+ * @type string $comment_date The date the comment was submitted. Default is the current time.
+ * @type string $comment_date_gmt The date the comment was submitted in the GMT timezone.
+ * Default is `$comment_date` in the GMT timezone.
+ * @type int $comment_parent The ID of this comment's parent, if any. Default 0.
+ * @type int $comment_post_ID The ID of the post that relates to the comment.
+ * @type int $user_id The ID of the user who submitted the comment. Default 0.
+ * @type int $user_ID Kept for backward-compatibility. Use `$user_id` instead.
+ * @type string $comment_agent Comment author user agent. Default is the value of 'HTTP_USER_AGENT'
+ * in the `$_SERVER` superglobal sent in the original request.
+ * @type string $comment_author_IP Comment author IP address in IPv4 format. Default is the value of
+ * 'REMOTE_ADDR' in the `$_SERVER` superglobal sent in the original request.
+ * }
+ * @param bool $avoid_die Should errors be returned as WP_Error objects instead of
+ * executing wp_die()? Default false.
+ * @return int|false|WP_Error The ID of the comment on success, false or WP_Error on failure.
*/
-function wp_new_comment( $commentdata ) {
- $commentdata = apply_filters('preprocess_comment', $commentdata);
+function wp_new_comment( $commentdata, $avoid_die = false ) {
+ global $wpdb;
+
+ 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;
+
+ /**
+ * Filters a comment's data before it is sanitized and inserted into the database.
+ *
+ * @since 1.5.0
+ *
+ * @param array $commentdata Comment data.
+ */
+ $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']) : '';
$commentdata['comment_parent'] = ( 'approved' == $parent_status || 'unapproved' == $parent_status ) ? $commentdata['comment_parent'] : 0;
- $commentdata['comment_author_IP'] = preg_replace( '/[^0-9a-fA-F:., ]/', '',$_SERVER['REMOTE_ADDR'] );
- $commentdata['comment_agent'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? substr( $_SERVER['HTTP_USER_AGENT'], 0, 254 ) : '';
+ if ( ! isset( $commentdata['comment_author_IP'] ) ) {
+ $commentdata['comment_author_IP'] = $_SERVER['REMOTE_ADDR'];
+ }
+ $commentdata['comment_author_IP'] = preg_replace( '/[^0-9a-fA-F:., ]/', '', $commentdata['comment_author_IP'] );
+
+ if ( ! isset( $commentdata['comment_agent'] ) ) {
+ $commentdata['comment_agent'] = isset( $_SERVER['HTTP_USER_AGENT'] ) ? $_SERVER['HTTP_USER_AGENT']: '';
+ }
+ $commentdata['comment_agent'] = substr( $commentdata['comment_agent'], 0, 254 );
+
+ if ( empty( $commentdata['comment_date'] ) ) {
+ $commentdata['comment_date'] = current_time('mysql');
+ }
- $commentdata['comment_date'] = current_time('mysql');
- $commentdata['comment_date_gmt'] = current_time('mysql', 1);
+ if ( empty( $commentdata['comment_date_gmt'] ) ) {
+ $commentdata['comment_date_gmt'] = current_time( 'mysql', 1 );
+ }
$commentdata = wp_filter_comment($commentdata);
- $commentdata['comment_approved'] = wp_allow_comment($commentdata);
+ $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $avoid_die );
+ if ( is_wp_error( $commentdata['comment_approved'] ) ) {
+ return $commentdata['comment_approved'];
+ }
$comment_ID = wp_insert_comment($commentdata);
+ if ( ! $comment_ID ) {
+ $fields = array( 'comment_author', 'comment_author_email', 'comment_author_url', 'comment_content' );
- do_action('comment_post', $comment_ID, $commentdata['comment_approved']);
+ foreach ( $fields as $field ) {
+ if ( isset( $commentdata[ $field ] ) ) {
+ $commentdata[ $field ] = $wpdb->strip_invalid_text_for_column( $wpdb->comments, $field, $commentdata[ $field ] );
+ }
+ }
- if ( 'spam' !== $commentdata['comment_approved'] ) { // If it's spam save it silently for later crunching
- if ( '0' == $commentdata['comment_approved'] )
- wp_notify_moderator($comment_ID);
+ $commentdata = wp_filter_comment( $commentdata );
- $post = get_post($commentdata['comment_post_ID']); // Don't notify if it's your own comment
+ $commentdata['comment_approved'] = wp_allow_comment( $commentdata, $avoid_die );
+ if ( is_wp_error( $commentdata['comment_approved'] ) ) {
+ return $commentdata['comment_approved'];
+ }
- if ( get_option('comments_notify') && $commentdata['comment_approved'] && ( ! isset( $commentdata['user_id'] ) || $post->post_author != $commentdata['user_id'] ) )
- wp_notify_postauthor($comment_ID, isset( $commentdata['comment_type'] ) ? $commentdata['comment_type'] : '' );
+ $comment_ID = wp_insert_comment( $commentdata );
+ if ( ! $comment_ID ) {
+ return false;
+ }
}
+ /**
+ * Fires immediately after a comment is inserted into the database.
+ *
+ * @since 1.2.0
+ * @since 4.5.0 The `$commentdata` parameter was added.
+ *
+ * @param int $comment_ID The comment ID.
+ * @param int|string $comment_approved 1 if the comment is approved, 0 if not, 'spam' if spam.
+ * @param array $commentdata Comment data.
+ */
+ do_action( 'comment_post', $comment_ID, $commentdata['comment_approved'], $commentdata );
+
return $comment_ID;
}
+/**
+ * Send a comment moderation notification to the comment moderator.
+ *
+ * @since 4.4.0
+ *
+ * @param int $comment_ID ID of the comment.
+ * @return bool True on success, false on failure.
+ */
+function wp_new_comment_notify_moderator( $comment_ID ) {
+ $comment = get_comment( $comment_ID );
+
+ // Only send notifications for pending comments.
+ $maybe_notify = ( '0' == $comment->comment_approved );
+
+ /** This filter is documented in wp-includes/comment.php */
+ $maybe_notify = apply_filters( 'notify_moderator', $maybe_notify, $comment_ID );
+
+ if ( ! $maybe_notify ) {
+ return false;
+ }
+
+ return wp_notify_moderator( $comment_ID );
+}
+
+/**
+ * Send a notification of a new comment to the post author.
+ *
+ * @since 4.4.0
+ *
+ * Uses the {@see 'notify_post_author'} filter to determine whether the post author
+ * should be notified when a new comment is added, overriding site setting.
+ *
+ * @param int $comment_ID Comment ID.
+ * @return bool True on success, false on failure.
+ */
+function wp_new_comment_notify_postauthor( $comment_ID ) {
+ $comment = get_comment( $comment_ID );
+
+ $maybe_notify = get_option( 'comments_notify' );
+
+ /**
+ * Filters whether to send the post author new comment notification emails,
+ * overriding the site setting.
+ *
+ * @since 4.4.0
+ *
+ * @param bool $maybe_notify Whether to notify the post author about the new comment.
+ * @param int $comment_ID The ID of the comment for the notification.
+ */
+ $maybe_notify = apply_filters( 'notify_post_author', $maybe_notify, $comment_ID );
+
+ /*
+ * wp_notify_postauthor() checks if notifying the author of their own comment.
+ * By default, it won't, but filters can override this.
+ */
+ if ( ! $maybe_notify ) {
+ return false;
+ }
+
+ // Only send notifications for approved comments.
+ if ( ! isset( $comment->comment_approved ) || '1' != $comment->comment_approved ) {
+ return false;
+ }
+
+ return wp_notify_postauthor( $comment_ID );
+}
+
/**
* Sets the status of a comment.
*
- * The 'wp_set_comment_status' action is called after the comment is handled.
+ * The {@see 'wp_set_comment_status'} action is called after the comment is handled.
* 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'.
- * @param bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int|WP_Comment $comment_id Comment ID or WP_Comment object.
+ * @param string $comment_status New comment status, either 'hold', 'approve', 'spam', or 'trash'.
+ * @param bool $wp_error Whether to return a WP_Error object if there is a failure. Default is false.
* @return bool|WP_Error True on success, false or WP_Error on failure.
*/
function wp_set_comment_status($comment_id, $comment_status, $wp_error = false) {
global $wpdb;
- $status = '0';
switch ( $comment_status ) {
case 'hold':
case '0':
case 'approve':
case '1':
$status = '1';
- if ( get_option('comments_notify') ) {
- $comment = get_comment($comment_id);
- wp_notify_postauthor($comment_id, $comment->comment_type);
- }
+ add_action( 'wp_set_comment_status', 'wp_new_comment_notify_postauthor' );
break;
case 'spam':
$status = 'spam';
$comment_old = clone get_comment($comment_id);
- if ( !$wpdb->update( $wpdb->comments, array('comment_approved' => $status), array('comment_ID' => $comment_id) ) ) {
+ if ( !$wpdb->update( $wpdb->comments, array('comment_approved' => $status), array( 'comment_ID' => $comment_old->comment_ID ) ) ) {
if ( $wp_error )
return new WP_Error('db_update_error', __('Could not update comment status'), $wpdb->last_error);
else
return false;
}
- clean_comment_cache($comment_id);
+ clean_comment_cache( $comment_old->comment_ID );
- $comment = get_comment($comment_id);
+ $comment = get_comment( $comment_old->comment_ID );
+
+ /**
+ * Fires immediately before transitioning a comment's status from one to another
+ * in the database.
+ *
+ * @since 1.5.0
+ *
+ * @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->comment_ID, $comment_status );
- 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);
* 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.
// First, get all of the original fields
$comment = get_comment($commentarr['comment_ID'], ARRAY_A);
+ if ( empty( $comment ) ) {
+ return 0;
+ }
+
+ // Make sure that the comment post ID is valid (if specified).
+ if ( ! empty( $commentarr['comment_post_ID'] ) && ! get_post( $commentarr['comment_post_ID'] ) ) {
+ return 0;
+ }
// Escape data pulled from DB.
$comment = wp_slash($comment);
$commentarr = wp_filter_comment( $commentarr );
// Now extract the merged array.
- extract(wp_unslash($commentarr), EXTR_SKIP);
+ $data = wp_unslash( $commentarr );
+
+ /**
+ * Filters the comment content before it is updated in the database.
+ *
+ * @since 1.5.0
+ *
+ * @param string $comment_content The comment data.
+ */
+ $data['comment_content'] = apply_filters( 'comment_save_pre', $data['comment_content'] );
+
+ $data['comment_date_gmt'] = get_gmt_from_date( $data['comment_date'] );
- $comment_content = apply_filters('comment_save_pre', $comment_content);
+ if ( ! isset( $data['comment_approved'] ) ) {
+ $data['comment_approved'] = 1;
+ } elseif ( 'hold' == $data['comment_approved'] ) {
+ $data['comment_approved'] = 0;
+ } elseif ( 'approve' == $data['comment_approved'] ) {
+ $data['comment_approved'] = 1;
+ }
- $comment_date_gmt = get_gmt_from_date($comment_date);
+ $comment_ID = $data['comment_ID'];
+ $comment_post_ID = $data['comment_post_ID'];
+ $keys = array( 'comment_post_ID', 'comment_content', 'comment_author', 'comment_author_email', 'comment_approved', 'comment_karma', 'comment_author_url', 'comment_date', 'comment_date_gmt', 'comment_type', 'comment_parent', 'user_id', 'comment_agent', 'comment_author_IP' );
+ $data = wp_array_slice_assoc( $data, $keys );
- if ( !isset($comment_approved) )
- $comment_approved = 1;
- else if ( 'hold' == $comment_approved )
- $comment_approved = 0;
- else if ( 'approve' == $comment_approved )
- $comment_approved = 1;
+ /**
+ * Filters the comment data immediately before it is updated in the database.
+ *
+ * Note: data being passed to the filter is already unslashed.
+ *
+ * @since 4.7.0
+ *
+ * @param array $data The new, processed comment data.
+ * @param array $comment The old, unslashed comment data.
+ * @param array $commentarr The new, raw comment data.
+ */
+ $data = apply_filters( 'wp_update_comment_data', $data, $comment, $commentarr );
- $data = compact( 'comment_content', 'comment_author', 'comment_author_email', 'comment_approved', 'comment_karma', 'comment_author_url', 'comment_date', 'comment_date_gmt', 'comment_parent' );
$rval = $wpdb->update( $wpdb->comments, $data, compact( 'comment_ID' ) );
- clean_comment_cache($comment_ID);
- wp_update_comment_count($comment_post_ID);
- do_action('edit_comment', $comment_ID);
+ clean_comment_cache( $comment_ID );
+ wp_update_comment_count( $comment_post_ID );
+ /**
+ * Fires immediately after a comment is updated in the database.
+ *
+ * The hook also fires immediately before comment status transition hooks are fired.
+ *
+ * @since 1.2.0
+ * @since 4.6.0 Added the `$data` parameter.
+ *
+ * @param int $comment_ID The comment ID.
+ * @param array $data Comment data.
+ */
+ do_action( 'edit_comment', $comment_ID, $data );
$comment = get_comment($comment_ID);
wp_transition_comment_status($comment->comment_approved, $old_status, $comment);
return $rval;
* @staticvar bool $_defer
*
* @param bool $defer
- * @return unknown
+ * @return bool
*/
function wp_defer_comment_counting($defer=null) {
static $_defer = false;
* @since 2.1.0
* @see wp_update_comment_count_now() For what could cause a false return value
*
- * @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
+ * @staticvar array $_deferred
+ *
+ * @param int|null $post_id Post ID.
+ * @param bool $do_deferred Optional. Whether to process previously deferred
+ * post comment counts. Default false.
+ * @return bool|void True on success, false on failure or if post with ID does
+ * not exist.
*/
function wp_update_comment_count($post_id, $do_deferred=false) {
static $_deferred = array();
+ if ( empty( $post_id ) && ! $do_deferred ) {
+ return false;
+ }
+
if ( $do_deferred ) {
$_deferred = array_unique($_deferred);
foreach ( $_deferred as $i => $_post_id ) {
* Updates the comment count for the post.
*
* @since 2.5.0
- * @uses $wpdb
- * @uses do_action() Calls 'wp_update_comment_count' hook on $post_id, $new, and $old
- * @uses do_action() Calls 'edit_posts' hook on $post_id and $post
+ *
+ * @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.
$post_id = (int) $post_id;
if ( !$post_id )
return false;
+
+ wp_cache_delete( 'comments-0', 'counts' );
+ wp_cache_delete( "comments-{$post_id}", 'counts' );
+
if ( !$post = get_post($post_id) )
return false;
$old = (int) $post->comment_count;
- $new = (int) $wpdb->get_var( $wpdb->prepare("SELECT COUNT(*) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1'", $post_id) );
+
+ /**
+ * Filters a post's comment count before it is updated in the database.
+ *
+ * @since 4.5.0
+ *
+ * @param int $new The new comment count. Default null.
+ * @param int $old The old comment count.
+ * @param int $post_id Post ID.
+ */
+ $new = apply_filters( 'pre_wp_update_comment_count_now', null, $old, $post_id );
+
+ if ( is_null( $new ) ) {
+ $new = (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->comments WHERE comment_post_ID = %d AND comment_approved = '1'", $post_id ) );
+ } else {
+ $new = (int) $new;
+ }
+
$wpdb->update( $wpdb->posts, array('comment_count' => $new), array('ID' => $post_id) );
clean_post_cache( $post );
- do_action('wp_update_comment_count', $post_id, $new, $old);
- do_action('edit_post', $post_id, $post);
+ /**
+ * Fires immediately after a post's comment count is updated in the database.
+ *
+ * @since 2.3.0
+ *
+ * @param int $post_id Post ID.
+ * @param int $new The new comment count.
+ * @param int $old The old comment count.
+ */
+ do_action( 'wp_update_comment_count', $post_id, $new, $old );
+ /** This action is documented in wp-includes/post.php */
+ do_action( 'edit_post', $post_id, $post );
return true;
}
*
* @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 ) )
- _deprecated_argument( __FUNCTION__, '2.7' );
+ _deprecated_argument( __FUNCTION__, '2.7.0' );
$pingback_str_dquote = 'rel="pingback"';
$pingback_str_squote = 'rel=\'pingback\'';
/** @todo Should use Filter Extension or custom preg_match instead. */
$parsed_url = parse_url($url);
- if ( ! isset( $parsed_url['host'] ) ) // Not an URL. This should never happen.
+ if ( ! isset( $parsed_url['host'] ) ) // Not a URL. This should never happen.
return false;
//Do not search for a pingback server on our own uploads
- $uploads_dir = wp_upload_dir();
+ $uploads_dir = wp_get_upload_dir();
if ( 0 === strpos($url, $uploads_dir['baseurl']) )
return false;
* 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;
* Perform trackbacks.
*
* @since 1.5.0
- * @uses $wpdb
+ * @since 4.7.0 $post_id can be a WP_Post object.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int $post_id Post ID to do trackbacks on.
+ * @param int|WP_Post $post_id Post object or ID to do trackbacks on.
*/
-function do_trackbacks($post_id) {
+function do_trackbacks( $post_id ) {
global $wpdb;
-
$post = get_post( $post_id );
- $to_ping = get_to_ping($post_id);
- $pinged = get_pung($post_id);
- if ( empty($to_ping) ) {
- $wpdb->update($wpdb->posts, array('to_ping' => ''), array('ID' => $post_id) );
+ if ( ! $post ) {
+ return false;
+ }
+
+ $to_ping = get_to_ping( $post );
+ $pinged = get_pung( $post );
+ if ( empty( $to_ping ) ) {
+ $wpdb->update($wpdb->posts, array( 'to_ping' => '' ), array( 'ID' => $post->ID ) );
return;
}
- if ( empty($post->post_excerpt) )
- $excerpt = apply_filters('the_content', $post->post_content, $post->ID);
- else
- $excerpt = apply_filters('the_excerpt', $post->post_excerpt);
+ if ( empty($post->post_excerpt) ) {
+ /** 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-includes/post-template.php */
+ $excerpt = apply_filters( 'the_excerpt', $post->post_excerpt );
+ }
+
$excerpt = str_replace(']]>', ']]>', $excerpt);
$excerpt = wp_html_excerpt($excerpt, 252, '…');
- $post_title = apply_filters('the_title', $post->post_title, $post->ID);
+ /** This filter is documented in wp-includes/post-template.php */
+ $post_title = apply_filters( 'the_title', $post->post_title, $post->ID );
$post_title = strip_tags($post_title);
if ( $to_ping ) {
foreach ( (array) $to_ping as $tb_ping ) {
$tb_ping = trim($tb_ping);
if ( !in_array($tb_ping, $pinged) ) {
- trackback($tb_ping, $post_title, $excerpt, $post_id);
+ trackback( $tb_ping, $post_title, $excerpt, $post->ID );
$pinged[] = $tb_ping;
} else {
- $wpdb->query( $wpdb->prepare("UPDATE $wpdb->posts SET to_ping = TRIM(REPLACE(to_ping, %s, '')) WHERE ID = %d", $tb_ping, $post_id) );
+ $wpdb->query( $wpdb->prepare( "UPDATE $wpdb->posts SET to_ping = TRIM(REPLACE(to_ping, %s,
+ '')) WHERE ID = %d", $tb_ping, $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);
* Pings back the links found in a post.
*
* @since 0.71
- * @uses $wp_version
- * @uses IXR_Client
+ * @since 4.7.0 $post_id can be a WP_Post object.
*
- * @param string $content Post content to check for links.
- * @param int $post_ID Post ID.
+ * @param string $content Post content to check for links. If empty will retrieve from post.
+ * @param int|WP_Post $post_id Post Object or ID.
*/
-function pingback($content, $post_ID) {
- global $wp_version;
- include_once(ABSPATH . WPINC . '/class-IXR.php');
- include_once(ABSPATH . WPINC . '/class-wp-http-ixr-client.php');
+function pingback( $content, $post_id ) {
+ include_once( ABSPATH . WPINC . '/class-IXR.php' );
+ include_once( ABSPATH . WPINC . '/class-wp-http-ixr-client.php' );
// original code by Mort (http://mort.mine.nu:8080)
$post_links = array();
- $pung = get_pung($post_ID);
+ $post = get_post( $post_id );
+ if ( ! $post ) {
+ return;
+ }
+
+ $pung = get_pung( $post );
- // Variables
- $ltrs = '\w';
- $gunk = '/#~:.?+=&%@!\-';
- $punc = '.:?\-';
- $any = $ltrs . $gunk . $punc;
+ if ( empty( $content ) ) {
+ $content = $post->post_content;
+ }
// Step 1
// Parsing the post, external links (if any) are stored in the $post_links array
- // This regexp comes straight from phpfreaks.com
- // http://www.phpfreaks.com/quickcode/Extract_All_URLs_on_a_Page/15.php
- preg_match_all("{\b http : [$any] +? (?= [$punc] * [^$any] | $)}x", $content, $post_links_temp);
+ $post_links_temp = wp_extract_urls( $content );
// Step 2.
// Walking thru the links array
// http://dummy-weblog.org/post.php
// We don't wanna ping first and second types, even if they have a valid <link/>
- foreach ( (array) $post_links_temp[0] as $link_test ) :
- if ( !in_array($link_test, $pung) && (url_to_postid($link_test) != $post_ID) // If we haven't pung it already and it isn't a link to itself
+ foreach ( (array) $post_links_temp as $link_test ) :
+ if ( ! in_array( $link_test, $pung ) && ( url_to_postid( $link_test ) != $post->ID ) // If we haven't pung it already and it isn't a link to itself
&& !is_local_attachment($link_test) ) : // Also, let's never ping local attachments.
if ( $test = @parse_url($link_test) ) {
if ( isset($test['query']) )
endforeach;
$post_links = array_unique( $post_links );
- do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post_ID ) );
+ /**
+ * Fires just before pinging back links found in a post.
+ *
+ * @since 2.0.0
+ *
+ * @param array &$post_links An array of post links to be checked, passed by reference.
+ * @param array &$pung Whether a link has already been pinged, passed by reference.
+ * @param int $post_ID The post ID.
+ */
+ do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post->ID ) );
foreach ( (array) $post_links as $pagelinkedto ) {
$pingback_server_url = discover_pingback_server_uri( $pagelinkedto );
if ( $pingback_server_url ) {
@ set_time_limit( 60 );
- // Now, the RPC call
- $pagelinkedfrom = get_permalink($post_ID);
+ // Now, the RPC call
+ $pagelinkedfrom = get_permalink( $post );
// using a timeout of 3 seconds should be enough to cover slow servers
$client = new WP_HTTP_IXR_Client($pingback_server_url);
$client->timeout = 3;
- $client->useragent = apply_filters( 'pingback_useragent', $client->useragent . ' -- WordPress/' . $wp_version, $client->useragent, $pingback_server_url, $pagelinkedto, $pagelinkedfrom);
+ /**
+ * Filters the user agent sent when pinging-back a URL.
+ *
+ * @since 2.9.0
+ *
+ * @param string $concat_useragent The user agent concatenated with ' -- WordPress/'
+ * and the WordPress version.
+ * @param string $useragent The useragent.
+ * @param string $pingback_server_url The server URL being linked to.
+ * @param string $pagelinkedto URL of page linked to.
+ * @param string $pagelinkedfrom URL of page linked from.
+ */
+ $client->useragent = apply_filters( 'pingback_useragent', $client->useragent . ' -- WordPress/' . get_bloginfo( 'version' ), $client->useragent, $pingback_server_url, $pagelinkedto, $pagelinkedfrom );
// when set to true, this outputs debug messages by itself
$client->debug = false;
if ( $client->query('pingback.ping', $pagelinkedfrom, $pagelinkedto) || ( isset($client->error->code) && 48 == $client->error->code ) ) // Already registered
- add_ping( $post_ID, $pagelinkedto );
+ add_ping( $post, $pagelinkedto );
}
}
}
* 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.
* @param string $excerpt Excerpt of post.
* @param int $ID Post ID.
- * @return mixed Database query from update.
+ * @return int|false|void Database query from update.
*/
function trackback($trackback_url, $title, $excerpt, $ID) {
global $wpdb;
return;
$options = array();
- $options['timeout'] = 4;
+ $options['timeout'] = 10;
$options['body'] = array(
'title' => $title,
'url' => get_permalink($ID),
* Send a pingback.
*
* @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.
*/
function weblog_ping($server = '', $path = '') {
- global $wp_version;
- include_once(ABSPATH . WPINC . '/class-IXR.php');
- include_once(ABSPATH . WPINC . '/class-wp-http-ixr-client.php');
+ include_once( ABSPATH . WPINC . '/class-IXR.php' );
+ include_once( ABSPATH . WPINC . '/class-wp-http-ixr-client.php' );
// using a timeout of 3 seconds should be enough to cover slow servers
$client = new WP_HTTP_IXR_Client($server, ((!strlen(trim($path)) || ('/' == $path)) ? false : $path));
$client->timeout = 3;
- $client->useragent .= ' -- WordPress/'.$wp_version;
+ $client->useragent .= ' -- WordPress/' . get_bloginfo( 'version' );
// when set to true, this outputs debug messages by itself
$client->debug = false;
* which reports that the pingback is already registered.
*
* @since 3.5.1
- * @link http://www.hixie.ch/specs/pingback/pingback#TOC3
+ * @link https://www.hixie.ch/specs/pingback/pingback#TOC3
*
* @param IXR_Error $ixr_error
* @return IXR_Error
//
/**
- * Removes comment ID from the comment cache.
+ * Removes a comment from the object cache.
*
* @since 2.3.0
- * @package WordPress
- * @subpackage Cache
*
- * @param int|array $ids Comment ID or array of comment IDs to remove from cache
+ * @param int|array $ids Comment ID or an array of comment IDs to remove from cache.
*/
function clean_comment_cache($ids) {
- foreach ( (array) $ids as $id )
- wp_cache_delete($id, 'comment');
+ foreach ( (array) $ids as $id ) {
+ wp_cache_delete( $id, 'comment' );
+
+ /**
+ * Fires immediately after a comment has been removed from the object cache.
+ *
+ * @since 4.5.0
+ *
+ * @param int $id Comment ID.
+ */
+ do_action( 'clean_comment_cache', $id );
+ }
wp_cache_set( 'last_changed', microtime(), 'comment' );
}
* cache using the comment group with the key using the ID of the comments.
*
* @since 2.3.0
- * @package WordPress
- * @subpackage Cache
+ * @since 4.4.0 Introduced the `$update_meta_cache` parameter.
*
- * @param array $comments Array of comment row objects
+ * @param array $comments Array of comment row objects
+ * @param bool $update_meta_cache Whether to update commentmeta cache. Default true.
*/
-function update_comment_cache($comments) {
+function update_comment_cache( $comments, $update_meta_cache = true ) {
foreach ( (array) $comments as $comment )
wp_cache_add($comment->comment_ID, $comment, 'comment');
+
+ if ( $update_meta_cache ) {
+ // Avoid `wp_list_pluck()` in case `$comments` is passed by reference.
+ $comment_ids = array();
+ foreach ( $comments as $comment ) {
+ $comment_ids[] = $comment->comment_ID;
+ }
+ update_meta_cache( 'comment', $comment_ids );
+ }
+}
+
+/**
+ * Adds any comments from the given IDs to the cache that do not already exist in cache.
+ *
+ * @since 4.4.0
+ * @access private
+ *
+ * @see update_comment_cache()
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $comment_ids Array of comment IDs.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
+ */
+function _prime_comment_caches( $comment_ids, $update_meta_cache = true ) {
+ global $wpdb;
+
+ $non_cached_ids = _get_non_cached_ids( $comment_ids, 'comment' );
+ if ( !empty( $non_cached_ids ) ) {
+ $fresh_comments = $wpdb->get_results( sprintf( "SELECT $wpdb->comments.* FROM $wpdb->comments WHERE comment_ID IN (%s)", join( ",", array_map( 'intval', $non_cached_ids ) ) ) );
+
+ update_comment_cache( $fresh_comments, $update_meta_cache );
+ }
}
//
* @access private
* @since 2.7.0
*
- * @param object $posts Post data object.
- * @param object $query Query object.
- * @return object
+ * @param WP_Post $posts Post data object.
+ * @param WP_Query $query Query object.
+ * @return array
*/
function _close_comments_for_old_posts( $posts, $query ) {
if ( empty( $posts ) || ! $query->is_singular() || ! get_option( 'close_comments_for_old_posts' ) )
return $posts;
+ /**
+ * Filters the list of post types to automatically close comments for.
+ *
+ * @since 3.2.0
+ *
+ * @param array $post_types An array of registered post types. Default array with 'post'.
+ */
$post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );
if ( ! in_array( $posts[0]->post_type, $post_types ) )
return $posts;
$post = get_post($post_id);
+ /** This filter is documented in wp-includes/comment.php */
$post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );
if ( ! in_array( $post->post_type, $post_types ) )
return $open;
+ // Undated drafts should not show up as comments closed.
+ if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {
+ return $open;
+ }
+
if ( time() - strtotime( $post->post_date_gmt ) > ( $days_old * DAY_IN_SECONDS ) )
return false;
return $open;
}
+
+/**
+ * Handles the submission of a comment, usually posted to wp-comments-post.php via a comment form.
+ *
+ * This function expects unslashed data, as opposed to functions such as `wp_new_comment()` which
+ * expect slashed data.
+ *
+ * @since 4.4.0
+ *
+ * @param array $comment_data {
+ * Comment data.
+ *
+ * @type string|int $comment_post_ID The ID of the post that relates to the comment.
+ * @type string $author The name of the comment author.
+ * @type string $email The comment author email address.
+ * @type string $url The comment author URL.
+ * @type string $comment The content of the comment.
+ * @type string|int $comment_parent The ID of this comment's parent, if any. Default 0.
+ * @type string $_wp_unfiltered_html_comment The nonce value for allowing unfiltered HTML.
+ * }
+ * @return WP_Comment|WP_Error A WP_Comment object on success, a WP_Error object on failure.
+ */
+function wp_handle_comment_submission( $comment_data ) {
+
+ $comment_post_ID = $comment_parent = 0;
+ $comment_author = $comment_author_email = $comment_author_url = $comment_content = null;
+
+ if ( isset( $comment_data['comment_post_ID'] ) ) {
+ $comment_post_ID = (int) $comment_data['comment_post_ID'];
+ }
+ if ( isset( $comment_data['author'] ) && is_string( $comment_data['author'] ) ) {
+ $comment_author = trim( strip_tags( $comment_data['author'] ) );
+ }
+ if ( isset( $comment_data['email'] ) && is_string( $comment_data['email'] ) ) {
+ $comment_author_email = trim( $comment_data['email'] );
+ }
+ if ( isset( $comment_data['url'] ) && is_string( $comment_data['url'] ) ) {
+ $comment_author_url = trim( $comment_data['url'] );
+ }
+ if ( isset( $comment_data['comment'] ) && is_string( $comment_data['comment'] ) ) {
+ $comment_content = trim( $comment_data['comment'] );
+ }
+ if ( isset( $comment_data['comment_parent'] ) ) {
+ $comment_parent = absint( $comment_data['comment_parent'] );
+ }
+
+ $post = get_post( $comment_post_ID );
+
+ if ( empty( $post->comment_status ) ) {
+
+ /**
+ * Fires when a comment is attempted on a post that does not exist.
+ *
+ * @since 1.5.0
+ *
+ * @param int $comment_post_ID Post ID.
+ */
+ do_action( 'comment_id_not_found', $comment_post_ID );
+
+ return new WP_Error( 'comment_id_not_found' );
+
+ }
+
+ // get_post_status() will get the parent status for attachments.
+ $status = get_post_status( $post );
+
+ if ( ( 'private' == $status ) && ! current_user_can( 'read_post', $comment_post_ID ) ) {
+ return new WP_Error( 'comment_id_not_found' );
+ }
+
+ $status_obj = get_post_status_object( $status );
+
+ if ( ! comments_open( $comment_post_ID ) ) {
+
+ /**
+ * Fires when a comment is attempted on a post that has comments closed.
+ *
+ * @since 1.5.0
+ *
+ * @param int $comment_post_ID Post ID.
+ */
+ do_action( 'comment_closed', $comment_post_ID );
+
+ return new WP_Error( 'comment_closed', __( 'Sorry, comments are closed for this item.' ), 403 );
+
+ } elseif ( 'trash' == $status ) {
+
+ /**
+ * Fires when a comment is attempted on a trashed post.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_post_ID Post ID.
+ */
+ do_action( 'comment_on_trash', $comment_post_ID );
+
+ return new WP_Error( 'comment_on_trash' );
+
+ } elseif ( ! $status_obj->public && ! $status_obj->private ) {
+
+ /**
+ * Fires when a comment is attempted on a post in draft mode.
+ *
+ * @since 1.5.1
+ *
+ * @param int $comment_post_ID Post ID.
+ */
+ do_action( 'comment_on_draft', $comment_post_ID );
+
+ return new WP_Error( 'comment_on_draft' );
+
+ } elseif ( post_password_required( $comment_post_ID ) ) {
+
+ /**
+ * Fires when a comment is attempted on a password-protected post.
+ *
+ * @since 2.9.0
+ *
+ * @param int $comment_post_ID Post ID.
+ */
+ do_action( 'comment_on_password_protected', $comment_post_ID );
+
+ return new WP_Error( 'comment_on_password_protected' );
+
+ } else {
+
+ /**
+ * Fires before a comment is posted.
+ *
+ * @since 2.8.0
+ *
+ * @param int $comment_post_ID Post ID.
+ */
+ do_action( 'pre_comment_on_post', $comment_post_ID );
+
+ }
+
+ // If the user is logged in
+ $user = wp_get_current_user();
+ if ( $user->exists() ) {
+ if ( empty( $user->display_name ) ) {
+ $user->display_name=$user->user_login;
+ }
+ $comment_author = $user->display_name;
+ $comment_author_email = $user->user_email;
+ $comment_author_url = $user->user_url;
+ $user_ID = $user->ID;
+ if ( current_user_can( 'unfiltered_html' ) ) {
+ if ( ! isset( $comment_data['_wp_unfiltered_html_comment'] )
+ || ! wp_verify_nonce( $comment_data['_wp_unfiltered_html_comment'], 'unfiltered-html-comment_' . $comment_post_ID )
+ ) {
+ kses_remove_filters(); // start with a clean slate
+ kses_init_filters(); // set up the filters
+ }
+ }
+ } else {
+ if ( get_option( 'comment_registration' ) ) {
+ return new WP_Error( 'not_logged_in', __( 'Sorry, you must be logged in to comment.' ), 403 );
+ }
+ }
+
+ $comment_type = '';
+
+ if ( get_option( 'require_name_email' ) && ! $user->exists() ) {
+ if ( 6 > strlen( $comment_author_email ) || '' == $comment_author ) {
+ return new WP_Error( 'require_name_email', __( '<strong>ERROR</strong>: please fill the required fields (name, email).' ), 200 );
+ } elseif ( ! is_email( $comment_author_email ) ) {
+ return new WP_Error( 'require_valid_email', __( '<strong>ERROR</strong>: please enter a valid email address.' ), 200 );
+ }
+ }
+
+ if ( '' == $comment_content ) {
+ return new WP_Error( 'require_valid_comment', __( '<strong>ERROR</strong>: please type a comment.' ), 200 );
+ }
+
+ $commentdata = compact(
+ 'comment_post_ID',
+ 'comment_author',
+ 'comment_author_email',
+ 'comment_author_url',
+ 'comment_content',
+ 'comment_type',
+ 'comment_parent',
+ 'user_ID'
+ );
+
+ $check_max_lengths = wp_check_comment_data_max_lengths( $commentdata );
+ if ( is_wp_error( $check_max_lengths ) ) {
+ return $check_max_lengths;
+ }
+
+ $comment_id = wp_new_comment( wp_slash( $commentdata ), true );
+ if ( is_wp_error( $comment_id ) ) {
+ return $comment_id;
+ }
+
+ if ( ! $comment_id ) {
+ return new WP_Error( 'comment_save_error', __( '<strong>ERROR</strong>: The comment could not be saved. Please try again later.' ), 500 );
+ }
+
+ return get_comment( $comment_id );
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff