function hook_ldap_authentication_allowuser_results_alter in Lightweight Directory Access Protocol (LDAP) 8.2

Same name and namespace in other branches

1. 8.4 ldap_authentication/ldap_authentication.api.php \hook_ldap_authentication_allowuser_results_alter()
2. 8.3 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()

Allow a custom module to examine the user's ldap details and refuse authentication. See also: http://drupal.org/node/1634930

Parameters

array $ldap_user: See README.developers.txt for structure @param string $name The drupal account name or proposed drupal account name if none exists yet @param boolean $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.

@return boolean &$hook_result passed by reference

1 invocation of hook_ldap_authentication_allowuser_results_alter()

LdapAuthenticationConf::allowUser in ldap_authentication/LdapAuthenticationConf.class.php

decide if a username is excluded or not

File

ldap_authentication/ldap_authentication.api.php, line 24

summary of hooks and other developer related functions

Code

function hook_ldap_authentication_allowuser_results_alter($ldap_user, $name, &$hook_result) {
  if ($hook_result === FALSE) {

    // other module has denied user, should not override
    return;
  }
  elseif ($hook_result === TRUE) {

    // other module has allowed, maybe override
    if (mymodule_dissapproves($ldap_user, $name)) {
      $hook_result = FALSE;
    }
  }
}