Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/control-panel/settings/members.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,19 +77,22 @@ The default member profile theme to be used in the Member Profile area of your s

![sort by](/_images/member_sort_by.png)

Specifies the sorting criteria to be used. Choices are: Total Posts, Screen Name, Total Comments, Total Entries, Join Date.
Specifies the default sorting criteria to be used by `{exp:members:memberlist}` tag. Choices are: Total Posts, Screen Name, Total Comments, Total Entries, Join Date.
Can also be changed using [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit).

### Order by

![order by](/_images/member_order_by.png)

Specifies whether to show the list in _Ascending_ or _Descending_ order.
Specifies whether to show the `{exp:members:memberlist}` list in _Ascending_ or _Descending_ order.
Can also be changed using [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by).

### Total results

![total results](/_images/member_total_results.png)

Specifies the number of results to return by default.
Specifies the number of results that `{exp:members:memberlist}` tag will display by default.
Can also be changed using [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit).

### Enable new member notifications?

Expand Down
41 changes: 41 additions & 0 deletions docs/member/memberlist.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,47 @@ Outputs a searchable list of members, including form filters to sort and limit t

## Parameters

### `role_id=`

role_id="5"

Restrict the output to members that belong to certain [role](control-panel/member-manager.md#member-roles).

### `orderby=`

orderby="screen_name"

The "orderby" parameter sets the display order of members. The possible options for this parameter are the built-in member fields - including, but not limited to:
- `member_id`
- `role_id`
- `screen_name`
- `email`
- `join_date`
- `last_visit`
- `last_activity`
- `total_entries`
- `total_comments`
- `last_entry_date`
- `last_comment_date`

When not set, defaults to [Member List - Order](control-panel/settings/members.md#order-by)
setting or [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by)

### `sort=`

sort="asc"
sort="desc"

Set the order in which members are displayed.
When not set, defaults to [Member List - Sort By](control-panel/settings/members.md#sort-by) setting or [`memberlist_sort_order` configuration override](general/system-configuration-overrides.md#memberlist_sort_order)

### `limit=`

limit="30"

Allows you to limit the number of members displayed.
When not set, defaults to [Member List - Rows](control-panel/settings/members.md#total-results) setting or [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit)

### `return=`

return="member/memberlist"
Expand Down