<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[26491] trunk/src/wp-includes/comment.php: Inline documentation for hooks in wp-includes/comment.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/26491">26491</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-12-01 01:11:26 +0000 (Sun, 01 Dec 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-includes/comment.php.
comment.php, a.k.a. "lots 'o hooks".
Props swissspidy for the initial patch. Props danieldudzic, kpdesign, and DrewAPicture.
Fixes <a href="http://core.trac.wordpress.org/ticket/25522">#25522</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescommentphp">trunk/src/wp-includes/comment.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludescommentphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/comment.php (26490 => 26491)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/comment.php 2013-12-01 00:42:39 UTC (rev 26490)
+++ trunk/src/wp-includes/comment.php 2013-12-01 01:11:26 UTC (rev 26491)
</span><span class="lines">@@ -44,12 +44,21 @@
</span><span class="cx"> if ( 1 == get_option('comment_moderation') )
</span><span class="cx"> return false; // If moderation is set to manual
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/comment-template.php */
</ins><span class="cx"> $comment = apply_filters( 'comment_text', $comment );
</span><span class="cx">
</span><span class="cx"> // Check # of external links
</span><span class="cx"> if ( $max_links = get_option( 'comment_max_links' ) ) {
</span><span class="cx"> $num_links = preg_match_all( '/<a [^>]*href/i', $comment, $out );
</span><del>- $num_links = apply_filters( 'comment_max_links_url', $num_links, $url ); // provide for counting of $url as a link
</del><ins>+ /**
+ * Filter the maximum number of links allowed in a comment.
+ *
+ * @since 3.0.0
+ *
+ * @param int $num_links The number of links allowed.
+ * @param string $url Comment author's URL. Included in allowed links total.
+ */
+ $num_links = apply_filters( 'comment_max_links_url', $num_links, $url );
</ins><span class="cx"> if ( $num_links >= $max_links )
</span><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="lines">@@ -147,7 +156,14 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>- $_comment = apply_filters('get_comment', $_comment);
</del><ins>+ /**
+ * Fires after a comment is retrieved.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $_comment Comment data.
+ */
+ $_comment = apply_filters( 'get_comment', $_comment );
</ins><span class="cx">
</span><span class="cx"> if ( $output == OBJECT ) {
</span><span class="cx"> return $_comment;
</span><span class="lines">@@ -251,6 +267,13 @@
</span><span class="cx"> $this->meta_query = new WP_Meta_Query();
</span><span class="cx"> $this->meta_query->parse_query_vars( $this->query_vars );
</span><span class="cx">
</span><ins>+ /**
+ * Fires before comments are retrieved.
+ *
+ * @since 3.1.0
+ *
+ * @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference.
+ */
</ins><span class="cx"> do_action_ref_array( 'pre_get_comments', array( &$this ) );
</span><span class="cx"> extract( $this->query_vars, EXTR_SKIP );
</span><span class="cx">
</span><span class="lines">@@ -376,6 +399,14 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> $pieces = array( 'fields', 'join', 'where', 'orderby', 'order', 'limits', 'groupby' );
</span><ins>+ /**
+ * Filter the comment query clauses.
+ *
+ * @since 3.1.0
+ *
+ * @param array $pieces A compacted array of comment query clauses.
+ * @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference.
+ */
</ins><span class="cx"> $clauses = apply_filters_ref_array( 'comments_clauses', array( compact( $pieces ), &$this ) );
</span><span class="cx"> foreach ( $pieces as $piece )
</span><span class="cx"> $$piece = isset( $clauses[ $piece ] ) ? $clauses[ $piece ] : '';
</span><span class="lines">@@ -389,6 +420,14 @@
</span><span class="cx"> return $wpdb->get_var( $query );
</span><span class="cx">
</span><span class="cx"> $comments = $wpdb->get_results( $query );
</span><ins>+ /**
+ * Filter the comment query results.
+ *
+ * @since 3.1.0
+ *
+ * @param array $comments An array of comments.
+ * @param WP_Comment_Query &$this Current instance of WP_Comment_Query, passed by reference.
+ */
</ins><span class="cx"> $comments = apply_filters_ref_array( 'the_comments', array( $comments, &$this ) );
</span><span class="cx">
</span><span class="cx"> wp_cache_add( $cache_key, $comments, 'comment' );
</span><span class="lines">@@ -629,7 +668,14 @@
</span><span class="cx"> if ( $user->exists() )
</span><span class="cx"> return;
</span><span class="cx">
</span><del>- $comment_cookie_lifetime = apply_filters('comment_cookie_lifetime', 30000000);
</del><ins>+ /**
+ * Filter 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 );
</ins><span class="cx"> setcookie('comment_author_' . COOKIEHASH, $comment->comment_author, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN);
</span><span class="cx"> setcookie('comment_author_email_' . COOKIEHASH, $comment->comment_author_email, time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN);
</span><span class="cx"> setcookie('comment_author_url_' . COOKIEHASH, esc_url($comment->comment_author_url), time() + $comment_cookie_lifetime, COOKIEPATH, COOKIE_DOMAIN);
</span><span class="lines">@@ -644,22 +690,52 @@
</span><span class="cx"> * @since 2.0.4
</span><span class="cx"> */
</span><span class="cx"> function sanitize_comment_cookies() {
</span><del>- if ( isset($_COOKIE['comment_author_'.COOKIEHASH]) ) {
- $comment_author = apply_filters('pre_comment_author_name', $_COOKIE['comment_author_'.COOKIEHASH]);
</del><ins>+ if ( isset( $_COOKIE['comment_author_' . COOKIEHASH] ) ) {
+ /**
+ * Filter 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.2
+ *
+ * @param string $author_cookie The comment author name cookie.
+ */
+ $comment_author = apply_filters( 'pre_comment_author_name', $_COOKIE['comment_author_' . COOKIEHASH] );
</ins><span class="cx"> $comment_author = wp_unslash($comment_author);
</span><span class="cx"> $comment_author = esc_attr($comment_author);
</span><del>- $_COOKIE['comment_author_'.COOKIEHASH] = $comment_author;
</del><ins>+ $_COOKIE['comment_author_' . COOKIEHASH] = $comment_author;
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- if ( isset($_COOKIE['comment_author_email_'.COOKIEHASH]) ) {
- $comment_author_email = apply_filters('pre_comment_author_email', $_COOKIE['comment_author_email_'.COOKIEHASH]);
</del><ins>+ if ( isset( $_COOKIE['comment_author_email_' . COOKIEHASH] ) ) {
+ /**
+ * Filter 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.2
+ *
+ * @param string $author_email_cookie The comment author email cookie.
+ */
+ $comment_author_email = apply_filters( 'pre_comment_author_email', $_COOKIE['comment_author_email_' . COOKIEHASH] );
</ins><span class="cx"> $comment_author_email = wp_unslash($comment_author_email);
</span><span class="cx"> $comment_author_email = esc_attr($comment_author_email);
</span><span class="cx"> $_COOKIE['comment_author_email_'.COOKIEHASH] = $comment_author_email;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( isset($_COOKIE['comment_author_url_'.COOKIEHASH]) ) {
- $comment_author_url = apply_filters('pre_comment_author_url', $_COOKIE['comment_author_url_'.COOKIEHASH]);
</del><ins>+ if ( isset( $_COOKIE['comment_author_url_' . COOKIEHASH] ) ) {
+ /**
+ * Filter 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.2
+ *
+ * @param string $author_url_cookie The comment author URL cookie.
+ */
+ $comment_author_url = apply_filters( 'pre_comment_author_url', $_COOKIE['comment_author_url_' . COOKIEHASH] );
</ins><span class="cx"> $comment_author_url = wp_unslash($comment_author_url);
</span><span class="cx"> $_COOKIE['comment_author_url_'.COOKIEHASH] = $comment_author_url;
</span><span class="cx"> }
</span><span class="lines">@@ -688,6 +764,13 @@
</span><span class="cx"> $dupe .= $wpdb->prepare( "OR comment_author_email = %s ", wp_unslash( $comment_author_email ) );
</span><span class="cx"> $dupe .= $wpdb->prepare( ") AND comment_content = %s LIMIT 1", wp_unslash( $comment_content ) );
</span><span class="cx"> if ( $wpdb->get_var($dupe) ) {
</span><ins>+ /**
+ * Fires immediately after a duplicate comment is detected.
+ *
+ * @since 3.0.0
+ *
+ * @param array $commentdata Comment data.
+ */
</ins><span class="cx"> do_action( 'comment_duplicate_trigger', $commentdata );
</span><span class="cx"> if ( defined('DOING_AJAX') )
</span><span class="cx"> die( __('Duplicate comment detected; it looks as though you’ve already said that!') );
</span><span class="lines">@@ -695,6 +778,17 @@
</span><span class="cx"> wp_die( __('Duplicate comment detected; it looks as though you’ve already said that!') );
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Fires immediately before a comment is marked approved.
+ *
+ * Allows checking for comment flooding.
+ *
+ * @since 2.3.0
+ *
+ * @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.
+ */
</ins><span class="cx"> do_action( 'check_comment_flood', $comment_author_IP, $comment_author_email, $comment_date_gmt );
</span><span class="cx">
</span><span class="cx"> if ( ! empty( $user_id ) ) {
</span><span class="lines">@@ -705,7 +799,7 @@
</span><span class="cx"> if ( isset( $user ) && ( $user_id == $post_author || $user->has_cap( 'moderate_comments' ) ) ) {
</span><span class="cx"> // The author and the admins get respect.
</span><span class="cx"> $approved = 1;
</span><del>- } else {
</del><ins>+ } else {
</ins><span class="cx"> // Everyone else's comments will be checked.
</span><span class="cx"> if ( check_comment($comment_author, $comment_author_email, $comment_author_url, $comment_content, $comment_author_IP, $comment_agent, $comment_type) )
</span><span class="cx"> $approved = 1;
</span><span class="lines">@@ -715,6 +809,14 @@
</span><span class="cx"> $approved = 'spam';
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+ /**
+ * Filter 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.
+ */
</ins><span class="cx"> $approved = apply_filters( 'pre_comment_approved', $approved, $commentdata );
</span><span class="cx"> return $approved;
</span><span class="cx"> }
</span><span class="lines">@@ -744,9 +846,26 @@
</span><span class="cx"> 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 ) ) ) {
</span><span class="cx"> $time_lastcomment = mysql2date('U', $lasttime, false);
</span><span class="cx"> $time_newcomment = mysql2date('U', $date, false);
</span><del>- $flood_die = apply_filters('comment_flood_filter', false, $time_lastcomment, $time_newcomment);
</del><ins>+ /**
+ * Filter 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 );
</ins><span class="cx"> if ( $flood_die ) {
</span><del>- do_action('comment_flood_trigger', $time_lastcomment, $time_newcomment);
</del><ins>+ /**
+ * Fires before the comment flood message is triggered.
+ *
+ * @since 1.5.2
+ *
+ * @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 );
</ins><span class="cx">
</span><span class="cx"> if ( defined('DOING_AJAX') )
</span><span class="cx"> die( __('You are posting comments too quickly. Slow down.') );
</span><span class="lines">@@ -902,7 +1021,19 @@
</span><span class="cx"> * @return bool True if comment contains blacklisted content, false if comment does not
</span><span class="cx"> */
</span><span class="cx"> function wp_blacklist_check($author, $email, $url, $comment, $user_ip, $user_agent) {
</span><del>- do_action('wp_blacklist_check', $author, $email, $url, $comment, $user_ip, $user_agent);
</del><ins>+ /**
+ * Fires before the comment is tested for blacklisted characters or words.
+ *
+ * @since 1.5.2
+ *
+ * @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 );
</ins><span class="cx">
</span><span class="cx"> $mod_keys = trim( get_option('blacklist_keys') );
</span><span class="cx"> if ( '' == $mod_keys )
</span><span class="lines">@@ -954,7 +1085,15 @@
</span><span class="cx">
</span><span class="cx"> $post_id = (int) $post_id;
</span><span class="cx">
</span><del>- $stats = apply_filters('wp_count_comments', array(), $post_id);
</del><ins>+ /**
+ * Filter the comments count for a given post.
+ *
+ * @since 2.7.0
+ *
+ * @param array $count An empty array.
+ * @param int $post_id The post ID.
+ */
+ $stats = apply_filters( 'wp_count_comments', array(), $post_id );
</ins><span class="cx"> if ( !empty($stats) )
</span><span class="cx"> return $stats;
</span><span class="cx">
</span><span class="lines">@@ -1019,7 +1158,14 @@
</span><span class="cx"> if ( !$force_delete && EMPTY_TRASH_DAYS && !in_array( wp_get_comment_status($comment_id), array( 'trash', 'spam' ) ) )
</span><span class="cx"> return wp_trash_comment($comment_id);
</span><span class="cx">
</span><del>- do_action('delete_comment', $comment_id);
</del><ins>+ /**
+ * Fires immediately before a comment is deleted from the database.
+ *
+ * @since 1.2.1
+ *
+ * @param int $comment_id The comment ID.
+ */
+ do_action( 'delete_comment', $comment_id );
</ins><span class="cx">
</span><span class="cx"> // Move children up a level.
</span><span class="cx"> $children = $wpdb->get_col( $wpdb->prepare("SELECT comment_ID FROM $wpdb->comments WHERE comment_parent = %d", $comment_id) );
</span><span class="lines">@@ -1035,15 +1181,31 @@
</span><span class="cx">
</span><span class="cx"> if ( ! $wpdb->delete( $wpdb->comments, array( 'comment_ID' => $comment_id ) ) )
</span><span class="cx"> return false;
</span><del>- do_action('deleted_comment', $comment_id);
</del><span class="cx">
</span><ins>+ /**
+ * 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_id );
+
</ins><span class="cx"> $post_id = $comment->comment_post_ID;
</span><span class="cx"> if ( $post_id && $comment->comment_approved == 1 )
</span><span class="cx"> wp_update_comment_count($post_id);
</span><span class="cx">
</span><span class="cx"> clean_comment_cache($comment_id);
</span><span class="cx">
</span><del>- do_action('wp_set_comment_status', $comment_id, 'delete');
</del><ins>+ /**
+ * Fires immediately before changing the comment's status to 'delete'.
+ *
+ * @since 1.5.2
+ *
+ * @param int $comment_id The comment ID.
+ * @param string $status The new 'delete' comment status.
+ */
+ do_action( 'wp_set_comment_status', $comment_id, 'delete' );
</ins><span class="cx"> wp_transition_comment_status('delete', $comment->comment_approved, $comment);
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="lines">@@ -1068,12 +1230,27 @@
</span><span class="cx"> if ( !$comment = get_comment($comment_id) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- do_action('trash_comment', $comment_id);
</del><ins>+ /**
+ * 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_id );
</ins><span class="cx">
</span><span class="cx"> if ( wp_set_comment_status($comment_id, 'trash') ) {
</span><span class="cx"> add_comment_meta($comment_id, '_wp_trash_meta_status', $comment->comment_approved);
</span><span class="cx"> add_comment_meta($comment_id, '_wp_trash_meta_time', time() );
</span><del>- do_action('trashed_comment', $comment_id);
</del><ins>+
+ /**
+ * 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_id );
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1094,7 +1271,14 @@
</span><span class="cx"> if ( ! (int)$comment_id )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- do_action('untrash_comment', $comment_id);
</del><ins>+ /**
+ * 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_id );
</ins><span class="cx">
</span><span class="cx"> $status = (string) get_comment_meta($comment_id, '_wp_trash_meta_status', true);
</span><span class="cx"> if ( empty($status) )
</span><span class="lines">@@ -1103,7 +1287,14 @@
</span><span class="cx"> if ( wp_set_comment_status($comment_id, $status) ) {
</span><span class="cx"> delete_comment_meta($comment_id, '_wp_trash_meta_time');
</span><span class="cx"> delete_comment_meta($comment_id, '_wp_trash_meta_status');
</span><del>- do_action('untrashed_comment', $comment_id);
</del><ins>+ /**
+ * 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_id );
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1124,11 +1315,25 @@
</span><span class="cx"> if ( !$comment = get_comment($comment_id) )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- do_action('spam_comment', $comment_id);
</del><ins>+ /**
+ * 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_id );
</ins><span class="cx">
</span><span class="cx"> if ( wp_set_comment_status($comment_id, 'spam') ) {
</span><span class="cx"> add_comment_meta($comment_id, '_wp_trash_meta_status', $comment->comment_approved);
</span><del>- do_action('spammed_comment', $comment_id);
</del><ins>+ /**
+ * 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_id );
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1149,7 +1354,14 @@
</span><span class="cx"> if ( ! (int)$comment_id )
</span><span class="cx"> return false;
</span><span class="cx">
</span><del>- do_action('unspam_comment', $comment_id);
</del><ins>+ /**
+ * 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_id );
</ins><span class="cx">
</span><span class="cx"> $status = (string) get_comment_meta($comment_id, '_wp_trash_meta_status', true);
</span><span class="cx"> if ( empty($status) )
</span><span class="lines">@@ -1157,7 +1369,14 @@
</span><span class="cx">
</span><span class="cx"> if ( wp_set_comment_status($comment_id, $status) ) {
</span><span class="cx"> delete_comment_meta($comment_id, '_wp_trash_meta_status');
</span><del>- do_action('unspammed_comment', $comment_id);
</del><ins>+ /**
+ * 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_id );
</ins><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="lines">@@ -1214,8 +1433,11 @@
</span><span class="cx"> * @param object $comment Comment data.
</span><span class="cx"> */
</span><span class="cx"> function wp_transition_comment_status($new_status, $old_status, $comment) {
</span><del>- // 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
</del><ins>+ /*
+ * 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
+ */
</ins><span class="cx"> $comment_statuses = array(
</span><span class="cx"> 0 => 'unapproved',
</span><span class="cx"> 'hold' => 'unapproved', // wp_set_comment_status() uses "hold"
</span><span class="lines">@@ -1227,10 +1449,43 @@
</span><span class="cx">
</span><span class="cx"> // Call the hooks
</span><span class="cx"> if ( $new_status != $old_status ) {
</span><del>- do_action('transition_comment_status', $new_status, $old_status, $comment);
- do_action("comment_{$old_status}_to_{$new_status}", $comment);
</del><ins>+ /**
+ * 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 object $comment Comment object.
+ */
+ do_action( "comment_{$old_status}_to_{$new_status}", $comment );
</ins><span class="cx"> }
</span><del>- do_action("comment_{$new_status}_{$comment->comment_type}", $comment->comment_ID, $comment);
</del><ins>+ /**
+ * 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 obj $comment Comment object.
+ */
+ do_action( "comment_{$new_status}_{$comment->comment_type}", $comment->comment_ID, $comment );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -1260,7 +1515,16 @@
</span><span class="cx"> if ( isset($_COOKIE['comment_author_url_'.COOKIEHASH]) )
</span><span class="cx"> $comment_author_url = $_COOKIE['comment_author_url_'.COOKIEHASH];
</span><span class="cx">
</span><del>- return apply_filters('wp_get_current_commenter', compact('comment_author', 'comment_author_email', 'comment_author_url'));
</del><ins>+ /**
+ * Filter the current commenter's name, email, and URL.
+ *
+ * @since 3.1.0
+ *
+ * @param string $comment_author Comment author's name.
+ * @param string $comment_author_email Comment author's email.
+ * @param string $comment_author_url Comment author's URL.
+ */
+ return apply_filters( 'wp_get_current_commenter', compact('comment_author', 'comment_author_email', 'comment_author_url') );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -1305,8 +1569,17 @@
</span><span class="cx"> wp_update_comment_count($comment_post_ID);
</span><span class="cx">
</span><span class="cx"> $comment = get_comment($id);
</span><del>- do_action('wp_insert_comment', $id, $comment);
</del><span class="cx">
</span><ins>+ /**
+ * Fires immediately after a comment is inserted into the database.
+ *
+ * @since 2.8.0
+ *
+ * @param int $id The comment ID.
+ * @param obj $comment Comment object.
+ */
+ do_action( 'wp_insert_comment', $id, $comment );
+
</ins><span class="cx"> wp_cache_set( 'last_changed', microtime(), 'comment' );
</span><span class="cx">
</span><span class="cx"> return $id;
</span><span class="lines">@@ -1320,34 +1593,64 @@
</span><span class="cx"> * filtering the same comment more than once.
</span><span class="cx"> *
</span><span class="cx"> * @since 2.0.0
</span><del>- * @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
</del><span class="cx"> *
</span><span class="cx"> * @param array $commentdata Contains information on the comment.
</span><span class="cx"> * @return array Parsed comment information.
</span><span class="cx"> */
</span><span class="cx"> function wp_filter_comment($commentdata) {
</span><del>- 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']);
</del><ins>+ if ( isset( $commentdata['user_ID'] ) ) {
+ /**
+ * Filter 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.2
+ *
+ * @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'] );
+ }
+
+ /**
+ * Filter the comment author's browser user agent before it is set.
+ *
+ * @since 1.5.2
+ *
+ * @param int $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'] );
+ /**
+ * Filter the comment content before it is set.
+ *
+ * @since 1.5.2
+ *
+ * @param int $comment_content The comment content.
+ */
+ $commentdata['comment_content'] = apply_filters( 'pre_comment_content', $commentdata['comment_content'] );
+ /**
+ * Filter the comment author's IP before it is set.
+ *
+ * @since 1.5.2
+ *
+ * @param int $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'] );
</ins><span class="cx"> $commentdata['filtered'] = true;
</span><span class="cx"> return $commentdata;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Whether comment should be blocked because of comment flood.
</del><ins>+ * Whether a comment should be blocked because of comment flood.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> *
</span><span class="lines">@@ -1381,7 +1684,14 @@
</span><span class="cx"> * @return int The ID of the comment after adding.
</span><span class="cx"> */
</span><span class="cx"> function wp_new_comment( $commentdata ) {
</span><del>- $commentdata = apply_filters('preprocess_comment', $commentdata);
</del><ins>+ /**
+ * Filter a comment's data before it is sanitized and inserted into the database.
+ *
+ * @since 1.5.2
+ *
+ * @param array $commentdata Comment data.
+ */
+ $commentdata = apply_filters( 'preprocess_comment', $commentdata );
</ins><span class="cx">
</span><span class="cx"> $commentdata['comment_post_ID'] = (int) $commentdata['comment_post_ID'];
</span><span class="cx"> if ( isset($commentdata['user_ID']) )
</span><span class="lines">@@ -1405,7 +1715,15 @@
</span><span class="cx">
</span><span class="cx"> $comment_ID = wp_insert_comment($commentdata);
</span><span class="cx">
</span><del>- do_action('comment_post', $comment_ID, $commentdata['comment_approved']);
</del><ins>+ /**
+ * Fires immediately after a comment is inserted into the database.
+ *
+ * @since 1.2.1
+ *
+ * @param int $comment_ID The comment ID.
+ * @param int $comment_approved 1 (true) if the comment is approved, 0 (false) if not.
+ */
+ do_action( 'comment_post', $comment_ID, $commentdata['comment_approved'] );
</ins><span class="cx">
</span><span class="cx"> if ( 'spam' !== $commentdata['comment_approved'] ) { // If it's spam save it silently for later crunching
</span><span class="cx"> if ( '0' == $commentdata['comment_approved'] ) {
</span><span class="lines">@@ -1475,7 +1793,18 @@
</span><span class="cx">
</span><span class="cx"> $comment = get_comment($comment_id);
</span><span class="cx">
</span><del>- do_action('wp_set_comment_status', $comment_id, $comment_status);
</del><ins>+ /**
+ * Fires after a comment status has been updated in the database.
+ *
+ * The hook also fires immediately before comment status transition hooks are fired.
+ *
+ * @since 1.5.2
+ *
+ * @param int $comment_id The comment ID.
+ * @param string|bool $comment_status The comment status. Possible values include 'hold',
+ * 'approve', 'spam', 'trash', or false.
+ */
+ do_action( 'wp_set_comment_status', $comment_id, $comment_status );
</ins><span class="cx"> wp_transition_comment_status($comment_status, $comment_old->comment_approved, $comment);
</span><span class="cx">
</span><span class="cx"> wp_update_comment_count($comment->comment_post_ID);
</span><span class="lines">@@ -1516,7 +1845,14 @@
</span><span class="cx"> // Now extract the merged array.
</span><span class="cx"> extract(wp_unslash($commentarr), EXTR_SKIP);
</span><span class="cx">
</span><del>- $comment_content = apply_filters('comment_save_pre', $comment_content);
</del><ins>+ /**
+ * Filter the comment content before it is updated in the database.
+ *
+ * @since 1.5.2
+ *
+ * @param string $comment_content The comment data.
+ */
+ $comment_content = apply_filters( 'comment_save_pre', $comment_content );
</ins><span class="cx">
</span><span class="cx"> $comment_date_gmt = get_gmt_from_date($comment_date);
</span><span class="cx">
</span><span class="lines">@@ -1532,7 +1868,16 @@
</span><span class="cx">
</span><span class="cx"> clean_comment_cache($comment_ID);
</span><span class="cx"> wp_update_comment_count($comment_post_ID);
</span><del>- do_action('edit_comment', $comment_ID);
</del><ins>+ /**
+ * 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.1
+ *
+ * @param int $comment_ID The comment ID.
+ */
+ do_action( 'edit_comment', $comment_ID );
</ins><span class="cx"> $comment = get_comment($comment_ID);
</span><span class="cx"> wp_transition_comment_status($comment->comment_approved, $old_status, $comment);
</span><span class="cx"> return $rval;
</span><span class="lines">@@ -1629,8 +1974,18 @@
</span><span class="cx">
</span><span class="cx"> clean_post_cache( $post );
</span><span class="cx">
</span><del>- do_action('wp_update_comment_count', $post_id, $new, $old);
- do_action('edit_post', $post_id, $post);
</del><ins>+ /**
+ * 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 );
</ins><span class="cx">
</span><span class="cx"> return true;
</span><span class="cx"> }
</span><span class="lines">@@ -1760,15 +2115,19 @@
</span><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><del>- if ( empty($post->post_excerpt) )
- $excerpt = apply_filters('the_content', $post->post_content, $post->ID);
- else
- $excerpt = apply_filters('the_excerpt', $post->post_excerpt);
</del><ins>+ if ( empty($post->post_excerpt) ) {
+ /** This filter is documented in wp-admin/post-template.php */
+ $excerpt = apply_filters( 'the_content', $post->post_content, $post->ID );
+ } else {
+ /** This filter is documented in wp-admin/post-template.php */
+ $excerpt = apply_filters( 'the_excerpt', $post->post_excerpt );
+ }
+
</ins><span class="cx"> $excerpt = str_replace(']]>', ']]>', $excerpt);
</span><span class="cx"> $excerpt = wp_html_excerpt($excerpt, 252, '…');
</span><span class="cx">
</span><span class="cx"> /** This filter is documented in wp-includes/post-template.php */
</span><del>- $post_title = apply_filters('the_title', $post->post_title, $post->ID);
</del><ins>+ $post_title = apply_filters( 'the_title', $post->post_title, $post->ID );
</ins><span class="cx"> $post_title = strip_tags($post_title);
</span><span class="cx">
</span><span class="cx"> if ( $to_ping ) {
</span><span class="lines">@@ -1851,6 +2210,15 @@
</span><span class="cx"> endforeach;
</span><span class="cx">
</span><span class="cx"> $post_links = array_unique( $post_links );
</span><ins>+ /**
+ * 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.
+ */
</ins><span class="cx"> do_action_ref_array( 'pre_ping', array( &$post_links, &$pung, $post_ID ) );
</span><span class="cx">
</span><span class="cx"> foreach ( (array) $post_links as $pagelinkedto ) {
</span><span class="lines">@@ -1858,13 +2226,25 @@
</span><span class="cx">
</span><span class="cx"> if ( $pingback_server_url ) {
</span><span class="cx"> @ set_time_limit( 60 );
</span><del>- // Now, the RPC call
</del><ins>+ // Now, the RPC call
</ins><span class="cx"> $pagelinkedfrom = get_permalink($post_ID);
</span><span class="cx">
</span><span class="cx"> // using a timeout of 3 seconds should be enough to cover slow servers
</span><span class="cx"> $client = new WP_HTTP_IXR_Client($pingback_server_url);
</span><span class="cx"> $client->timeout = 3;
</span><del>- $client->useragent = apply_filters( 'pingback_useragent', $client->useragent . ' -- WordPress/' . $wp_version, $client->useragent, $pingback_server_url, $pagelinkedto, $pagelinkedfrom);
</del><ins>+ /**
+ * Filter 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/' . $wp_version, $client->useragent, $pingback_server_url, $pagelinkedto, $pagelinkedfrom );
</ins><span class="cx"> // when set to true, this outputs debug messages by itself
</span><span class="cx"> $client->debug = false;
</span><span class="cx">
</span><span class="lines">@@ -2041,6 +2421,13 @@
</span><span class="cx"> if ( empty( $posts ) || ! $query->is_singular() || ! get_option( 'close_comments_for_old_posts' ) )
</span><span class="cx"> return $posts;
</span><span class="cx">
</span><ins>+ /**
+ * Filter 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'.
+ */
</ins><span class="cx"> $post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );
</span><span class="cx"> if ( ! in_array( $posts[0]->post_type, $post_types ) )
</span><span class="cx"> return $posts;
</span><span class="lines">@@ -2080,6 +2467,7 @@
</span><span class="cx">
</span><span class="cx"> $post = get_post($post_id);
</span><span class="cx">
</span><ins>+ /** This filter is documented in wp-includes/comment.php */
</ins><span class="cx"> $post_types = apply_filters( 'close_comments_for_post_types', array( 'post' ) );
</span><span class="cx"> if ( ! in_array( $post->post_type, $post_types ) )
</span><span class="cx"> return $open;
</span></span></pre>
</div>
</div>
</body>
</html>