Same name and namespace in other branches
  1. 4.6.x developer/hooks/authentication.php \hook_info()
  2. 4.7.x developer/hooks/authentication.php \hook_info()

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

13 functions implement hook_info()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

blogapi_blogger_get_user_info in modules/blogapi/blogapi.module
Blogging API callback. Returns profile information about a user.
blog_node_info in modules/blog/blog.module
Implementation of hook_node_info().
book_node_info in modules/book/book.module
Implementation of hook_node_info().
color_get_info in modules/color/color.module
Retrieve the color.module info for a particular theme.
drupal_info in modules/drupal/drupal.module
Implementation of hook_info().

... See full list

File

developer/hooks/authentication.php, line 74
These hooks are defined by authentication modules, modules that define ways users can log on using accounts from other sites and servers.

Code

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