User Documentation

Tag Parameters

entry_id

string

This parameter is required to run the User:Authors tag. You can feed it the entry ID from the Channel:Entries tag or an entry ID from the URI.

{exp:user:authors entry_id="{entry_id}"}

orderby

string

This parameter allows you to order your authors list by screen name, or show the primary author first or last.

{exp:user:authors orderby="primary"}

sort

string

This parameter controls whether you want screen name ordered entries sorted by asc or desc, or if you want primary authors to show first or last.

{exp:user:authors sort="desc"}

Variables

primary

yes/no

This variable parses to y or n. Assigning a primary author of an entry is done so in the CP Publish page for the given entry by making it first in the list. The likely usage for this variable is as a conditional, which allows you to display alternate text, CSS class or image.

accepts: "y","n"

{if primary == "y"} (Primary) {/if}

Tag Parameters

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:delete_form error_page="user/error_template"}

form:attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:delete_form form:attribute="your_class"}

return

string

This parameter allows you specify a return URL you'd like the user to be returned to after submitting the form.

{exp:user:delete_form return="user/success"}

secure_action

yes/no

This parameter allows you to set the action on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:delete_form secure_action="y"}

secure_return

yes/no

This parameter allows you to set the return on the form to have https://. Use for processing forms with SSL

accepts: "y","n"

{exp:user:delete_form secure_return="y"}

Variables

content

This variable outputs the error(s) that occurred.

{content}

heading

This variable outputs the heading error type for the error(s) that occurred.

{heading}

link

This variable outputs the Return to Previous Page back button link. (is also a cool green elf)

{link}

title

This variable outputs the title for the error page.

{title}

Tag Parameters

allowed_groups

int

This parameter gives you flexibility and security against which member groups a user can assign themselves to, should you give them that option. Super Admin member group is not allowed. Works in conjunction with select_member_groups variable pair.

{exp:user:edit allowed_groups="5|8"}

assign_roles

string

If using the User Roles feature, you can assign users to roles when they edit their profile. More likely that you would use a separate Edit form with just this parameter supplied, and a submit button. Use the short name of the role(s) you wish for the user to be assigned to upon submit of form. Use either this feature or the User Assigned Roles feature (where users can assign themselves to roles).

{exp:user:edit assign_roles="role_name_1|role_name_2"}

dynamic

yes/no

This parameter is available to stop the tag from looking into the URI for an ID of any type.

accepts: "y","n"

{exp:user:edit dynamic="n"}

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:edit error_page="usererror_template"}

exclude_username

string

This parameter allows you to prevent some words from being used as usernames.

{exp:user:edit exclude_username="member"}

form:attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:edit form:attribute="your_class"}

group_id

integer

This parameter allows you to specify which additional member groups you wish to have Administrative privileges to for editing other users' profiles. This setting also respects the EE member group privileges, so be sure the member group has sufficient privileges. This setting will not allow members to change the member group assignment. To allow that, see the allowed_groups parameter.

{exp:user:edit group_id="6|7|12"}

member_id

string

This parameter allows you to show the specified members' data. A variable like {segment_3} can also be used to pull a Member ID from the URL.

{exp:user:edit member_id="5"}

onsubmit

string

This parameter allows you to execute Javascript functions at form submission.

{exp:user:edit onsubmit="some_javascript()"}

override_return

string

This parameter allows you to bypass the default EE message template page and brings the user directly to the template URI specified.

{exp:user:edit override_return="template_group/template"}

password_required

yes/no

When provided a value of yes, this parameter will force the user to enter their current password to submit any changes to their profile. Specifying a value of no with NOT disable normal password required behavior.

accepts: "y","n"

{exp:user:edit password_required="y"}

required

string

This parameter allows you to force your users to enter a value for the specified fields.

{exp:user:edit required="location|CUSTOM_MEMBER_FIELD"}

return

string

This parameter allows you to return the user to a specified template upon successful submittal of form.

{exp:user:edit return="template_group/template"}

screen_name_password_required

yes/no

By default, users are required to enter their current password to change their screen name. By specifying this parameter with a value of no, you can disable the password check.

accepts: "y","n"

Default: y

{exp:user:edit screen_name_password_required="n"}

secure_action

yes/no

This parameter allows you to set the action on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

Default: n

