Skip to content

Commit

Permalink
Update peoples.md (#520)
Browse files Browse the repository at this point in the history
Fix for issue #470
  • Loading branch information
ant-tar authored Jun 19, 2024
1 parent 7aa5f2b commit 718e60b
Showing 1 changed file with 1 addition and 36 deletions.
37 changes: 1 addition & 36 deletions en/extras/peoples/peoples.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
title: "Peoples"
_old_id: "949"
_old_uri: "revo/peoples/peoples.peoples"
description: "Snippet displays all the Users of a site"
---

## The Peoples Snippet
Expand All @@ -14,40 +13,6 @@ This snippet displays all the Users of a site.

## Available Properties

| Name | Description | Default |
| ---- | ----------------- | -------------------------------------------------------------------------------- |
| 1 | tpl | The Chunk to use for each User. | pplUser |
| 2 | active | 0 to show only inactive Users, 1 to show only active Users, 2 to show all Users. |
| 3 | usergroups | Optional. A comma-separated list of User Group names to filter by. |
| 4 | limit | The number of users to limit per call. Defaults to 10. Set to 0 to show all. |
| 5 | start | The start index to begin with when limiting. |
| 6 | sortBy | The field name to sort by. (Cannot be an extended field.) | username |
| 7 | sortByAlias | The class to use with the sort field. | User |
| 8 | sortDir | The direction to sort by. | ASC |
| 9 | cls | Will append this CSS class to each item. | ppl-user |
| 10 | altCls | Optional. If set, will append this CSS class to every even item. |
| 11 | firstCls | Optional. If set, will append this CSS class to the first item. |
| 12 | lastCls | Optional. If set, will append this CSS class to the last item. |
| 13 | placeholderPrefix | The prefix to use when setting global placeholders, such as total. | peoples. |
| 14 | outputSeparator | The separator between each user record. |
| 15 | toPlaceholder | Optional. If set, will set the output to this placeholder and return empty. |
| 16 | userClass | The class name of the Users object. | modUser |
| 17 | userAlias | The class alias of the Users object. | User |

## Peoples Chunks

The only chunk used in the Peoples snippet is the &tpl property, which uses the default of pplUser.

## Examples

Show all the Users for a site.

``` php
[[Peoples]]
```

## Available Properties

| Name | Description | Default |
| ----------------- | -------------------------------------------------------------------------------- | -------- |
| tpl | The Chunk to use for each User. | pplUser |
Expand Down

0 comments on commit 718e60b

Please sign in to comment.