Collections functions
General functions
Render functions
Theme permission functions
Resource functions

get_users()

Description

Returns a user list. Group or search term is optional. The standard user group names are translated using $lang. Custom user group names are i18n translated.

If blank, zero or NULL then all users will be returned irrespective of their group

Parameters

ColumnTypeDefaultDescription
$group integer 0 Can be a single group, or a comma separated list of groups used to limit the results
$find string "" Search string to filter returned results
$order_by string "u.username"
$usepermissions boolean false
$fetchrows integer -1
$approvalstate string ""
$returnsql boolean false Return prepared statement object containing sql query and parameters.
$selectcolumns string ""
$exact_username_match boolean false Denotes $find must be an exact username

Return

array|object Matching user records Returns an array of user information or prepared statement object containing sql query and parameters.

This article was last updated 30th September 2022 16:05 Europe/London time based on the source file dated 28th September 2022 20:05 Europe/London time.