{exp:user:edit secure_action="y"}

secure_return

yes/no

This parameter allows you to set the return on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

Default: n

{exp:user:edit secure_return="y"}

username

string

This parameter allows you to show the specified members' data. A variable like {segment_3} can also be used to pull a username from the URL.

{exp:user:edit username="monkey_doodle"}

username_override

yes/no

If using the Email as Username feature, this parameter lets you indicate when an email address is to be used as a username.

accepts: "y","n"

{exp:user:edit username_override="yes"}

user_assigned_roles

yes/no

If using the User Roles feature, you can set up your User:Edit form to allow your users to assign roles to themselves. To allow this feature, specify a value of yes for this parameter, and be sure to specify which roles users are allowed to assign themselves to with the user_assigned_roles_allowed parameter. Used in conjunction with the roles form field.

accepts: "y"/"n"

Default: n

{exp:user:edit user_assigned_roles="y"}

user_assigned_roles_allowed

string

If using the User Roles feature, you can set up your User:Edit form to allow your users to assign roles to themselves. To allow this feature, specify a value of yes for the user_assigned_roles parameter, and specify which roles users are allowed to assign themselves to in this parameter. Used in conjunction with the roles form field.

{exp:user:edit user_assigned_roles_allowed="monkeys|pants_wearers|honey_dippers"}

Variables

avatar_filename

This variable outputs the upload directory path, filename, and file extension of the user's avatar if they have one (ex: uploads/avatar_1.jpg).

{avatar_filename}

avatar_height

This variable outputs the height of the user's avatar (ex: 60).

{avatar_height}

avatar_url

This variable outputs the avatar directory path (ex: http://www.yoursite.com/images/avatars/).

{avatar_url}

avatar_width

This variable outputs the width of the user's avatar (ex: 80).

{avatar_width}

email

This variable outputs the user's email address.

{email}

group_id

This variable outputs the user's member group ID they belong to.

{group_id}

join_date

This variable outputs the user's join date.

{join_date format="%F %j, %Y"}

last_activity

This variable outputs the last time the user was active.

{last_activity format="%F %j, %Y"}

last_bulletin_date

This variable outputs the last time the user posted a bulletin.

{last_bulletin_date format="%F %j, %Y"}

last_comment_date

This variable outputs the last time the user submitted a comment.

{last_comment_date format="%F %j, %Y"}

last_email_date

This variable outputs the last time the user sent an email via the EE email function.

{last_email_date format="%F %j, %Y"}

last_entry_date

This variable outputs the last time the user submitted a channel entry.

{last_entry_date format="%F %j, %Y"}

last_forum_post_date

This variable outputs the last time the user posted in the forums.

{last_forum_post_date format="%F %j, %Y"}

last_rating_date

This variable outputs the last time the user submitted a rating (with Rating add-on).

{last_rating_date format="%F %j, %Y"}

last_view_bulletins

This variable outputs the last time the user viewed a bulletin.

{last_view_bulletins format="%F %j, %Y"}

last_visit

This variable outputs the last time the user visited your website.

{last_visit format="%F %j, %Y"}

user_member_id

This variable outputs the users member ID.

{user_member_id}

screen_name

This variable outputs the users screen name.

{screen_name}

signature

This variable outputs the text value of the users signature.

{signature}

username

This variable outputs the user's username.

{username}

MEMBER_FIELD

All member fields are available. To parse data for a variable, simply specify its short_name you gave it in the EE control panel.

{MEMBER_FIELD}

lang:MEMBER_FIELD:label

This variable allows you to display the label given in the EE control panel of a given field. To construct this variable, simply use: {lang: + MEMBER_FIELD_SHORT_NAME + :label} (ex: {lang: + favorite_food + :label} = {lang:favorite_food:label}).

{lang:MEMBER_FIELD:label}

lang:MEMBER_FIELD:description

This variable allows you to display the description/instructions given in the EE CP of a given field. To construct this variable, simply use: {lang: + MEMBER_FIELD_SHORT_NAME + :description} (ex: {lang: + favorite_food + :description} = {lang:favorite_food:description}).

{lang:MEMBER_FIELD:description}

timezone_menu

This timezone menu helps with date/time settings and displays two select fields. One for country, and a second for the actual timezone. This variable accepts 3 different parameters: 1) id = "my_wrapper_id" - only affects the outer wrapper of the select fields. 2) timezone:class="my_class" - only affects the timezone select field. 3) country:class="my_class" - only affects the country select field.

