function hook_user_view

You are here

7 user.api.php hook_user_view($account, $view_mode, $langcode)
8 user.api.php hook_user_view(\Drupal\user\UserInterface $account, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode)

The user's account information is being displayed.

The module should format its custom additions for display and add them to the $account->content array.

Note that when this hook is invoked, the changes have not yet been written to the database, because a database transaction is still in progress. The transaction is not finalized until the save operation is entirely completed and user_save() goes out of scope. You should not rely on data in the database at this time as it is not updated yet. You should also note that any write/update database queries executed from this hook are also not committed immediately. Check user_save() and db_transaction() for more info.

Parameters

$account: The user object on which the operation is being performed.

$view_mode: View mode, e.g. 'full'.

$langcode: The language code used for rendering.

See also

hook_user_view_alter()

hook_entity_view()

Related topics

4 functions implement hook_user_view()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

blog_user_view in modules/blog/blog.module
Implements hook_user_view().
profile_user_view in modules/profile/profile.module
Implements hook_user_view().
trigger_user_view in modules/trigger/trigger.module
Implements hook_user_view().
user_user_view in modules/user/user.module
Implements hook_user_view().
4 invocations of hook_user_view()
field_attach_view in modules/field/field.attach.inc
Returns a renderable array for the fields on an entity.
field_view_field in modules/field/field.module
Returns a renderable array for the value of a single field in an entity.
node_build_content in modules/node/node.module
Builds a structured array representing the node's content.
user_build_content in modules/user/user.module
Builds a structured array representing the profile content.

File

modules/user/user.api.php, line 348
Hooks provided by the User module.

Code

function hook_user_view($account, $view_mode, $langcode) {
  if (user_access('create blog content', $account)) {
    $account->content['summary']['blog'] = array(
      '#type' => 'user_profile_item',
      '#title' => t('Blog'),
      '#markup' => l(t('View recent blog entries'), "blog/$account->uid", array('attributes' => array('title' => t("Read !username's latest blog entries.", array('!username' => format_username($account)))))),
      '#attributes' => array('class' => array('blog')),
    );
  }
}

Comments

/**
* Implements hook_user_view().
*/
function me_user_view($account, $view_mode) {
  if (me_variable_get('me_user_override')) {
    $enabled = 'enabled';
    if (!empty($account->me_disable)) {
      $enabled = 'disabled';
    }

    $account->content['me'] = array(
      '#type' => 'markup',
      '#value' => t("'%me' aliases are $enabled for this account. Account user id is '@uid'.",
            array('%me' => _me_get_me_alias(TRUE), '@uid' => $account->uid)),
      '#weight' => 10,
    );
  }
}