wp_is_comment_flood filter-hook . WP 4.7.0
Filters whether a comment is part of a comment flood.
The default check is wp_check_comment_flood(). See check_comment_flood_db().
Usage
add_filter( 'wp_is_comment_flood', 'filter_function_name_7458', 10, 5 ); function filter_function_name_7458( $is_flood, $comment_author_IP, $comment_author_email, $comment_date_gmt, $wp_error ){ // filter... return $is_flood; }
- $is_flood(true/false)
- Is a comment flooding occurring? Default false.
- $comment_author_IP(string)
- Comment author's IP address.
- $comment_author_email(string)
- Comment author's email.
- $comment_date_gmt(string)
- GMT date the comment was posted.
- $wp_error(true/false)
- Whether to return a WP_Error object instead of executing wp_die() or die() if a comment flood is occurring.
Changelog
Since 4.7.0 | Introduced. |
Since 5.5.0 | The $avoid_die parameter was renamed to $wp_error. |
Where the hook is called
wp_is_comment_flood
wp-includes/comment.php 779-786
$is_flood = apply_filters( 'wp_is_comment_flood', false, $commentdata['comment_author_IP'], $commentdata['comment_author_email'], $commentdata['comment_date_gmt'], $wp_error );
Where in WP core the hook is used WordPress
wp-includes/comment.php 861
add_filter( 'wp_is_comment_flood', 'wp_check_comment_flood', 10, 5 );