{user:timezone_menu id="timezone_select_wrapper" timezone:id="timezone_id" country:id="country_id"}

Tag Parameters

dynamic

yes/no

This parameter is available to stop the loop from looking into the URI for an ID of any type.

accepts: "y","n"

{exp:user:entries dynamic="no"}

limit

integer

This parameter controls how many results will be outputted. The limit will default to 100 entries if a value is not specified.

Default: 100

{exp:user:entries limit="15"}

orderby

string

This parameter gives you the ability to control the order in which your users are ordered in the list. You can order by any variable that you can parse on as well as random

{exp:user:entries orderby="username|screen_name"}

paginate

string

Pagination works just like it does in the Channel:Entries tag. When specified, and used in conjunction with the user_paginate variable pair, pagination will display. Refer to Channel:Entries tag documentation for more information.

{exp:user:entries paginate="both"}

sort

string

You can sort by asc or desc.

{exp:user:entries sort="asc"}

user_author_id

string

This parameter allows you to hardcode an author ID or pull an author ID dynamically from the URL. To specify multiples, use the pipe character.

{exp:user:entries user_author_id="{segment_3}"}

Tag Parameters

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:forgot:password error_page="user/error_template"}

form:attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:forgot:password form:class="your_class"}

onsubmit

This parameter allows you to execute Javascript functions at form submission.

{exp:user:forgot:password onsubmit="some_javascript()"}

password_reset_template

string

This parameter allows you specify the URI of your Reset Password template so you can customize the password reset experience. Without this parameter, User will send the default reset token to the user which will use ExpressionEngine's built-in reset password form.The %id% portion of the URI allows you to specify where in the URL the reset token is put when emailed to the user.

{exp:user:forgot:password password_reset_template="user_main/reset_password/%id%"}

password_reset_email_subject

string

This parameter allows you specify the subject of the reset email sent to the user. If you do not specify the subject, the default ExpressionEngine password reset subject will be used.

{exp:user:forgot:password password_reset_email_subject="Password Reset Request"}

password_reset_email_template

string

This parameter allows you to specify an EE template to be used for the email sent to the user when requesting a password form. This template does not support a full template parsing and only the following tags are available: email, member_id, name, reset_url, screen_name, site_name, site_url, username

Default: email

{exp:user:forgot:password password_reset_email_template="user_notifications/reset_password"}

return

string

This parameter allows you specify a return URL you'd like the user to be returned to after submitting the form.

{exp:user:forgot:password return="user/success"}

secure_reset_link

yes/no

This parameter allows you specify if the link to the password reset template page should be forced to use https://.

accepts: "y","n"

Default: n

{exp:user:forgot:password secure_reset_link="y"}

Tag Parameters

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:forgot_username error_page="user/error_template"}

form:attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:forgot_username form:class="your_class"}

onsubmit

string

This parameter allows you to execute Javascript functions at form submission.

{exp:user:forgot_username onsubmit="some_javascript()"}

override_return

string

This parameter allows you to bypass the default EE message template page and brings the user directly to the template URI specified.

{exp:user:forgot_username override_return="template_group/template"}

return

string

This parameter allows you specify a return URL you'd like the user to be returned to after submitting the form.

{exp:user:forgot_username return="user/success"}

secure_action

yes/no

This parameter allows you to set the action on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:forgot_username secure_action="yes"}

secure_return

yes/no

This parameter allows you to set the return on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

Default: n

{exp:user:forgot_username secure_return="yes"}

Tag Parameters

roles

string

This parameter tells the User:Has_Role tag which roles to check against the current user. Specify the role short names that you would like to check on. By default, it will check to see if the user has any of the roles in this parameter. If you want ALL roles to be matched against the current user, use the match_all parameter.

{exp:user:has_role roles="honey_dippers|bench_warmers"}

match_all

yes/no

By default, the roles parameter will check to see if the user has any of the roles specified in the parameter. If you want ALL roles to be matched against the current user, use this parameter with a value of yes.

accepts: "y","n"

Default: n

{exp:user:has_role match_all="yes"}

Tag Parameters

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:key error_page="user/error_template"}

form:attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:key form:attribute="your_class"}

html

yes/no

This parameter allows you to specify whether the invitation email should use HTML or plain text formatting. Indicate yes for HTML and no (default) for plain text.

accepts: "y"/"n"

Default: n

{exp:user:key html="y"}

parse

string

This parameter controls the parsing method used on your invitation template. Valid parsing methods are: xhtml, br and none (default).

{exp:user:key parse="xhtml"}

onsubmit

string

This parameter allows you to execute Javascript functions at form submission.

{exp:user:key onsubmit="some_javascript()"}

return

string

This parameter allows you specify a return URL you'd like the user to be returned to after submitting the form. If you would like to show this key on the landing page you designate, use this code: return="template_group/template/%%key%%". The key created will take the place of the %%key%% construct and you can call it into your template as a segment variable.

{exp:user:key return="user/success"}

secure_action

yes/no

This parameter allows you to set the action on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

Default: n

{exp:user:key secure_action="yes"}

secure_return

yes/no

This parameter allows you to set the return on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:key secure_return="yes"}

template

string

This parameter allows you to specify a notification template for use with invitation key notifications. Only when you provide this template will invitation emails be sent. You can use any of your site templates. The template will be used to format the email invitation that will be sent to your new potential members. See example below.

{exp:user:key template="user_inc/key_notification"}

word_wrap

yes/no

This parameter allows you to specify whether the invitation email should have word wrap turned on or off. Indicate yes to leave word wrapping on and no to turn it off.

accepts: "y","n"

Default: y

{exp:user:key word_wrap="yes"}

Variables

from_email

This variable is available to display the email address specified in the From field.

{from_email}

from_name

This variable is available to display the "from name" specified in the Name field.

{from_name}

key

This variable is available to display the unique invitation Key generated by User:Key function.

{key}

selected_group_id

This variable is available to display the member group ID specified in the group_id field.

{selected_group_id}

subject

This variable is available to display the subject specified in the subject field.

{subject}

to_email

This variable is available to display the "to email" specified in the to field.

{to_email}

Tag Parameters

return

required

string

This parameter controls the return path to be appended into the url variable. Specify a template path and/or fake segments for the path.

{exp:user:logout return="user/success"}

vars

Tag Parameters

dynamic

yes/no

This parameter is available to stop the loop from looking into the URI for an ID of any type.

accepts: "y","n"

Default: n

{exp:user:profile dynamic="no"}

log_views

string

This parameter allows you to disable incrementing of profile views each time the User:Profile tag is run. This might be helpful in a scenario where you use the User:Profile tag twice on a template, etc, so it does not log 2 views each time the page is loaded. See profile_views variable.

{exp:user:profile log_views="off"}

member_id

int

This parameter allows you to show the specified member's profile. A variable like {segment_3} can also be used to pull a Member ID from the URL.

{exp:user:profile member_id="5"}

username

string

This parameter allows you to show the specified member's profile. A variable like {segment_3} can also be used to pull a username from the URL.

{exp:user:profile username="some_username"}

vars

Tag Parameters

admin_register

yes/no

This parameter allows users of member groups that are allowed to administrate members to view the Register form, and submit new user registrations on behalf of others. Using this parameter will prevent the auto-login feature after registration from working (so the admin doesn't become logged in as the member they just created).

accepts: "y","n"

{exp:user:register admin_register="yes"}

allowed_groups

integer

This parameter gives you flexibility and security against which member groups a user can assign themselves to, should you give them that option. Super Admin member group is not allowed. Works in conjunction with select_member_groups variable pair.

{exp:user:register allowed_groups="5|8"}

assign_roles

integer

If using the User Roles feature, you can assign users to roles through registration. Use the short name of the role(s) you wish for the user to be assigned to upon registration. Use either this feature or the User Assigned Roles feature (where users can assign themselves to roles).

{exp:user:register assign_roles="role_name_1|role_name_2"}

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:register error_page="user/error_template"}

exclude_username

string

This parameter allows you to prevent some words from being used as usernames.

{exp:user:register exclude_username="member|pants"}

form:attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:register form:class="your_class"}

group_id

int

This parameter allows you to force new registrations into a specified member group. This enables you to create multiple Registration forms and use different member groups with each. This parameter respects native EE account activation settings.

