Peoples

\\
{toc}

h2. What is Peoples?

Peoples is a simple User and User Group listing component for MODx Revolution. It can be used in community sites to show who is signed up as a User for a site, and any User Groups within that site.

h3. Requirements

* MODx Revolution 2.0.0 or later
* PHP5 or later

h3. History

Peoples was written by [~splittingred] as a simple user and usergroup listing component, and first released on October 19th, 2010.

Peoples comes with 3 separate snippets:

- [Peoples|Peoples.Peoples] - Displays a list of Users.
- [PeopleGroups|Peoples.PeopleGroups] - Displays a list of User Groups.
- [PeopleGroup|Peoples.PeopleGroup] - Displays a User Group and all Users within.

h2. Usage Examples

List first 10 users, sorted by username.
{code}
[[Peoples]]
{code}

List first 10 user groups, sorted by name.

{code}
[[PeopleGroups]]
{code}

Display the User Group "HR Department", and output the Users in the group to the placeholder 'users':

{code}
[[PeopleGroup? &usergroup=`HR Department` &toPlaceholder=`users`]]

<h2>[[+peoplegroups.name]] ([[+peoplegroups.userCount]] Users)</h2>

[[+users]]
{code}

h2. See Also

{pagetree:root=Peoples}

{scrollbar}