You are here

public function AccountInterface::getDisplayName in Drupal 8

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Session/AccountInterface.php \Drupal\Core\Session\AccountInterface::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.

See also

hook_user_format_name_alter()

3 methods override AccountInterface::getDisplayName()
AccountProxy::getDisplayName in core/lib/Drupal/Core/Session/AccountProxy.php
Returns the display name of this account.
User::getDisplayName in core/modules/user/src/Entity/User.php
Returns the display name of this account.
UserSession::getDisplayName in core/lib/Drupal/Core/Session/UserSession.php
Returns the display name of this account.

File

core/lib/Drupal/Core/Session/AccountInterface.php, line 150

Class

AccountInterface
Defines an account interface which represents the current user.

Namespace

Drupal\Core\Session

Code

public function getDisplayName();