Home › API reference

hook_info

Definition

hook_info($field = 0)
contributions/docs/developer/hooks/authentication.php, line 74

Description

Declare authentication scheme information.

This hook is required of authentication modules. It defines basic information about the authentication scheme.

Parameters

$field The type of information requested. Possible values:

  • "name"
  • "protocol"

Return value

A string containing the requested piece of information. If $field is not provided, an array containing all the fields should be returned.

Related topics

Namesort iconDescription
HooksAllow modules to interact with the Drupal core.

Code

function hook_info($field = 0) {
  $info['name'] = 'Drupal';
  $info['protocol'] = 'XML-RPC';

  if ($field) {
    return $info[$field];
  }
  else {
    return $info;
  }
}