hook_username_alter

  1. drupal
    1. 8
    2. 7
Versions
7 – 8 hook_username_alter(&$name, $account)

Alter the username that is displayed for a user.

Called by format_username() to allow modules to alter the username that's displayed. Can be used to ensure user privacy in situations where $account->name is too revealing.

Parameters

$name The string that format_username() will return.

$account The account object passed to format_username().

See also

format_username()

Related topics

Code

modules/system/system.api.php, line 4056

<?php
function hook_username_alter(&$name, $account) {
  // Display the user's uid instead of name.
  if (isset($account->uid)) {
    $name = t('User !uid', array('!uid' => $account->uid));
  }
}
?>