Home › API reference › authentication.php

hook_auth

  1. drupal
    1. 4.7
    2. 5
Versions
4.7 – 5 hook_auth($username, $password, $server)

Verify authentication of a user.

The _auth hook is the heart of any authentication module. This function is called whenever a user is attempting to log in using your authentication module. The module uses this information to allow or deny access to the site.

Parameters

$username The substring before the final '@' character in the username field.

$password The whole string submitted by the user in the password field.

$server The substring after the final '@' symbol in the username field.

Return value

For successful authentications, this function returns TRUE. Otherwise, it returns FALSE.

Related topics

Hooks
Allow modules to interact with the Drupal core.

Code

developer/hooks/authentication.php, line 39

<?php
function hook_auth($username, $password, $server) {
  $message = new xmlrpcmsg('drupal.login', array(new xmlrpcval($username, 
    'string'), new xmlrpcval($password, 'string')));

  $client = new xmlrpc_client('/xmlrpc.php', $server, 80);
  $result = $client->send($message, 5);
  if ($result && !$result->faultCode()) {
    $value = $result->value();
    $login = $value->scalarval();
  }

  return $login;
}
?>