Member List Tag
Overview
Outputs a searchable list of members, including form filters to sort and limit the members.
Tip: This form utilizes template form validation and error handling. Refer to the documentation for additional parameters and variables that are available to this tag.
Parameters
Valid HTML Form attributes (as listed in the config file), data- and aria- attributes passed through ExpressionEngine tag parameters in the template will be included into generated opening form tag.
backspace=
backspace="3"The backspace= parameter will remove the specified number of characters, including spaces and line breaks, from the last iteration of the tag pair.
error_handling="inline"
error_handling="inline"This parameter allows you to use inline errors in your registration form. The errors can be displayed using the {error:field_name} tag where field_name would need to be replaced with the name of the field that has an error, as used to compose the form.
form_class=
form_class="login"This parameter allows you to specify the class attribute for the search <form> tag.
form_id=
form_id="login"This parameter allows you to specify the id attribute for the search <form> tag.
form_name=
form_name="login"This parameter allows you to specify a name attribute for the search <form> tag.
limit=
limit="30"Allows you to limit the number of members displayed.
When not set, defaults to Member List - Rows setting or memberlist_row_limit configuration override
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
setting or memberlist_order_by configuration override
role_id=
role_id="5"Restrict the output to members that belong to certain role.
This parameter replaces group_id which is functionally identical and currently still supported.
sort=
sort="asc"
sort="desc"Set the order in which members are displayed.
When not set, defaults to Member List - Sort By setting or memberlist_sort_order configuration override
return=
return="member/memberlist"
return_error=
return_error="template_group/error"This parameter is for use with form validation and error handling and determines the template to return to if validation errors are detected.
Form Variables
{form_declaration}
This is a required variable in order to use the search form. It creates the opening form tag.
{role_options}
A list of options for filtering by member role
<select name='role_id' class='select'>
{role_options}
</select>
{order_by_options}
A list of options for changing the results order
<select name='order_by' class='select'>
{order_by_options}
</select>
{row_limit_options}
A list of options for changing the number of results returned
<select name='row_limit' class='select'>
{row_limit_options}
</select>
{sort_order_options}
A list of options for changing the results sort order
<select name='sort_order' class='select'>
{sort_order_options}
</select>Variable Pairs
{member_rows}
Data for each member are shown using a “looping pair”.
{member_rows}
<p>{name}</p>
{/member_rows}Member Row Tag Pair Parameters
backspace=
backspace="3"The backspace= parameter will remove characters, including spaces and line breaks, from the last iteration of the tag pair.
Member Row Tag Pair Variables
member_id
username
screen_name
email
join_date
last_visit
last_activity
last_entry_date
last_comment_date
last_forum_post_date
total_entries
total_comments
total_forum_topics
language
timezone
total_posts
role
Primary role name
{member_css}
{member_css}
{join_date}
{join_date format="%m/%d/%Y"}
{last_visit}
{last_visit format="%m/%d/%Y"}
{total_combined_posts}
{total_combined_posts}
{if accept_email}
Check whether the user can accept emails from site members
{email_console}
Link to pop-up with legacy email console
{profile_path}
Path to member profile page
{if avatar}
{avatar_filename}
{avatar_width}
{avatar_height}
{path:avatar}
Avatar URL
{paginate}
{paginate}
<p>Page {current_page} of {total_pages} pages {pagination_links}</p>
{/paginate}See pagination for more details.
Example
{exp:member:memberlist
orderby="screen_name"
sort="asc"
}
{form_declaration}
<table id="memberlist" class='tableborder' border="0" cellpadding="3" cellspacing="0" style="width:100%;">
<thead>
<tr>
<td class='memberlistHead' style="width:21%;">Name</td>
<td class='memberlistHead' style="width:13%;">Forum Posts</td>
<td class='memberlistHead' style="width:8%;">Email Short</td>
<td class='memberlistHead' style="width:13%;">Join Date</td>
<td class='memberlistHead' style="width:13%;">Last Visit</td>
</tr>
</thead>
<tbody>
{member_rows}
<tr>
<td class='{member_css}' style="width:20%;">
<span class="defaultBold"><a href="{path:profile}">{name}</a></span>
</td>
<td class='{member_css}'>{total_combined_posts}</td>
<td class='{member_css}'>
{if accept_email}
<a href="#" {email_console}>Email Console</a>
{/if}
</td>
<td class='{member_css}'>{join_date format="%m/%d/%Y"}</td>
<td class='{member_css}'>{last_visit format="%m/%d/%Y"}</td>
</tr>
{/member_rows}
<tr>
<td class='memberlistFooter' colspan="5" align='center' valign='middle'>
<div class="defaultSmall">
<b>show</b>
<select name='group_id' class='select'>
{group_id_options}
</select>
<b>sort</b>
<select name='order_by' class='select'>
{order_by_options}
</select>
<b>order</b>
<select name='sort_order' class='select'>
{sort_order_options}
</select>
<b>rows</b>
<select name='row_limit' class='select'>
{row_limit_options}
</select>
<input type='submit' value='submit' class='submit' />
</div>
</td>
</tr>
</tbody>
</table>
{paginate}
<div class="itempadbig">
<table cellpadding="0" cellspacing="0" border="0" class="paginateBorder">
<tr>
<td><div class="paginateStat">{current_page} of {total_pages}</div></td>
{pagination_links}
</tr>
</table>
</div>
{/paginate}
</form>
{/exp:member:memberlist}