mycred_bp_leaderboard_find_position
Description
This filter allows you to adjust or query a users leaderboard position. The myCRED BP Group Leaderboard plugin will cache the users position automatically, which means that this filter only fires when the cache has been deleted and a new query is needed. This means you do not need to check if a cached version exists when this filter runs.
Available since version 1.0
Parameters
Param | Type | Required | Description |
---|---|---|---|
$position |
int | Yes | The users numeric position in the leaderboard. |
$group_id |
int | No | The BuddyPress Group ID. |
$user_id |
int | No | The numeric WordPress user ID. |
$point_type |
string | No | The point type key the leaderboard is based on. |
Used By
Package | Prio. | Description |
---|---|---|
Not used by any built-in package. |
Examples
Example 1: Example showing how we can query a users position in an annual leaderboard.