Issue #1247812 by Albert Volkman, jzacsh: Add docs for user_admin() function

merge-requests/26/head
Jennifer Hodgdon 2012-12-06 13:41:22 -08:00
parent 11fafe6db5
commit 2af1995250
1 changed files with 15 additions and 0 deletions

View File

@ -5,6 +5,21 @@
* Admin page callback file for the user module. * 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 = '') { function user_admin($callback_arg = '') {
$op = isset($_POST['op']) ? $_POST['op'] : $callback_arg; $op = isset($_POST['op']) ? $_POST['op'] : $callback_arg;