{exp:user:register group_id="8"}

key_email_match

yes/no

If using the Invite Key feature, this parameter allows you to require an invitation key to match the email address to which it was paired at the time the key was created using the User:Key function.

accepts: "y","n"

{exp:user:register key_email_match="yes"}

onsubmit

string

This parameter allows you to execute Javascript functions at form submission.

{exp:user:register onsubmit="some_javascript()"}

override_return

string

This parameter allows you to bypass the default EE message template page and brings the user directly to the template URI specified.

{exp:user:register override_return="template_group/template"}

require_key

yes/no

If using the Invite Key feature, this parameter allows to you make sure an invitation key has been submitted.

accepts: "y","n"

{exp:user:register require_key="yes"}

required

string

This parameter allows you to force your users to enter a value for the specified fields.

{exp:user:register required="MEMBER_FIELD_NAME|ANOTHER_MEMBER_FIELD_NAME"}

return

string

This parameter allows you to return the user to a specified template upon successful submittal of form.

{exp:user:register return="template_group/template"}

secure_action

yes/no

This parameter allows you to set the action on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:register secure_action="yes"}

secure_return

yes/no

This parameter allows you to set the return on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:register secure_return="yes"}

user_assigned_roles

yes/no

If using the User Roles feature, you can set up your User:Register form to allow your users to assign roles to themselves. To allow this feature, specify a value of yes for this parameter, and be sure to specify which roles users are allowed to assign themselves to with the user_assigned_roles_allowed parameter. Used in conjunction with the roles form field.

accepts: "y","n"

{exp:user:register user_assigned_roles="yes"}

user_assigned_roles_allowed

string

If using the User Roles feature, you can set up your User:Register form to allow your users to assign roles to themselves. To allow this feature, specify a value of yes for the user_assigned_roles parameter, and specify which roles users are allowed to assign themselves to in this parameter. Used in conjunction with the roles form field.

{exp:user:register user_assigned_roles_allowed="monkeys|pants_wearers|honey_dippers"}

Variables

captcha

This variable will display a CAPTCHA image if your website requires captcha to register.

{captcha}

key

If using the Invite Key feature, this variable will output the invitation Key if present in the URL (prepended by a /key/ segment in the URL).

{key}

Tag Parameters

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:reset:password error_page="user/error_template"}

form_attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:reset:password form:attribute="your_class"}

onsubmit

string

This parameter allows you to execute Javascript functions at form submission.

{exp:user:reset:password onsubmit="some_javascript()"}

reset_code

string

This parameter is the incoming reset token from the URL, generated from the User:Forgot_Password - password_reset_template parameter which was emailed to the user as a reset link. The easiest way to use this parameter is to specify the segment you set in your password_reset_template parameter. this parameter, User:Reset_Password cannot work. This must be correctly set.

{exp:user:reset:password reset_code="{segment_3}"}

return

This parameter allows you specify a return URL you'd like the user to be returned to after submitting the form.

{exp:user:reset:password return="user/success"}

secure_action

yes/no

This parameter allows you to set the action on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:reset:password secure_action="yes"}

secure_return

yes/no

This parameter allows you to set the return on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:reset:password secure_return="yes"}

Tag Parameters

Variables

keywords

This variable returns the keyword(s) that were searched. This variable can also be used outside of the User:Results tag.

{keywords}

total_results

This' variable returns the total amount of results returned for the keyword(s) searched. This variable can also be used outside of the User:Results tag.

{total_results}

Tag Parameters

dynamic

yes/no

This parameter is available to stop the loop from looking into the URI for an ID of any type.

accepts: "y","n"

{exp:user:roles_entires dynamic="no"}

entry_id

integer

This parameter differs from the normal Channel:Entries entry_id="" paramater in that it will make a pre-defined list of entries for Roles Entries to filter from. If the entry ID's in this parameter do not have roles that match the restrictions lined out on the other parameters on this tag, the entries will not show. This is solely for a further level of filtering entries.

{exp:user:roles_entires entry_id="6|7|8"}

limit

integer

This parameter controls how many results will be outputted. The limit will default to 100 entries if a value is not specified.

{exp:user:roles_entires limit="15"}

orderby

string

This parameter gives you the ability to control the order in which your users are ordered in the list. You can order by any variable that you can parse on as well as random.

