comment_flood_filter filter-hookWP 2.1.0

Filters the comment flood status.

Usage

add_filter( 'comment_flood_filter', 'wp_kama_comment_flood_filter', 10, 3 );

/**
 * Function for `comment_flood_filter` filter-hook.
 * 
 * @param bool $bool             Whether a comment flood is occurring.
 * @param int  $time_lastcomment Timestamp of when the last comment was posted.
 * @param int  $time_newcomment  Timestamp of when the new comment was posted.
 *
 * @return bool
 */
function wp_kama_comment_flood_filter( $bool, $time_lastcomment, $time_newcomment ){

	// filter...
	return $bool;
}
$bool(true|false)
Whether a comment flood is occurring.
Default: false
$time_lastcomment(int)
Timestamp of when the last comment was posted.
$time_newcomment(int)
Timestamp of when the new comment was posted.

Changelog

Since 2.1.0 Introduced.

Where the hook is called

wp_check_comment_flood()
comment_flood_filter
wp-includes/comment.php 906
$flood_die = apply_filters( 'comment_flood_filter', false, $time_lastcomment, $time_newcomment );

Where the hook is used in WordPress

wp-includes/default-filters.php 291
add_filter( 'comment_flood_filter', 'wp_throttle_comment_flood', 10, 3 );