function User::getDisplayName

Same name and namespace in other branches
  1. 9 core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::getDisplayName()
  2. 8.9.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::getDisplayName()
  3. 11.x core/modules/user/src/Entity/User.php \Drupal\user\Entity\User::getDisplayName()

Returns the display name of this account.

By default, the passed-in object's 'name' property is used if it exists, or else, the site-defined value for the 'anonymous' variable. However, a module may override this by implementing hook_user_format_name_alter(&$name, $account).

Return value

string|\Drupal\Component\Render\MarkupInterface Either a string that will be auto-escaped on output or a MarkupInterface object that is already HTML escaped. Either is safe to be printed within HTML fragments.

Overrides AccountInterface::getDisplayName

1 call to User::getDisplayName()
User::label in core/modules/user/src/Entity/User.php
Gets the label of the entity.

File

core/modules/user/src/Entity/User.php, line 401

Class

User
Defines the user entity class.

Namespace

Drupal\user\Entity

Code

public function getDisplayName() {
  $name = $this->getAccountName() ?: \Drupal::config('user.settings')->get('anonymous');
  \Drupal::moduleHandler()->alter('user_format_name', $name, $this);
  return $name;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.