Document missing hook_openid() [#345376]

From #217912: Document undocumented hooks (currently 1 remaining on list) and #131026: OpenID Consumer/Relying Party support in core for 6.x, we have one undocumented hook left in core, hook_openid(). The hook is called from openid_authentication_request. I'd like to help document this, but for the life of me I have no idea what it does since the documentation in openid.module is so sparse.

Note: This documentation needs to go in a new file called 'openid.api.php' in modules/openid for D7, and when backported to 6.x I can easily commit it to the contrib/docs/developer/hooks/core.php file.

Comment	File	Size	Author
#5	345376-hook_openid.diff	1.03 KB	jeffschuler

Comments

Comment #1

dave reid

he/him

English

Nebraska USA

commented 20 December 2008 at 15:15

Title:	Document hook_openid()	» Document missing hook_openid()
Component:	openid.module	» documentation

Comment #2

matason commented 22 December 2008 at 18:27

I've had a look at this, the hook enables modules to modify the request parameters before they get sent over to the OpenID provider. A module wanting to implement this hook would need a function like this:-

function my_module_openid($op, $request) { ... }

and would need to return an a keyed array like this:-

return array('openid.identity' => 'http://matason.myopenid.com/');

Hope this is helpful?