Commit d761ded1 authored by Dries's avatar Dries

- Patch #59763 by Ber: doxygen for user_roles().

parent 6411e09d
......@@ -1680,11 +1680,16 @@ function user_admin_access() {
}
/**
* Use this API to retreive an array of all available roles
* @param $membersonly Set this to TRUE to omit the special role 'anonymous'.
* @param $permission A string containing a permission. If set, only roles that have that permission are returned.
* @return An associative array, with the role id as key and the role name as value.
**/
* Retrieve an array of roles matching specified conditions.
*
* @param $membersonly
* Set this to TRUE to exclude the 'anonymous' role.
* @param $permission
* A string containing a permission. If set, only roles containing that permission are returned.
*
* @return
* An associative array with the role id as the key and the role name as value.
*/
function user_roles($membersonly = 0, $permission = 0) {
$roles = array();
......
......@@ -1680,11 +1680,16 @@ function user_admin_access() {
}
/**
* Use this API to retreive an array of all available roles
* @param $membersonly Set this to TRUE to omit the special role 'anonymous'.
* @param $permission A string containing a permission. If set, only roles that have that permission are returned.
* @return An associative array, with the role id as key and the role name as value.
**/
* Retrieve an array of roles matching specified conditions.
*
* @param $membersonly
* Set this to TRUE to exclude the 'anonymous' role.
* @param $permission
* A string containing a permission. If set, only roles containing that permission are returned.
*
* @return
* An associative array with the role id as the key and the role name as value.
*/
function user_roles($membersonly = 0, $permission = 0) {
$roles = array();
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment