Filter hook 'wp_is_comment_flood'

Hook Information

Hook Parameters

Usage Examples

<?php
// Hook into wp_is_comment_flood
add_filter('wp_is_comment_flood', 'my_custom_filter', 10, 5);

function my_custom_filter($is_flood, $comment_author_ip, $comment_author_email, $comment_date_gmt, $wp_error) {
    // Your custom filtering logic here
    return $is_flood;
}

Source Code Context

<?php
 786  	 * @param string $comment_author_email Comment author's email.
 787  	 * @param string $comment_date_gmt     GMT date the comment was posted.
 788  	 * @param bool   $wp_error             Whether to return a WP_Error object instead of executing
 789  	 *                                     wp_die() or die() if a comment flood is occurring.
 790  	 */
 791  	$is_flood = apply_filters(
 792  		'wp_is_comment_flood',
 793  		false,
 794  		$commentdata['comment_author_IP'],
 795  		$commentdata['comment_author_email'],
 796  		$commentdata['comment_date_gmt'],

PHP Documentation

<?php
/**
	 * 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
	 * @since 5.5.0 The `$avoid_die` parameter was renamed to `$wp_error`.
	 *
	 * @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   $wp_error             Whether to return a WP_Error object instead of executing
	 *                                     wp_die() or die() if a comment flood is occurring.
	 */