summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2012-12-06 21:42:29 (GMT)
committer Jennifer Hodgdon2012-12-06 21:42:29 (GMT)
commit04274d4fa4e8f34b215561c962160c3e5b85c582 (patch)
treec8dbe5da9815e32e54d78ccccf977a7d3373641b
parent56bc3794f2d4794297d9b0f3ab9c0a9b5520a0ad (diff)
Issue #1247812 by Albert Volkman, jzacsh: Add docs for user_admin() function
-rw-r--r--modules/user/user.admin.inc15
1 files changed, 15 insertions, 0 deletions
diff --git a/modules/user/user.admin.inc b/modules/user/user.admin.inc
index eac39df..c84fdbc 100644
--- a/modules/user/user.admin.inc
+++ b/modules/user/user.admin.inc
@@ -5,6 +5,21 @@
* Admin page callback file for the user module.
*/
+/**
+ * Page callback: Generates the appropriate user administration form.
+ *
+ * This function generates the user registration, multiple user cancellation,
+ * or filtered user list admin form, depending on the argument and the POST
+ * form values.
+ *
+ * @param string $callback_arg
+ * (optional) Indicates which form to build. Defaults to '', which will
+ * trigger the user filter form. If the POST value 'op' is present, this
+ * function uses that value as the callback argument.
+ *
+ * @return string
+ * A renderable form array for the respective request.
+ */
function user_admin($callback_arg = '') {
$op = isset($_POST['op']) ? $_POST['op'] : $callback_arg;