User::getDisplayName

public 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

See also

hook_user_format_name_alter()

File

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

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;
}