diff options
Diffstat (limited to 'modules/openid/openid.api.php')
| -rw-r--r-- | modules/openid/openid.api.php | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/modules/openid/openid.api.php b/modules/openid/openid.api.php index 11faa71ef..5e3d15d94 100644 --- a/modules/openid/openid.api.php +++ b/modules/openid/openid.api.php @@ -49,8 +49,13 @@ function hook_openid_response($response, $account) { * 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 array of services, - * in the same form returned by openid_discover(). + * 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. @@ -58,6 +63,7 @@ function hook_openid_response($response, $account) { * @return * An associative array which keys are the name of the discovery methods and * values are function callbacks. + * * @see hook_openid_discovery_method_info_alter() */ function hook_openid_discovery_method_info() { |