You are here

party_user.api.php in Party 8.2

Same filename and directory in other branches
  1. 7 modules/party_user/party_user.api.php

Hooks provided by the Party User module.

File

modules/party_user/party_user.api.php
View source
<?php

/**
 * @file
 * Hooks provided by the Party User module.
 */

/**
 * Act when a user acquires a party.
 *
 * @param Party $party
 *  The Party that has been acquired by the user on registration.
 * @param $user
 *  The user entity of the account that has acquired the party during
 *  registration.
 * @param $method
 *  The acquisition method that was used, can be either 'create' or 'acquire':
 *  - 'create' means a new party has been created for this user.
 *  - 'acquire' means an existing party has been found.
 *
 * @see party_user_user_insert()
 */
function hook_party_user_acquisition($party, $user, $method) {
}

Functions

Namesort descending Description
hook_party_user_acquisition Act when a user acquires a party.