Lecteur Markdown
USERS_DOCUMENTATION_EN
Feature: Users #
Displays a paginated list of registered site members, with filtering by level and multi-criteria sorting. Visible from the administration interface.
---
Installation and Configuration #
Via FTP: Upload the `users/` directory into `/plugins/`.
Via package manager: Select `users` from the available plugins list.
Paths:
- Main plugin: `/plugins/users/users.php`
- Configuration: `/plugins/users/conf/users.conf.inc.php`
- Locales: `/plugins/users/locale/`
Configuration parameters (`users.conf.inc.php`):
| Variable | Default | Description |
|---|---|---|
| `$basedatadisplay` | `'yes'` | Display in management interface |
| `$basedisplevel` | `BASE_LEVEL_USER` | Minimum required level |
| `$ftype` | `4` | Plugin type (community) |
---
Usage #
The plugin displays a member table with the following columns:
- Avatar
- Username (link to profile)
- Access level (coloured badge)
- Registration date
- Last login
Displayed levels:
| Constant | Label |
|---|---|
| `BASE_LEVEL_USER` | User |
| `BASE_LEVEL_HIGHUSER` | High User |
| `BASE_LEVEL_MODERATOR` | Moderator |
| `BASE_LEVEL_ADMIN` | Admin |
| `BASE_LEVEL_OVERMIND` | Overmind |
Email addresses are only visible to users with `WEBMASTER` or `OVERMIND` level.
Available sorting: username, level, last login, registration date.
Filtering: by access level.
---
Hooks and Entry Points #
This plugin registers no hooks. It is invoked directly via URL:
?obj=users.php
?obj=users.php&sort=username&order=asc
?obj=users.php&filter_level=3
---
Dependencies #
- `Beamreactor\Database\SQL` — queries on the users table (`$cfg['dbtable']`)
- `Beamreactor\Sanitizer\Parser` — sanitisation of sort/filter parameters