Skip to content

Commit 9785aeb

Browse files
authored
Merge pull request #716 from ExpressionEngine/feature/7.x/memberlist-tag
Docs on memberlist tag usage
2 parents 7c69ad6 + 4e17cbc commit 9785aeb

File tree

2 files changed

+47
-3
lines changed

2 files changed

+47
-3
lines changed

docs/control-panel/settings/members.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,19 +77,22 @@ The default member profile theme to be used in the Member Profile area of your s
7777

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

80-
Specifies the sorting criteria to be used. Choices are: Total Posts, Screen Name, Total Comments, Total Entries, Join Date.
80+
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.
81+
Can also be changed using [`memberlist_row_limit` configuration override](general/system-configuration-overrides.md#memberlist_row_limit).
8182

8283
### Order by
8384

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

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

8890
### Total results
8991

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

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

9497
### Enable new member notifications?
9598

docs/member/memberlist.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,47 @@ Outputs a searchable list of members, including form filters to sort and limit t
1717

1818
## Parameters
1919

20+
### `role_id=`
21+
22+
role_id="5"
23+
24+
Restrict the output to members that belong to certain [role](control-panel/member-manager.md#member-roles).
25+
26+
### `orderby=`
27+
28+
orderby="screen_name"
29+
30+
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:
31+
- `member_id`
32+
- `role_id`
33+
- `screen_name`
34+
- `email`
35+
- `join_date`
36+
- `last_visit`
37+
- `last_activity`
38+
- `total_entries`
39+
- `total_comments`
40+
- `last_entry_date`
41+
- `last_comment_date`
42+
43+
When not set, defaults to [Member List - Order](control-panel/settings/members.md#order-by)
44+
setting or [`memberlist_order_by` configuration override](general/system-configuration-overrides.md#memberlist_order_by)
45+
46+
### `sort=`
47+
48+
sort="asc"
49+
sort="desc"
50+
51+
Set the order in which members are displayed.
52+
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)
53+
54+
### `limit=`
55+
56+
limit="30"
57+
58+
Allows you to limit the number of members displayed.
59+
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)
60+
2061
### `return=`
2162

2263
return="member/memberlist"

0 commit comments

Comments
 (0)