diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc
index 3d41fcb..a2f1711 100644
--- a/core/includes/bootstrap.inc
+++ b/core/includes/bootstrap.inc
@@ -944,7 +944,7 @@ function drupal_serve_page_from_cache(Response $response, Request $request) {
* variable text such as user names or link URLs into translated text. Variable
* substitution looks like this:
* @code
- * $text = t("@name's blog", array('@name' => user_format_name($account)));
+ * $text = t("@name's blog", array('@name' => $account->getDisplayName()));
* @endcode
* Basically, you can put variables like @name into your string, and t() will
* substitute their sanitized values at translation time. (See the
diff --git a/core/lib/Drupal/Core/Session/AccountInterface.php b/core/lib/Drupal/Core/Session/AccountInterface.php
index b56fe9b..17df07d 100644
--- a/core/lib/Drupal/Core/Session/AccountInterface.php
+++ b/core/lib/Drupal/Core/Session/AccountInterface.php
@@ -112,7 +112,17 @@ public function getPreferredLangcode($default = NULL);
public function getPreferredAdminLangcode($default = NULL);
/**
- * Returns the username of this account.
+ * Returns the unique username of this account.
+ *
+ * @return string
+ * An unsanitized string with the unique username. The code receiving this
+ * result must ensure that \Drupal\Component\Utility\String::checkPlain()
+ * is called on it before it is printed to the page.
+ */
+ public function getUsername();
+
+ /**
+ * 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
@@ -121,13 +131,13 @@ public function getPreferredAdminLangcode($default = NULL);
*
* @see hook_user_format_name_alter()
*
- * @return
- * An unsanitized string with the username to display. The code receiving
+ * @return string
+ * An unsanitized string with the user name to display. The code receiving
* this result must ensure that \Drupal\Component\Utility\String::checkPlain()
* is called on it before it is
* printed to the page.
*/
- public function getUsername();
+ public function getDisplayName();
/**
* Returns the e-mail address of this account.
diff --git a/core/lib/Drupal/Core/Session/AccountProxy.php b/core/lib/Drupal/Core/Session/AccountProxy.php
index 9f00218..7ac446b 100644
--- a/core/lib/Drupal/Core/Session/AccountProxy.php
+++ b/core/lib/Drupal/Core/Session/AccountProxy.php
@@ -166,6 +166,13 @@ public function getUsername() {
/**
* {@inheritdoc}
*/
+ public function getDisplayName() {
+ return $this->getAccount()->getDisplayName();
+ }
+
+ /**
+ * {@inheritdoc}
+ */
public function getEmail() {
return $this->getAccount()->getEmail();
}
diff --git a/core/lib/Drupal/Core/Session/UserSession.php b/core/lib/Drupal/Core/Session/UserSession.php
index 2279f24..7fa92c0 100644
--- a/core/lib/Drupal/Core/Session/UserSession.php
+++ b/core/lib/Drupal/Core/Session/UserSession.php
@@ -217,6 +217,13 @@ function getPreferredAdminLangcode($default = NULL) {
* {@inheritdoc}
*/
public function getUsername() {
+ return $this->name ?: '';
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDisplayName() {
$name = $this->name ?: \Drupal::config('user.settings')->get('anonymous');
\Drupal::moduleHandler()->alter('user_format_name', $name, $this);
return $name;
diff --git a/core/modules/action/src/Plugin/Action/EmailAction.php b/core/modules/action/src/Plugin/Action/EmailAction.php
index 3342fc3..f84207e 100644
--- a/core/modules/action/src/Plugin/Action/EmailAction.php
+++ b/core/modules/action/src/Plugin/Action/EmailAction.php
@@ -135,7 +135,7 @@ public function buildConfigurationForm(array $form, array &$form_state) {
'#default_value' => $this->configuration['message'],
'#cols' => '80',
'#rows' => '20',
- '#description' => t('The message that should be sent. You may include placeholders like [node:title], [user:name], and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'),
+ '#description' => t('The message that should be sent. You may include placeholders like [node:title], [user:name], [user:username] and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'),
);
return $form;
}
diff --git a/core/modules/action/src/Plugin/Action/MessageAction.php b/core/modules/action/src/Plugin/Action/MessageAction.php
index cc15650..aaa29bb 100644
--- a/core/modules/action/src/Plugin/Action/MessageAction.php
+++ b/core/modules/action/src/Plugin/Action/MessageAction.php
@@ -75,7 +75,7 @@ public function buildConfigurationForm(array $form, array &$form_state) {
'#default_value' => $this->configuration['message'],
'#required' => TRUE,
'#rows' => '8',
- '#description' => t('The message to be displayed to the current user. You may include placeholders like [node:title], [user:name], and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'),
+ '#description' => t('The message to be displayed to the current user. You may include placeholders like [node:title], [user:name], [user:username] and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'),
);
return $form;
}
diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module
index 8fc5537..dd3db0c 100644
--- a/core/modules/comment/comment.module
+++ b/core/modules/comment/comment.module
@@ -1255,22 +1255,6 @@ function comment_preview(CommentInterface $comment, array &$form_state) {
if (!form_get_errors($form_state)) {
// Attach the user and time information.
- $author_name = $comment->getAuthorName();
- if (!empty($author_name)) {
- $account = user_load_by_name($author_name);
- }
- elseif (\Drupal::currentUser()->isAuthenticated() && empty($comment->is_anonymous)) {
- $account = \Drupal::currentUser();
- }
-
- if (!empty($account) && $account->isAuthenticated()) {
- $comment->setOwner($account);
- $comment->setAuthorName(check_plain($account->getUsername()));
- }
- elseif (empty($author_name)) {
- $comment->setAuthorName(\Drupal::config('user.settings')->get('anonymous'));
- }
-
$created_time = !is_null($comment->getCreatedTime()) ? $comment->getCreatedTime() : REQUEST_TIME;
$comment->setCreatedTime($created_time);
$comment->changed->value = REQUEST_TIME;
diff --git a/core/modules/comment/src/CommentForm.php b/core/modules/comment/src/CommentForm.php
index 01af9bb..94524c6 100644
--- a/core/modules/comment/src/CommentForm.php
+++ b/core/modules/comment/src/CommentForm.php
@@ -211,9 +211,15 @@ public function form(array $form, array &$form_state) {
'#value' => ($comment->id() ? !$comment->getOwnerId() : $this->currentUser->isAnonymous()),
);
+ // Set the uid on new comments to the current user.
+ $form['uid'] = array(
+ '#type' => 'value',
+ '#value' => $comment->id() ? $comment->getOwnerId() : $this->currentUser->id(),
+ );
+
// Add internal comment properties.
$original = $comment->getUntranslated();
- foreach (array('cid', 'pid', 'entity_id', 'entity_type', 'field_id', 'uid', 'langcode') as $key) {
+ foreach (array('cid', 'pid', 'entity_id', 'entity_type', 'field_id', 'langcode') as $key) {
$key_name = key($comment->$key->getFieldDefinition()->getPropertyDefinitions());
$form[$key] = array('#type' => 'value', '#value' => $original->$key->{$key_name});
}
@@ -313,13 +319,7 @@ public function submit(array $form, array &$form_state) {
/** @var \Drupal\comment\CommentInterface $comment */
$comment = parent::submit($form, $form_state);
- // If the comment was posted by a registered user, assign the author's ID.
- // @todo Too fragile. Should be prepared and stored in comment_form()
- // already.
$author_name = $comment->getAuthorName();
- if (!$comment->is_anonymous && !empty($author_name) && ($account = user_load_by_name($author_name))) {
- $comment->setOwner($account);
- }
// If the comment was posted by an anonymous user and no author name was
// required, use "Anonymous" by default.
if ($comment->is_anonymous && (!isset($author_name) || $author_name === '')) {
diff --git a/core/modules/contact/contact.module b/core/modules/contact/contact.module
index 4f4edae..2098999 100644
--- a/core/modules/contact/contact.module
+++ b/core/modules/contact/contact.module
@@ -129,7 +129,7 @@ function contact_mail($key, &$message, $params) {
'!subject' => $contact_message->getSubject(),
'!category' => !empty($params['contact_category']) ? $params['contact_category']->label() : NULL,
'!form-url' => url(current_path(), array('absolute' => TRUE, 'language' => $language)),
- '!sender-name' => user_format_name($sender),
+ '!sender-name' => $sender->getDisplayName(),
);
if ($sender->isAuthenticated()) {
$variables['!sender-url'] = $sender->url('canonical', array('absolute' => TRUE, 'language' => $language));
@@ -157,7 +157,7 @@ function contact_mail($key, &$message, $params) {
case 'user_mail':
case 'user_copy':
$variables += array(
- '!recipient-name' => user_format_name($params['recipient']),
+ '!recipient-name' => $params['recipient']->getDisplayName(),
'!recipient-edit-url' => url('user/' . $params['recipient']->id() . '/edit', array('absolute' => TRUE, 'language' => $language)),
);
$message['subject'] .= t('[!site-name] !subject', $variables, $options);
diff --git a/core/modules/contact/src/Controller/ContactController.php b/core/modules/contact/src/Controller/ContactController.php
index 4c7a58e..f4a4bad 100644
--- a/core/modules/contact/src/Controller/ContactController.php
+++ b/core/modules/contact/src/Controller/ContactController.php
@@ -116,7 +116,7 @@ public function contactPersonalPage(UserInterface $user) {
));
$form = $this->entityFormBuilder()->getForm($message);
- $form['#title'] = $this->t('Contact @username', array('@username' => $user->getUsername()));
+ $form['#title'] = $this->t('Contact @username', array('@username' => $user->getDisplayName()));
return $form;
}
diff --git a/core/modules/file/src/Tests/FileFieldPathTest.php b/core/modules/file/src/Tests/FileFieldPathTest.php
index 3366b2b..223bc95 100644
--- a/core/modules/file/src/Tests/FileFieldPathTest.php
+++ b/core/modules/file/src/Tests/FileFieldPathTest.php
@@ -62,7 +62,7 @@ function testUploadPath() {
// Do token replacement using the same user which uploaded the file, not
// the user running the test case.
$data = array('user' => $this->admin_user);
- $subdirectory = \Drupal::token()->replace('[user:uid]/[user:name]', $data);
+ $subdirectory = \Drupal::token()->replace('[user:uid]/[user:username]', $data);
$this->assertPathMatch('public://' . $subdirectory . '/' . $test_file->getFilename(), $node_file->getFileUri(), format_string('The file %file was uploaded to the correct path with token replacements.', array('%file' => $node_file->getFileUri())));
}
diff --git a/core/modules/file/src/Tests/FileTokenReplaceTest.php b/core/modules/file/src/Tests/FileTokenReplaceTest.php
index 35bb593..cc77cba 100644
--- a/core/modules/file/src/Tests/FileTokenReplaceTest.php
+++ b/core/modules/file/src/Tests/FileTokenReplaceTest.php
@@ -57,7 +57,7 @@ function testFileTokenReplacement() {
$tests['[file:created:short]'] = format_date($file->getCreatedTime(), 'short', '', NULL, $language_interface->id);
$tests['[file:changed]'] = format_date($file->getChangedTime(), 'medium', '', NULL, $language_interface->id);
$tests['[file:changed:short]'] = format_date($file->getChangedTime(), 'short', '', NULL, $language_interface->id);
- $tests['[file:owner]'] = check_plain(user_format_name($this->admin_user));
+ $tests['[file:owner]'] = check_plain($this->admin_user->getDisplayName());
$tests['[file:owner:uid]'] = $file->getOwnerId();
// Test to make sure that we generated something for each token.
diff --git a/core/modules/forum/forum.module b/core/modules/forum/forum.module
index af041fc..c7751c8 100644
--- a/core/modules/forum/forum.module
+++ b/core/modules/forum/forum.module
@@ -577,7 +577,7 @@ function template_preprocess_forums(&$variables) {
}
$forum_submitted = array('#theme' => 'forum_submitted', '#topic' => (object) array(
'uid' => $topic->getOwnerId(),
- 'name' => $topic->getOwner()->getUsername(),
+ 'name' => $topic->getOwner()->getDisplayName(),
'created' => $topic->getCreatedTime(),
));
$variables['topics'][$id]->submitted = drupal_render($forum_submitted);
diff --git a/core/modules/node/src/Plugin/views/row/Rss.php b/core/modules/node/src/Plugin/views/row/Rss.php
index 2df6281..d57bba5 100644
--- a/core/modules/node/src/Plugin/views/row/Rss.php
+++ b/core/modules/node/src/Plugin/views/row/Rss.php
@@ -119,7 +119,7 @@ public function render($row) {
),
array(
'key' => 'dc:creator',
- 'value' => $node->getOwner()->getUsername(),
+ 'value' => $node->getOwner()->getDisplayName(),
),
array(
'key' => 'guid',
diff --git a/core/modules/rdf/rdf.module b/core/modules/rdf/rdf.module
index dc97773..3268e43 100644
--- a/core/modules/rdf/rdf.module
+++ b/core/modules/rdf/rdf.module
@@ -362,7 +362,7 @@ function rdf_preprocess_user(&$variables) {
'#attributes' => array(
'about' => $account->url(),
'property' => $name_mapping['properties'],
- 'content' => $account->getUsername(),
+ 'content' => $account->getDisplayName(),
'lang' => '',
),
);
diff --git a/core/modules/shortcut/shortcut.admin.inc b/core/modules/shortcut/shortcut.admin.inc
index 2444eec..24e087d 100644
--- a/core/modules/shortcut/shortcut.admin.inc
+++ b/core/modules/shortcut/shortcut.admin.inc
@@ -143,7 +143,7 @@ function shortcut_set_switch_submit($form, &$form_state) {
));
$set->save();
$replacements = array(
- '%user' => $account->getUsername(),
+ '%user' => $account->getDisplayName(),
'%set_name' => $set->label(),
'@switch-url' => url(current_path()),
);
@@ -166,7 +166,7 @@ function shortcut_set_switch_submit($form, &$form_state) {
// Switch to a different shortcut set.
$set = ShortcutSet::load($form_state['values']['set']);
$replacements = array(
- '%user' => $account->getUsername(),
+ '%user' => $account->getDisplayName(),
'%set_name' => $set->label(),
);
drupal_set_message($account->id() == $user->id() ? t('You are now using the %set_name shortcut set.', $replacements) : t('%user is now using the %set_name shortcut set.', $replacements));
diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php
index f842fc0..a2e7f31 100644
--- a/core/modules/system/system.api.php
+++ b/core/modules/system/system.api.php
@@ -1262,7 +1262,7 @@ function hook_mail($key, &$message, $params) {
$context = $params['context'];
$variables = array(
'%site_name' => \Drupal::config('system.site')->get('name'),
- '%username' => user_format_name($account),
+ '%username' => $account->getDisplayName(),
);
if ($context['hook'] == 'taxonomy') {
$entity = $params['entity'];
diff --git a/core/modules/user/config/install/user.mail.yml b/core/modules/user/config/install/user.mail.yml
index ea33738..9f6967f 100644
--- a/core/modules/user/config/install/user.mail.yml
+++ b/core/modules/user/config/install/user.mail.yml
@@ -5,10 +5,10 @@ password_reset:
body: "[user:name],\n\nA request to reset the password for your account has been made at [site:name].\n\nYou may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password. It expires after one day and nothing will happen if it's not used.\n\n-- [site:name] team"
subject: 'Replacement login information for [user:name] at [site:name]'
register_admin_created:
- body: "[user:name],\n\nA site administrator at [site:name] has created an account for you. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team"
+ body: "[user:name],\n\nA site administrator at [site:name] has created an account for you. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:username]\npassword: Your password\n\n-- [site:name] team"
subject: 'An administrator created an account for you at [site:name]'
register_no_approval_required:
- body: "[user:name],\n\nThank you for registering at [site:name]. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team"
+ body: "[user:name],\n\nThank you for registering at [site:name]. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:username]\npassword: Your password\n\n-- [site:name] team"
subject: 'Account details for [user:name] at [site:name]'
register_pending_approval:
body: "[user:name],\n\nThank you for registering at [site:name]. Your application for an account is currently pending approval. Once it has been approved, you will receive another e-mail containing information about how to log in, set your password, and other details.\n\n\n-- [site:name] team"
@@ -17,7 +17,7 @@ register_pending_approval_admin:
body: "[user:name] has applied for an account.\n\n[user:edit-url]"
subject: 'Account details for [user:name] at [site:name] (pending admin approval)'
status_activated:
- body: "[user:name],\n\nYour account at [site:name] has been activated.\n\nYou may now log in by clicking this link or copying and pasting it into your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team"
+ body: "[user:name],\n\nYour account at [site:name] has been activated.\n\nYou may now log in by clicking this link or copying and pasting it into your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:username]\npassword: Your password\n\n-- [site:name] team"
subject: 'Account details for [user:name] at [site:name] (approved)'
status_blocked:
body: "[user:name],\n\nYour account on [site:name] has been blocked.\n\n-- [site:name] team"
diff --git a/core/modules/user/src/AccountSettingsForm.php b/core/modules/user/src/AccountSettingsForm.php
index e29bc26..160f113 100644
--- a/core/modules/user/src/AccountSettingsForm.php
+++ b/core/modules/user/src/AccountSettingsForm.php
@@ -181,7 +181,7 @@ public function buildForm(array $form, array &$form_state) {
);
// These email tokens are shared for all settings, so just define
// the list once to help ensure they stay in sync.
- $email_token_help = $this->t('Available variables are: [site:name], [site:url], [user:name], [user:mail], [site:login-url], [site:url-brief], [user:edit-url], [user:one-time-login-url], [user:cancel-url].');
+ $email_token_help = $this->t('Available variables are: [site:name], [site:url], [user:name], [user:username], [user:mail], [site:login-url], [site:url-brief], [user:edit-url], [user:one-time-login-url], [user:cancel-url].');
$form['email_admin_created'] = array(
'#type' => 'details',
diff --git a/core/modules/user/src/Controller/UserController.php b/core/modules/user/src/Controller/UserController.php
index c27e3c9..09fc8ff 100644
--- a/core/modules/user/src/Controller/UserController.php
+++ b/core/modules/user/src/Controller/UserController.php
@@ -52,7 +52,7 @@ public function userPage(Request $request) {
* The user account name.
*/
public function userTitle(UserInterface $user = NULL) {
- return $user ? Xss::filter($user->getUsername()) : '';
+ return $user ? Xss::filter($user->getDisplayName()) : '';
}
/**
diff --git a/core/modules/user/src/Entity/User.php b/core/modules/user/src/Entity/User.php
index 3cc77b7..6dc19d2 100644
--- a/core/modules/user/src/Entity/User.php
+++ b/core/modules/user/src/Entity/User.php
@@ -425,7 +425,14 @@ public function isAnonymous() {
* {@inheritdoc}
*/
public function getUsername() {
- $name = $this->get('name')->value ?: \Drupal::config('user.settings')->get('anonymous');
+ return $this->get('name')->value ?: '';
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function getDisplayName() {
+ $name = $this->getUsername() ?: \Drupal::config('user.settings')->get('anonymous');
\Drupal::moduleHandler()->alter('user_format_name', $name, $this);
return $name;
}
diff --git a/core/modules/user/src/Plugin/Search/UserSearch.php b/core/modules/user/src/Plugin/Search/UserSearch.php
index ce456b7..fe28da2 100644
--- a/core/modules/user/src/Plugin/Search/UserSearch.php
+++ b/core/modules/user/src/Plugin/Search/UserSearch.php
@@ -139,7 +139,7 @@ public function execute() {
foreach ($accounts as $account) {
$result = array(
- 'title' => $account->getUsername(),
+ 'title' => $account->getDisplayName(),
'link' => url('user/' . $account->id(), array('absolute' => TRUE)),
);
if ($this->currentUser->hasPermission('administer users')) {
diff --git a/core/modules/user/src/Plugin/views/field/Name.php b/core/modules/user/src/Plugin/views/field/Name.php
index 765a4d7..4344797 100644
--- a/core/modules/user/src/Plugin/views/field/Name.php
+++ b/core/modules/user/src/Plugin/views/field/Name.php
@@ -97,7 +97,7 @@ protected function renderLink($data, ResultRow $values) {
}
// If we want a formatted username, do that.
if (!empty($this->options['format_username'])) {
- return user_format_name($account);
+ return $account->getDisplayName();
}
// Otherwise, there's no special handling, so return the data directly.
return $data;
diff --git a/core/modules/user/src/Tests/UserEditedOwnAccountTest.php b/core/modules/user/src/Tests/UserEditedOwnAccountTest.php
index 2437aec..c8d2d0b 100644
--- a/core/modules/user/src/Tests/UserEditedOwnAccountTest.php
+++ b/core/modules/user/src/Tests/UserEditedOwnAccountTest.php
@@ -14,6 +14,13 @@
*/
class UserEditedOwnAccountTest extends WebTestBase {
+ /**
+ * Modules to enable.
+ *
+ * @var array
+ */
+ public static $modules = array('user_form_test');
+
public static function getInfo() {
return array(
'name' => 'User edited own account',
diff --git a/core/modules/user/src/Tests/UserEntityCallbacksTest.php b/core/modules/user/src/Tests/UserEntityCallbacksTest.php
index 2b90534..bd8db2d 100644
--- a/core/modules/user/src/Tests/UserEntityCallbacksTest.php
+++ b/core/modules/user/src/Tests/UserEntityCallbacksTest.php
@@ -19,13 +19,18 @@ class UserEntityCallbacksTest extends WebTestBase {
*
* @var array
*/
- public static $modules = array('user');
+ public static $modules = array('user', 'user_name_test');
/**
* @var \Drupal\user\UserInterface
*/
protected $account;
+ /**
+ * @var \Drupal\user\UserInterface
+ */
+ protected $anonymous;
+
public static function getInfo() {
return array(
'name' => 'User entity callback tests',
@@ -51,6 +56,13 @@ function testLabelCallback() {
$name = $this->randomName();
\Drupal::config('user.settings')->set('anonymous', $name)->save();
$this->assertEqual($this->anonymous->label(), $name, 'The variable anonymous should be used for name of uid 0');
+ $this->assertEqual($this->anonymous->getUserName(), '', 'The raw anonymous user name should be empty string');
+
+ // Set to test the altered username.
+ \Drupal::state()->set('user_name_test_altered_name', 'altered');
+
+ $this->assertEqual($this->account->getDisplayName(), $this->account->name->value . 'altered', 'The user display name should be altered.');
+ $this->assertEqual($this->account->getUsername(), $this->account->name->value, 'The user name should not be altered.');
}
/**
diff --git a/core/modules/user/src/Tests/UserTokenReplaceTest.php b/core/modules/user/src/Tests/UserTokenReplaceTest.php
index c9be29c..decf29a 100644
--- a/core/modules/user/src/Tests/UserTokenReplaceTest.php
+++ b/core/modules/user/src/Tests/UserTokenReplaceTest.php
@@ -62,7 +62,8 @@ function testUserTokenReplacement() {
// Generate and test sanitized tokens.
$tests = array();
$tests['[user:uid]'] = $account->id();
- $tests['[user:name]'] = check_plain(user_format_name($account));
+ $tests['[user:name]'] = check_plain($account->getDisplayName());
+ $tests['[user:username]'] = check_plain($account->getUsername());
$tests['[user:mail]'] = check_plain($account->getEmail());
$tests['[user:url]'] = url("user/" . $account->id(), $url_options);
$tests['[user:edit-url]'] = url("user/" . $account->id() . "/edit", $url_options);
@@ -70,7 +71,8 @@ function testUserTokenReplacement() {
$tests['[user:last-login:short]'] = format_date($account->getLastLoginTime(), 'short', '', NULL, $language_interface->id);
$tests['[user:created]'] = format_date($account->getCreatedTime(), 'medium', '', NULL, $language_interface->id);
$tests['[user:created:short]'] = format_date($account->getCreatedTime(), 'short', '', NULL, $language_interface->id);
- $tests['[current-user:name]'] = check_plain(user_format_name($global_account));
+ $tests['[current-user:name]'] = check_plain($global_account->getDisplayName());
+ $tests['[current-user:username]'] = check_plain($global_account->getUsername());
// Test to make sure that we generated something for each token.
$this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated.');
@@ -81,9 +83,11 @@ function testUserTokenReplacement() {
}
// Generate and test unsanitized tokens.
- $tests['[user:name]'] = user_format_name($account);
+ $tests['[user:name]'] = $account->getDisplayName();
+ $tests['[user:username]'] = $account->getUsername();
$tests['[user:mail]'] = $account->getEmail();
- $tests['[current-user:name]'] = user_format_name($global_account);
+ $tests['[current-user:name]'] = $global_account->getDisplayName();
+ $tests['[current-user:username]'] = $global_account->getUsername();
foreach ($tests as $input => $expected) {
$output = $token_service->replace($input, array('user' => $account), array('langcode' => $language_interface->id, 'sanitize' => FALSE));
diff --git a/core/modules/user/src/UserAutocomplete.php b/core/modules/user/src/UserAutocomplete.php
index c831c78..fb18067 100644
--- a/core/modules/user/src/UserAutocomplete.php
+++ b/core/modules/user/src/UserAutocomplete.php
@@ -91,7 +91,7 @@ public function getMatches($string, $include_anonymous = FALSE) {
$controller = $this->entityManager->getStorage('user');
foreach ($controller->loadMultiple($uids) as $account) {
- $matches[] = array('value' => $account->getUsername(), 'label' => String::checkPlain($account->getUsername()));
+ $matches[] = array('value' => $account->getUsername(), 'label' => String::checkPlain($account->getDisplayName()));
}
}
diff --git a/core/modules/user/tests/modules/user_name_test/user_name_test.info.yml b/core/modules/user/tests/modules/user_name_test/user_name_test.info.yml
new file mode 100644
index 0000000..8a5e1cc
--- /dev/null
+++ b/core/modules/user/tests/modules/user_name_test/user_name_test.info.yml
@@ -0,0 +1,7 @@
+name: 'User name tests'
+type: module
+description: 'Support module for user name testing.'
+package: Testing
+version: VERSION
+core: 8.x
+hidden: true
diff --git a/core/modules/user/tests/modules/user_name_test/user_name_test.module b/core/modules/user/tests/modules/user_name_test/user_name_test.module
new file mode 100644
index 0000000..3603465
--- /dev/null
+++ b/core/modules/user/tests/modules/user_name_test/user_name_test.module
@@ -0,0 +1,12 @@
+get('user_name_test_altered_name');
+}
diff --git a/core/modules/user/user.api.php b/core/modules/user/user.api.php
index ab6e2b6..5f9f8e4 100644
--- a/core/modules/user/user.api.php
+++ b/core/modules/user/user.api.php
@@ -182,17 +182,17 @@ function hook_user_cancel_methods_alter(&$methods) {
/**
* Alter the username that is displayed for a user.
*
- * Called by user_format_name() to allow modules to alter the username that's
+ * Called by $user->getDisplayName() to allow modules to alter the username that's
* displayed. Can be used to ensure user privacy in situations where
* $account->name is too revealing.
*
* @param $name
- * The string that user_format_name() will return.
+ * The string that $user->getDisplayName() will return.
*
* @param $account
- * The account object passed to user_format_name().
+ * The account object.
*
- * @see user_format_name()
+ * @see $account->getDisplayName()
*/
function hook_user_format_name_alter(&$name, $account) {
// Display the user's uid instead of name.
diff --git a/core/modules/user/user.module b/core/modules/user/user.module
index 6473625..b2c63a2 100644
--- a/core/modules/user/user.module
+++ b/core/modules/user/user.module
@@ -590,7 +590,7 @@ function user_preprocess_block(&$variables) {
* Use \Drupal\Core\Session\Interface::getUsername().
*/
function user_format_name(AccountInterface $account) {
- return $account->getUsername();
+ return $account->getDisplayName();
}
/**
@@ -639,7 +639,7 @@ function template_preprocess_username(&$variables) {
// unsanitized version, in case other preprocess functions want to implement
// their own shortening logic or add markup. If they do so, they must ensure
// that $variables['name'] is safe for printing.
- $name = $variables['name_raw'] = $account->getUsername();
+ $name = $variables['name_raw'] = $account->getDisplayName();
if (drupal_strlen($name) > 20) {
$name = Unicode::truncate($name, 15, FALSE, TRUE);
$variables['truncated'] = TRUE;
@@ -965,8 +965,8 @@ function _user_cancel($edit, $account, $method) {
}
$account->block();
$account->save();
- drupal_set_message(t('%name has been disabled.', array('%name' => $account->getUsername())));
- watchdog('user', 'Blocked user: %name %email.', array('%name' => $account->getUsername(), '%email' => '<' . $account->getEmail() . '>'), WATCHDOG_NOTICE);
+ drupal_set_message(t('%name has been disabled.', array('%name' => $account->getDisplayName())));
+ watchdog('user', 'Blocked user: %name %email.', array('%name' => $account->getDisplayName(), '%email' => '<' . $account->getEmail() . '>'), WATCHDOG_NOTICE);
break;
case 'user_cancel_reassign':
@@ -976,8 +976,8 @@ function _user_cancel($edit, $account, $method) {
_user_mail_notify('status_canceled', $account);
}
$account->delete();
- drupal_set_message(t('%name has been deleted.', array('%name' => $account->getUsername())));
- watchdog('user', 'Deleted user: %name %email.', array('%name' => $account->getUsername(), '%email' => '<' . $account->getEmail() . '>'), WATCHDOG_NOTICE);
+ drupal_set_message(t('%name has been deleted.', array('%name' => $account->getDisplayName())));
+ watchdog('user', 'Deleted user: %name %email.', array('%name' => $account->getDisplayName(), '%email' => '<' . $account->getEmail() . '>'), WATCHDOG_NOTICE);
break;
}
@@ -1653,7 +1653,7 @@ function user_toolbar() {
'#type' => 'toolbar_item',
'tab' => array(
'#type' => 'link',
- '#title' => $user->getUsername(),
+ '#title' => $user->getDisplayName(),
'#href' => 'user',
'#attributes' => array(
'title' => t('My account'),
@@ -1687,7 +1687,7 @@ function user_toolbar() {
function user_logout() {
$user = \Drupal::currentUser();
- watchdog('user', 'Session closed for %name.', array('%name' => $user->getUsername()));
+ watchdog('user', 'Session closed for %name.', array('%name' => $user->getDisplayName()));
\Drupal::moduleHandler()->invokeAll('user_logout', array($user));
diff --git a/core/modules/user/user.pages.inc b/core/modules/user/user.pages.inc
index 964323c..2ed76c7 100644
--- a/core/modules/user/user.pages.inc
+++ b/core/modules/user/user.pages.inc
@@ -26,14 +26,14 @@ function user_pass_reset($form, &$form_state, $uid, $timestamp, $hashed_pass, $a
if ($user->isAuthenticated()) {
// The existing user is already logged in.
if ($user->id() == $uid) {
- drupal_set_message(t('You are logged in as %user. Change your password.', array('%user' => $user->getUsername(), '!user_edit' => url("user/" . $user->id() . "/edit"))));
+ drupal_set_message(t('You are logged in as %user. Change your password.', array('%user' => $user->getDisplayName(), '!user_edit' => url("user/" . $user->id() . "/edit"))));
}
// A different user is already logged in on the computer.
else {
$reset_link_account = user_load($uid);
if (!empty($reset_link_account)) {
drupal_set_message(t('Another user (%other_user) is already logged into the site on this computer, but you tried to use a one-time link for user %resetting_user. Please logout and try using the link again.',
- array('%other_user' => $user->getUsername(), '%resetting_user' => $reset_link_account->getUsername(), '!logout' => url('user/logout'))));
+ array('%other_user' => $user->getDisplayName(), '%resetting_user' => $reset_link_account->getDisplayName(), '!logout' => url('user/logout'))));
} else {
// Invalid one-time link specifies an unknown user.
drupal_set_message(t('The one-time login link you clicked is invalid.'));
@@ -60,7 +60,7 @@ function user_pass_reset($form, &$form_state, $uid, $timestamp, $hashed_pass, $a
// user_login_finalize() also updates the login timestamp of the
// user, which invalidates further use of the one-time login link.
user_login_finalize($account);
- watchdog('user', 'User %name used one-time login link at time %timestamp.', array('%name' => $account->getUsername(), '%timestamp' => $timestamp));
+ watchdog('user', 'User %name used one-time login link at time %timestamp.', array('%name' => $account->getDisplayName(), '%timestamp' => $timestamp));
drupal_set_message(t('You have just used your one-time login link. It is no longer necessary to use this link to log in. Please change your password.'));
// Let the user's password be changed without the current password check.
$token = Crypt::randomBytesBase64(55);
@@ -73,10 +73,10 @@ function user_pass_reset($form, &$form_state, $uid, $timestamp, $hashed_pass, $a
else {
if (!$account->getLastLoginTime()) {
// No expiration for first time login.
- $form['message'] = array('#markup' => t('This is a one-time login for %user_name.
Click on this button to log in to the site and change your password.
', array('%user_name' => $account->getUsername())));
+ $form['message'] = array('#markup' => t('This is a one-time login for %user_name.
Click on this button to log in to the site and change your password.
', array('%user_name' => $account->getDisplayName())));
}
else {
- $form['message'] = array('#markup' => t('This is a one-time login for %user_name and will expire on %expiration_date.
Click on this button to log in to the site and change your password.
', array('%user_name' => $account->getUsername(), '%expiration_date' => format_date($timestamp + $timeout))));
+ $form['message'] = array('#markup' => t('This is a one-time login for %user_name and will expire on %expiration_date.
Click on this button to log in to the site and change your password.
', array('%user_name' => $account->getDisplayName(), '%expiration_date' => format_date($timestamp + $timeout))));
}
$form['help'] = array('#markup' => '' . t('This login can be used only once.') . '
');
$form['actions'] = array('#type' => 'actions');
diff --git a/core/modules/user/user.tokens.inc b/core/modules/user/user.tokens.inc
index 80c8bbd..8ab49d3 100644
--- a/core/modules/user/user.tokens.inc
+++ b/core/modules/user/user.tokens.inc
@@ -25,7 +25,11 @@ function user_token_info() {
'description' => t("The unique ID of the user account."),
);
$user['name'] = array(
- 'name' => t("Name"),
+ 'name' => t("Display Name"),
+ 'description' => t("The display name of the user account."),
+ );
+ $user['username'] = array(
+ 'name' => t("Login Name"),
'description' => t("The login name of the user account."),
);
$user['mail'] = array(
@@ -87,10 +91,15 @@ function user_tokens($type, $tokens, array $data = array(), array $options = arr
break;
case 'name':
- $name = user_format_name($account);
+ $name = $account->getDisplayName();
$replacements[$original] = $sanitize ? check_plain($name) : $name;
break;
+ case 'username':
+ $username = $account->getUsername();
+ $replacements[$original] = $sanitize ? check_plain($username) : $username;
+ break;
+
case 'mail':
$replacements[$original] = $sanitize ? check_plain($account->getEmail()) : $account->getEmail();
break;