You are here

Home » API reference » Drupal 7 » openid.api.php

function hook_openid_discovery_method_info in Drupal 7

Allow modules to declare OpenID discovery methods.

The discovery function callbacks will be called in turn with an unique parameter, the claimed identifier. They have to return an associative array with array of services and claimed identifier in the same form as returned by openid_discover(). The resulting array must contain following keys:

  • 'services' (required) an array of discovered services (including OpenID

version, endpoint URI, etc).

  • 'claimed_id' (optional) new claimed identifer, found by following HTTP

redirects during the services discovery.

The first discovery method that succeed (return at least one services) will stop the discovery process.

Return value

An associative array which keys are the name of the discovery methods and values are function callbacks.

See also

hook_openid_discovery_method_info_alter()

Related topics

Hooks
Allow modules to interact with the Drupal core.
1 function implements hook_openid_discovery_method_info()

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

openid_openid_discovery_method_info in modules/openid/openid.module
Implements hook_openid_discovery_method_info().
1 invocation of hook_openid_discovery_method_info()
openid_discovery in modules/openid/openid.module
Perform discovery on a claimed ID to determine the OpenID provider endpoint.

File

modules/openid/openid.api.php, line 69
Hooks provided by the OpenID module.

Code

function hook_openid_discovery_method_info() {
  return array(
    'new_discovery_idea' => '_my_discovery_method',
  );
}