user-options

{user-options}

Plugin: Scaffolding Plugin

Creates a set of list options linking to users matching the filter options.

Description

Must be contained inside a list-data macro.

Usage

{user-options:groups=[group list]|spaces=[space list]|users=[user list]|match=[any|all]}

Parameters

Name Required Default Description
groups
Only users in the specified groups will be listed.
spaces
Only users with the required access to the specified spaces will be listed. Permissions can be specified for each space. You can use '@self' as the spacekey for the current space. Eg:
  • SPACEKEY:view - (default permission) Only users with view access to the SPACEKEY will be listed.
  • SPACEKEY:edit - Only users with edit access to the space will be listed.
  • SPACEKEY:admin - Only users with administration access to the space will be listed.
  • SPACEKEY:blog - Only users who can post a blog (a.k.a. News) message will be listed.
users
Only users specified will be listed.
match
'any'
If set to 'all', the user must match all settings specified.

Sorting and additional filtering (Since 3.2.0)

If you have the Reporting Plugin installed, it is possible to sort and filter the results of {user-options} with any of the 'sort' and 'filter' macros available with that plugin, such as text-sort or number-filter. Just add them inside your {user-options} macro as you would for a 'reporter' macro. Eg:

{list-data:Children}
  {user-options:group=my-group|match=all}
    {text-sort:user:full name}
    {date-filter:signup date|minValue=-1y}
  {user-options}
{list-data}

See Also

Labels

macro macro Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.