#345376 by jeffschuler: OpenID hook documentation. Yay. :D

1 files changed, 36 insertions, 0 deletions

diff --git a/modules/openid/openid.api.php b/modules/openid/openid.api.php
new file mode 100644
index 000000000..7b9be59b2
--- /dev/null
+++ b/modules/openid/openid.api.php
@@ -0,0 +1,36 @@
+<?php
+// $Id$
+
+/**
+ * @file
+ * Hooks provided by the OpenID module.
+ */
+
+/**
+ * @addtogroup hooks
+ * @{
+ */
+
+/**
+ * Allow modules to modify the OpenID request parameters.
+ *
+ * @param $op
+ *   The operation to be performed.
+ *   Possible values:
+ *   - request: Modify parameters before they are sent to the OpenID provider.
+ * @param $request
+ *   An associative array of parameter defaults to which to modify or append. 
+ * @return
+ *   An associative array of parameters to be merged with the default list.
+ *
+ */
+function hook_openid($op, $request) {
+  if ($op == 'request') {
+    $request['openid.identity'] = 'http://myname.myopenid.com/';
+  }
+  return $request;
+}
+
+/**
+ * @} End of "addtogroup hooks".
+ */