{exp:user:roles_entires orderby="username|screen_name"}

paginate

string

Pagination works just like it does in the Channel:Entries tag. When specified, and used in conjunction with the paginate variable pair, pagination will display. Refer to Channel:Entries tag documentation for more information.

{exp:user:roles_entires paginate="both"}

restrict_to_roles

string

This parameter allows you to manually specify roles to restrict entries to (by default all roles will be shown, if not specified). If using multiple roles, separate with the pipe character. This does not take into account the current user's available roles - only the roles listed in this parameter. If you wish for entries to only show to users that have matching roles assigned to them, see the restrict_to_user_roles parameter. Role names must match the short name as defined in the User control panel. When specifying role names, this is NOT inclusive. It will only check to see if any of the roles specified in this parameter match any of the roles assigned to entries, no matter how complex they may be, or how many lesser or extra roles they contain from what it specified here.

{exp:user:roles_entires restrict_to_roles="monkeys|pants_wearers|honey_dippers"}

restrict_to_user_roles

yes/no

This parameter allows you to specify that the logged in user's available roles will be used to filter entries that have been assigned some or all of the same roles the user has. Default is no. When using in conjunction with the restrict_to_roles parameter, it will check to see if the logged in user fully matches any of the sets of roles for each entry. So for example, if Entry X has the roles Monkeys AND Pants Wearers, OR Honey Dippers, but the user's assigned roles are Monkeys and Bench Warmers, they will not see Entry X because they don't have both Monkeys AND Pants Wearers roles assigned to them. They would need to also have the Pants Wearers role assigned to them.

accepts: "y","n"

{exp:user:roles_entires restrict_to_user_roles="yes"}

sort

string

You can sort by asc or desc.

{exp:user:roles_entires sort="asc"}

Tag Parameters

error_page

string

This parameter allows you to bypass the EE message template for displaying errors, and instead show your own regular template with the error messages. Error template must follow guidelines of User Error Page.

{exp:user:search error_page="user/error_template"}

form:attribute

string

This parameter allows you to control any form attribute for the form in your template. Simply replace attribute with an attribute name such as id, name, class, etc, and specify a value for that attribute. You can specify this parameter multiple times to control as many attributes as necessary. This would normally be done to control your form with Javascript or style it with CSS.

{exp:user:search form:attribute="your_class"}

group_id

integer

This parameter allows you to constrain the search to a set of member group ID's. For multiples, use pipe character.

{exp:user:search group_id="5|6|7"}

return

string

This parameter specifies the return URL for the results page. This would be the template that has the User:Results template tag in it.

{exp:user:search return="template_group/template"}

secure_action

yes/no

This parameter allows you to set the action on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:search secure_action="y"}

secure_return

yes/no

This parameter allows you to set the return on the form to have https://. Use for processing forms with SSL.

accepts: "y","n"

{exp:user:search secure_return="y"}

skip_field

string

This parameter allows you to skip some fields from being search if you want them ignored by the search engine. For multiples, use pipe character.

{exp:user:search skip_field="firstname|lastname|screen_name"}

Variables

keywords

This variable returns the keyword(s) that were searched upon previously. This would be used if you were using the User:Search function to search within search results.

{keywords}

Tag Parameters

alpha

string

This parameter allows you to filter down your results to users whose screen names begin with the specified letter(s).

{exp:user:users alpha="Tom"}

The example would return users with names like: Tom, Tomhas, Tommy,Tom&Jerry

dynamic

yes/no

This parameter is available to stop the loop from looking into the URI for an ID of any type.

accepts: "y","n"

{exp:user:users dynamic="no"}

dynamic_parameters

yes/no

This parameter allows for dynamic sorting of your users list. Used in conjunction with the user_orderby and user_sort form fields.

accepts: "y","n"

{exp:user:users dynamic_parameters="no"}

group_id

integer

This parameter allows you to filter your user list results by member group(s). Additionally, you can use not to exclude member groups you'd like to not show (not 4|7). Separate multiple values with the pipe character.

{exp:user:users group_id="6|7|12"}

In the first example member groups 6 , 7, 12 will be filtered.   In the second example, 6, 7, 12 will not be filtered

limit

integer

This parameter controls how many results will be outputted. The limit will default to 100 entries if a value is not specified.

