Function __global->points_rank
Definitions
sources/points.php
- Get the total number of points the member has received which contribute towards ranks.Some of these points may have already been spent.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: int
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $member_id | MEMBER | No | No | required parameter | N/A | N/A | The member |
| $timestamp | ?TIME | No | No | Null | N/A | N/A | Time to get for (null: now) |
| $cache | boolean | No | No | True | N/A | N/A | Whether to retrieve from the CPF (always false if $timestamp is not null) |
Returns
- The number of points the member has
- Type: integer
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the total number of points the member has received which contribute towards ranks.Some of these points may have already been spent.
*
* @param MEMBER $member_id The member
* @param ?TIME $timestamp Time to get for (null: now)
* @param boolean $cache Whether to retrieve from the CPF (always false if $timestamp is not null)
* @return integer The number of points the member has
*/
function points_rank(int $member_id, ?int $timestamp = null, bool $cache = true) : int
* Get the total number of points the member has received which contribute towards ranks.Some of these points may have already been spent.
*
* @param MEMBER $member_id The member
* @param ?TIME $timestamp Time to get for (null: now)
* @param boolean $cache Whether to retrieve from the CPF (always false if $timestamp is not null)
* @return integer The number of points the member has
*/
function points_rank(int $member_id, ?int $timestamp = null, bool $cache = true) : int
