Home › API reference

Definition

flood_is_allowed($name, $threshold)
drupal-4-7/includes/common.inc, line 702

Description

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.

Code

<?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);
}
?>