Using UserLookupPlugin
The UserLookupPlugin searches users and displays results as a sortable table. What you can see depends on your permissions — administrators see full profiles; other users see names only.
Description
Use this plugin to embed a live user directory on any page. Results are filtered and sorted in the table — click any column heading to re-sort. See Plugins for a complete list of available plugins.
Syntax
[{UserLookup}] renders as:
| Username | Display Name | Last Login | Active | |
|---|---|---|---|---|
| admin | Administrator | [email protected] | 2026-05-23T20:21:57.290Z | ✓ |
| jim | jim | [email protected] | 2026-05-16T19:53:48.073Z | ✓ |
Parameters
| Parameter | Default | Description |
|---|---|---|
q | *(none)* | Search query — matches against username, display name, or email. Supports $currentUser to search for the logged-in user. |
role | *(none)* | Limit results to users who have this role. |
fields | username,displayName | Columns to show. Use all for every field your account can see, or a comma-separated list: username, displayName, email, roles, lastLogin, isActive. |
max | 50 | Maximum number of rows. Use 0 for unlimited. |
activeOnly | true | Set to false to include inactive accounts. |
Examples
Default — name directory
[{UserLookup}] renders as:
| Username | Display Name | Last Login | Active | |
|---|---|---|---|---|
| admin | Administrator | [email protected] | 2026-05-23T20:21:57.290Z | ✓ |
| jim | jim | [email protected] | 2026-05-16T19:53:48.073Z | ✓ |
Search by name
[{UserLookup q='alice'}] renders as:
No users found.
Your own profile
[{UserLookup q='$currentUser' fields='all'}] renders as:
No users found.
Admins only, with email
[{UserLookup role='admin' fields='username,displayName,email'}] renders as:
| Username | Display Name | |
|---|---|---|
| admin | Administrator | [email protected] |
| jim | jim | [email protected] |
Include inactive accounts
[{UserLookup activeOnly='false' fields='username,displayName,isActive'}] renders as:
| Username | Display Name | Active |
|---|---|---|
| admin | Administrator | ✓ |
| jim | jim | ✓ |
Notes
- Results are sorted by username by default. Click any column heading to re-sort.
- The
email,roles,lastLogin, andisActivefields are only visible to users with theuser-readpermission. Requestingfields='all'returns only the fields your account is permitted to see. $currentUseris replaced with your username before the search runs — it works on shared pages so each visitor sees their own record.- Boolean
isActivedisplays as ✓ (active) or ✗ (inactive). - Roles display as a comma-separated list when a user has more than one.
No comments yet.