Using UserLookupPlugin

Last modified: 4/23/2026

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:

UsernameDisplay NameEmailLast LoginActive
adminAdministrator[email protected]2026-05-23T20:21:57.290Z
jimjim[email protected]2026-05-16T19:53:48.073Z

Parameters

ParameterDefaultDescription
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.
fieldsusername,displayNameColumns to show. Use all for every field your account can see, or a comma-separated list: username, displayName, email, roles, lastLogin, isActive.
max50Maximum number of rows. Use 0 for unlimited.
activeOnlytrueSet to false to include inactive accounts.

Examples

Default — name directory

[{UserLookup}] renders as:

UsernameDisplay NameEmailLast LoginActive
adminAdministrator[email protected]2026-05-23T20:21:57.290Z
jimjim[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:

UsernameDisplay NameEmail
adminAdministrator[email protected]
jimjim[email protected]

Include inactive accounts

[{UserLookup activeOnly='false' fields='username,displayName,isActive'}] renders as:

UsernameDisplay NameActive
adminAdministrator
jimjim

Notes