Home › API reference › common.inc

flood_is_allowed

  1. drupal
    1. 4.7
    2. 5
    3. 6 common.inc
    4. 7 common.inc
Versions
4.7 – 6 flood_is_allowed($name, $threshold)
7 flood_is_allowed($name, $threshold, $window = 3600, $identifier = NULL)

Check if the current visitor (hostname/IP) is allowed to proceed with the specified event. The user is allowed to proceed if he did not trigger the specified event more than $threshold times per hour.

Parameters

$name The name of the event.

$number The maximum number of the specified event per hour (per visitor).

Return value

True if the user did not exceed the hourly threshold. False otherwise.

Related topics

Input validation
Functions to validate user input.

▸ 2 functions call flood_is_allowed()

▾ 2 functions call flood_is_allowed()

contact_mail_page in modules/contact.module
Site-wide contact page
contact_mail_user in modules/contact.module
Personal contact page.

Code

includes/common.inc, line 703

<?php
function flood_is_allowed($name, $threshold) {
  $number = db_num_rows(db_query("SELECT event FROM {flood} WHERE event = '%s' AND hostname = '%s' AND timestamp > %d", $name, $_SERVER['REMOTE_ADDR'], time() - 3600));
  return ($number < $threshold ? TRUE : FALSE);
}
?>