function theme_username

theme_username($variables)

Returns HTML for a username, potentially linked to the user's page.

Parameters

$variables: An associative array containing:

• account: The user object to format.
• name: The user's name, sanitized.
• extra: Additional text to append to the user's name, sanitized.
• link_path: The path or URL of the user's profile page, home page, or other desired page to link to for more information about the user.
• link_options: An array of options to pass to the l() function's $options parameter if linking the user's name to the user's page.
• attributes_array: An array of attributes to pass to the drupal_attributes() function if not linking to the user's page.

See also

template_preprocess_username()

template_process_username()

Related topics

File

includes/theme.inc, line 2327

The theme system, which controls the output of Drupal.

Code

function theme_username($variables) {
  if (isset($variables['link_path'])) {
    // We have a link path, so we should generate a link using l().
    // Additional classes may be added as array elements like
    // $variables['link_options']['attributes']['class'][] = 'myclass';
    $output = l($variables['name'] . $variables['extra'], $variables['link_path'], $variables['link_options']);
  }
  else {
    // Modules may have added important attributes so they must be included
    // in the output. Additional classes may be added as array elements like
    // $variables['attributes_array']['class'][] = 'myclass';
    $output = '<span' . drupal_attributes($variables['attributes_array']) . '>' . $variables['name'] . $variables['extra'] . '</span>';
  }
  return $output;
}