$session->allowLoginAttempt() method

Allow login attempt for given name at all?

This method does nothing and is purely for hooks to modify return value.

Usage

$bool = $session->allowLoginAttempt(string $name);

Arguments

NameType(s)Description
namestring

Return value

bool


Hooking $session->allowLoginAttempt(…)

You can add your own hook events that are executed either before or after the $session->allowLoginAttempt(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $session->allowLoginAttempt(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Session::allowLoginAttempt', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $session = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $name = $event->arguments(0);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $name);
});

Hooking after

The 'after' hooks are called immediately after each $session->allowLoginAttempt(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Session::allowLoginAttempt', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $session = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $name = $event->arguments(0);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$session methods and properties

API reference based on ProcessWire core version 3.0.200

Twitter updates

  • New ProcessWire “User Activity” module version released (v5), this post covers what's new— More
    12 August 2022
  • New post: Multi-language field translation export/import — In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire… More
    5 August 2022
  • Weekly update, July 29: Continuing upgrades to ProcessWire’s comments system and FormBuilder, along with a working example—More
    29 July 2022

Latest news

  • ProcessWire Weekly #431
    In the 431st issue of ProcessWire Weekly we'll check out the weekly update from Ryan in which he covers a new version of a popular Pro module, share some recent tutorials and other online resources, and more. Read on!
    Weekly.pw / 13 August 2022
  • Multi-language field translation export/import
    In this post we cover the details of a new module that enables export and import capabilities for multi-language fields in ProcessWire.
    Blog / 5 August 2022
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull