function hook_ldap_authentication_allowuser_results_alter in Lightweight Directory Access Protocol (LDAP) 8.3

Same name and namespace in other branches

1. 8.4 ldap_authentication/ldap_authentication.api.php \hook_ldap_authentication_allowuser_results_alter()
2. 8.2 ldap_authentication/ldap_authentication.api.php \hook_ldap_authentication_allowuser_results_alter()
3. 7.2 ldap_authentication/ldap_authentication.api.php \hook_ldap_authentication_allowuser_results_alter()

Alter the allowed user results.

Allow a custom module to examine the user's LDAP details and refuse authentication. The actual $hook_result is passed by reference. See also: http://drupal.org/node/1634930

Parameters

array $ldap_user: See README.developers.txt for structure.

string $name: The Drupal account name or proposed Drupal account name if none exists yet.

bool $hook_result: TRUE for allow, FALSE for deny. If set to TRUE or FALSE, another module has already set this and function should be careful about overriding this.

1 invocation of hook_ldap_authentication_allowuser_results_alter()

LoginValidator::checkAllowedExcluded in ldap_authentication/src/Controller/LoginValidator.php

Check if exclusion criteria match.

File

ldap_authentication/ldap_authentication.api.php, line 23

Summary of hooks and other developer related functions.

Code

function hook_ldap_authentication_allowuser_results_alter(array $ldap_user, $name, &$hook_result) {

  // Other module has denied user, should not override.
  if ($hook_result === FALSE) {
    return;
  }
  elseif ($hook_result === TRUE) {
    if (mymodule_dissapproves($ldap_user, $name)) {
      $hook_result = FALSE;
    }
  }
}