realname.api.php in Real Name 7

Hooks provided by the Real name module.

File

realname.api.php

<?php

/**
 * @file
 * Hooks provided by the Real name module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Alter the pattern for a user's real name prior to generation.
 *
 * @param string $pattern
 *   The real name pattern string prior to token replacement.
 * @param object $account
 *   A user account object.
 *
 * @see realname_update()
 *
 * @ingroup realname
 */
function hook_realname_pattern_alter(&$pattern, $account) {
}

/**
 * Alter a user's real name before it is saved to the database.
 *
 * @param string $realname
 *   The user's generated real name.
 * @param object $account
 *   A user account object.
 *
 * @see realname_update()
 *
 * @ingroup realname
 */
function hook_realname_alter(&$realname, $account) {
}

/**
 * Respond to updates to an account's real name.
 *
 * @see realname_update()
 *
 * @ingroup realname
 */
function hook_realname_update($realname, $account) {
}

/**
 * @} End of "addtogroup hooks".
 */

Functions

Name	Description
hook_realname_alter	Alter a user's real name before it is saved to the database.
hook_realname_pattern_alter	Alter the pattern for a user's real name prior to generation.
hook_realname_update	Respond to updates to an account's real name.