UserPoints ships with ten modules that you can place on any page via the Joomla module manager (Extensions → Modules). All modules are installed automatically with the component.
Actual Points — displays the currently logged-in user's point balance.
Place this module in a prominent position such as a header or sidebar so users always know their balance. If the visitor is a guest the module output is empty by default.
| Parameter | Description |
|---|---|
| Format | Controls the visual presentation: h1, h2, h3, p, or plain text. Choose the heading level that fits the surrounding page design. |
Buy Points — shows a selection of fixed point packages that users can purchase. This module is used when you want to offer pre-defined purchase options rather than letting users type an arbitrary amount.
To use this module, enable Suppress Purchase Details in Configuration so that the standard open-ended purchase form is hidden. Then configure this module with the packages you want to sell.
| Parameter | Description |
|---|---|
| Package list | Define one or more purchase options, each with a label and a price in the configured purchase currency. |
| Module Class Suffix | CSS class suffix appended to the module wrapper for custom styling. |
Coupon Code — displays a form where users can enter a coupon code to earn bonus points.
Place this on the account page or any page where you want to offer coupon redemption. See Coupon Codes for details on creating codes.
| Parameter | Description |
|---|---|
| Module Class Suffix | CSS class suffix for custom styling. |
Last Points Earned By — shows the most recent user to earn points and the rule that awarded them.
Useful as a live-activity indicator to show that the points system is active. Place on a sidebar or dashboard page.
| Parameter | Description |
|---|---|
| Module Class Suffix | CSS class suffix for custom styling. |
Latest Activity — shows a list of the most recent point transactions across all users.
Display this on a community page to create a visible activity feed. Each entry shows the username, the rule name, and the number of points earned.
| Parameter | Description |
|---|---|
| Module Class Suffix | CSS class suffix for custom styling. |
Monthly Statistics — shows a summary of points awarded in the current month.
Use this on an administrator dashboard or a community statistics page to give users a sense of overall activity.
| Parameter | Description |
|---|---|
| Module Class Suffix | CSS class suffix for custom styling. |
Most Active Users — shows a leaderboard of the top point earners.
This is one of the most commonly used modules for gamification sites. Users are ranked by total points. Optionally restrict the leaderboard to a recent date range to reward recent activity rather than cumulative totals.
| Parameter | Description |
|---|---|
| Number of users | How many users to display in the leaderboard. |
| Start date | Optional. Only count points earned on or after this date. |
| End date | Optional. Only count points earned on or before this date. |
| Module Class Suffix | CSS class suffix for custom styling. |
Most Referral Users — shows a leaderboard of users who have referred the most new registrations.
Use this to encourage referral activity by making top referrers visible. Combine with the invite system and referral bonuses for maximum effect.
| Parameter | Description |
|---|---|
| Number of users | How many users to display. |
| Module Class Suffix | CSS class suffix for custom styling. |
Online Users — shows a list of currently online users with their point totals.
Suitable for community sites where knowing who is online adds social value.
| Parameter | Description |
|---|---|
| Number of users | Maximum number of users to display. |
| Module Class Suffix | CSS class suffix for custom styling. |
Points from Start — shows each user's total points earned since the system was installed, including points from activities that have since been purged or archived.
This gives a "lifetime earnings" figure that is higher than the current balance, which can be motivating for users who have spent or had points expire.
| Parameter | Description |
|---|---|
| Include deleted points | Whether to include points from deleted activity records (in addition to purged/archived ones). |
| Module Class Suffix | CSS class suffix for custom styling. |