class UserEvents

Defines events for the user module.

Hierarchy

Expanded class hierarchy of UserEvents

2 files declare their use of UserEvents
UserFloodControl.php in core/modules/user/src/UserFloodControl.php
UserFloodSubscriber.php in core/modules/user/src/EventSubscriber/UserFloodSubscriber.php

File

View on git.drupalcode.org

core/modules/user/src/Event/UserEvents.php, line 8

Namespace

Drupal\user\Event
View source 
final class UserEvents {
  
  /**
   * The name of the event fired when a login is blocked by flood control.
   *
   * This event allows modules to perform an action whenever flood control has
   * been triggered by excessive login attempts for a particular user account.
   * The event listener method receives a \Drupal\user\Event\UserFloodEvent
   * instance.
   *
   * @Event
   *
   * @see: \Drupal\user\UserFloodControl::isAllowed
   * @see: \Drupal\user\EventSubscriber\UserFloodSubscriber
   *
   * @var string
   */
  const FLOOD_BLOCKED_USER = 'user.flood_blocked_user';
  
  /**
   * The name of the event fired when a login is blocked by flood control.
   *
   * This event allows modules to perform an action whenever flood control has
   * been triggered by excessive login attempts from a particular IP. The event
   * listener method receives a \Drupal\user\Event\UserFloodEvent instance.
   *
   * @Event
   *
   * @see: \Drupal\user\UserFloodControl::isAllowed
   * @see: \Drupal\user\EventSubscriber\UserFloodSubscriber
   *
   * @var string
   */
  const FLOOD_BLOCKED_IP = 'user.flood_blocked_ip';

}

Members

Title Modifiers Object type Summary
UserEvents::FLOOD_BLOCKED_IP constant The name of the event fired when a login is blocked by flood control.
UserEvents::FLOOD_BLOCKED_USER constant The name of the event fired when a login is blocked by flood control.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.