Default: 100

{exp:user:users limit="15"}

will limit returns to only 15 users

member_id

integer

This parameter allows you to filter out or display only specific members by specifying their member ID(s). You can hardcode a member ID, pass it through an embed, or grab it from the URI. Specify not to exclude specific members from displaying in the results. separate multiple member ID's with the pipe character.

{exp:user:users member_id="15"}

will return user with id 15

orderby

integer

This parameter gives you the ability to control the order in which your users are ordered in the list. This parameter can accept multiple values separated by pipe. When multiples are provided, the sort parameter should match up with pipes. You can order by any variable that you can parse on as well as random.

{exp:user:users orderby="username|screen_name"}

will return user with id 15

offset

integer

This parameter will skip the first specified amount of users in the list. For example, if you specify 2, it will not show the first 2 users in the list.

{exp:user:users offset="2"}

first 2 users not shown

paginate

string

Pagination works just like it does in the Channel:Entries tag. When specified, and used in conjunction with the user_paginate variable pair, pagination will display. Refer to Channel:Entries tag documentation for more information.

{exp:user:users paginate=""}

search:member_field

string

This parameter works similar to the EE search:field= parameter and allows you to search your member fields for specific values to filter down your member results. Additionally, you can search on Screen Name and Usernames as well. % can be used as a wildcard, && can be used for inclusive (contains both/all values) searching, and the pipe character (|) can be used to specify multiple values

{exp:user:users: search:member_field="IS_EMPTY"} (members that have that field empty.)

{exp:user:users: search:member_field="IS_NOT_EMPTY"} (members that have a value for that field.)

{exp:user:users: search:member_field="value"} (members that contain the specified value for that field.) 

{exp:user:users: search:member_field="value|value2"} (members that contain EITHER of the specified values for that field)

{exp:user:users: search:member_field="value1&&value2"} (members that contain BOTH of the specified values for that field.)

{exp:user:users: search:member_field="%value%"} (members that contain the specified value within words for that field (ex: %pp% would match apple, happy, etc).)

exp:user:users: search:member_field="%value"} (members that contain the specified value within words for that field (ex: %nut would match peanut, chestnut, etc).)

{exp:user:users: search:member_field="value%"} (members that contain the specified value within words for that field (ex: %pan% would match pants, pans, etc))

{exp:user:users: search:member_field="not value"} (members that DO NOT contain the specified value for that field)

{exp:user:users: search:member_field="not value|value2"} (members that DO NOT contain EITHER of the specified values for that field.)

{exp:user:users: search:member_field="not value&&value2"} (members that DO NOT contain BOTH of the specified values for that field.)

{exp:user:users: search:member_field="not %value%"} (members that DO NOT contain the specified value within words for that field (ex: %pp% would exclude apple, happy, etc).)

{exp:user:users: search:member_field="not value&&value2"} (members that DO NOT contain BOTH of the specified values for that field.)

{exp:user:users: search:member_field="not %value%"} (members that DO NOT contain the specified value within words for that field (ex: %pp% would exclude apple, happy, etc).)

{exp:user:users: search:member_field="not value|%value2%"} (members that DO NOT contain a direct word match on the first value, or DO NOT contain the second value within any words in that field.)

{exp:user:users: search:member_field="not value&&%value2%"} (members that DO NOT contain a direct word match on the first value, AND DO NOT contain the second value within any words in that field.)

sort

string

You can sort by asc or desc. When multiples are provided in the orderby, this parameter should match up with pipes

{exp:user:users sort="asc"}

Variables

abbr

string

You can sort by asc or desc. When multiples are provided in the orderby, this parameter should match up with pipes

{abbr_your_member_field}

count

int

This variable outputs the display order number for each user in the list results.

{count}

switch

string

This variable allows you to switch a CSS class back and fourth for all outputted results.

{switch="style1|style2"}

total_combined_posts

This variable shows the total combined posts for a given user.

{total_combined_posts}

total_results

This variable outputs the total number of results for that page. You would typically use this in a conditional statement.

{total_results}

absolute_count

This variable will return the absolute position number of each result within the list of results, including paginated results.

{absolute_count}

absolute_results

This variable will return the absolute total amount of results being displayed in the results, including paginated results. You would typically use this in a conditional statement.

{absolute_results}