public function FloodInterface::isAllowed in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Flood/FloodInterface.php \Drupal\Core\Flood\FloodInterface::isAllowed()

Checks whether a user is allowed to proceed with the specified event.

Events can have thresholds saying that each user can only do that event a certain number of times in a time window. This function verifies that the current user has not exceeded this threshold.

Parameters

string $name: The name of an event.

int $threshold: The maximum number of times each user can do this event per time window.

int $window: (optional) Number of seconds in the time window for this event (default is 3600 seconds, or 1 hour).

string $identifier: (optional) Unique identifier of the current user. Defaults to the current user's IP address).

Return value

TRUE if the user is allowed to proceed. FALSE if they have exceeded the threshold and should not be allowed to proceed.

3 methods override FloodInterface::isAllowed()

DatabaseBackend::isAllowed in core/lib/Drupal/Core/Flood/DatabaseBackend.php

Checks whether a user is allowed to proceed with the specified event.

MemoryBackend::isAllowed in core/lib/Drupal/Core/Flood/MemoryBackend.php

Checks whether a user is allowed to proceed with the specified event.

UserFloodControl::isAllowed in core/modules/user/src/UserFloodControl.php

Checks whether a user is allowed to proceed with the specified event.

File

core/lib/Drupal/Core/Flood/FloodInterface.php, line 61

Class

FloodInterface

Defines an interface for flood controllers.

Namespace

Drupal\Core\Flood

Code

public function isAllowed($name, $threshold, $window = 3600, $identifier = NULL);