Bitrix Site Manager

CForumUser::GetList

CDBResult
GetList(
 [array arOrder [,
 array arFilter]]
);

The method GetList returns a filtered and sorted list of profiles.

Parameters

ParameterDescription
arOrder An array of the format Array(by1=>order1[, by2=>order2 [, ..]]), where:

by - the field by which the list is to be sorted. The following values are possible:
  • ID - the profile ID;
  • USER_ID - the user ID;
  • SHOW_NAME - show name instead of login;
  • NUM_POSTS - number of posts;
  • LAST_POST - the ID of the last message;
  • NAME - user name;
  • LAST_NAME - user last name;
  • LOGIN - login;
  • LAST_VISIT - the date of the last visit;
order - sort order. The following values are possible:
  • ASC - ascending;
  • DESC - descending;
Optional. The default value is Array("ID"=>"ASC").
arFilter An array of the format array("filter field"=>"filter value" [, ...]).

The "filter field" can be one of the following:
  • ID - the profile ID;
  • USER_ID - the user ID;
  • RANK_ID - the user rank ID;
  • SHOW_NAME - show name instead of login;
  • NUM_POSTS - number of posts;
  • ALLOW_POST - allow posts from this user (i.e. not banned);
The filtered field may contain one of the following condition operators before the name:
  • "!" - not equal;
  • "<" - less than;
  • "<=" - less or equal;
  • ">" - more than;
  • ">=" - more or equal.
Optional. By default, records are not filtered.

Return Values

Returns an object of the CDBResult class.

See Also

CDBResult
Profile fields