mycred_user_got_promoted

Codex / mycred/rank / Actions / mycred_user_got_promoted

Description

This action hook fires each time a user has been promoted to a rank that has a higher minimum point requirement set then their previous rank. For demotions, please see the mycred_user_got_demoted action.

In most cases, this action fires during the point payout / deduction process. For this reason, you can not use any function that adds or deducts points from a users account e.g. mycred_add or mycred()->add_creds(). If you do, you will create an infinite loop!

Available since version 1.4

Parameters

Param Type Required Description

Param	Type	Required	Description
`$user_id`	int	No	The ID of the user that is affected by this promotion.
`$rank_id`	int	No	The rank post ID that the user was promoted to.
`$request`	obj	No	The database requests that caused this action to fire. (Added in 1.7). Available details: `rank_id` – The new rank ID the user has reached `current_id` – The ID of the users current rank that they will lose `minimum` – The new ranks set minimum balance requirement `maximum` – The new ranks set maximum balance requirement

$user_id

int

The ID of the user that is affected by this promotion.

$rank_id

int

The rank post ID that the user was promoted to.

$request

obj

The database requests that caused this action to fire. (Added in 1.7).

Available details:

rank_id – The new rank ID the user has reached
current_id – The ID of the users current rank that they will lose
minimum – The new ranks set minimum balance requirement
maximum – The new ranks set maximum balance requirement

Used By

Package	Prio.	Description
Not used by any built-in package.

Example

Example 1: When a user reaches the rank with the ID 123, we give them a 10 point bonus.