user.module in Drupal 9
Same filename and directory in other branches
Enables the user registration and login system.
File
core/modules/user/user.moduleView source
<?php
/**
* @file
* Enables the user registration and login system.
*/
use Drupal\Component\Utility\Crypt;
use Drupal\Component\Render\PlainTextOutput;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Access\AccessibleInterface;
use Drupal\Core\Asset\AttachedAssetsInterface;
use Drupal\Core\Batch\BatchBuilder;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
use Drupal\Core\Field\BaseFieldDefinition;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\Element;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Session\AnonymousUserSession;
use Drupal\Core\Site\Settings;
use Drupal\Core\Url;
use Drupal\image\Plugin\Field\FieldType\ImageItem;
use Drupal\filter\FilterFormatInterface;
use Drupal\system\Entity\Action;
use Drupal\user\Entity\Role;
use Drupal\user\Entity\User;
use Drupal\user\RoleInterface;
use Drupal\user\UserInterface;
/**
* Implements hook_help().
*/
function user_help($route_name, RouteMatchInterface $route_match) {
switch ($route_name) {
case 'help.page.user':
$output = '';
$output .= '<h3>' . t('About') . '</h3>';
$output .= '<p>' . t('The User module allows users to register, log in, and log out. It also allows users with proper permissions to manage user roles and permissions. For more information, see the <a href=":user_docs">online documentation for the User module</a>.', [
':user_docs' => 'https://www.drupal.org/documentation/modules/user',
]) . '</p>';
$output .= '<h3>' . t('Uses') . '</h3>';
$output .= '<dl>';
$output .= '<dt>' . t('Creating and managing users') . '</dt>';
$output .= '<dd>' . t('Through the <a href=":people">People administration page</a> you can add and cancel user accounts and assign users to roles. By editing one particular user you can change their username, email address, password, and information in other fields.', [
':people' => Url::fromRoute('entity.user.collection')
->toString(),
]) . '</dd>';
$output .= '<dt>' . t('Configuring user roles') . '</dt>';
$output .= '<dd>' . t('<em>Roles</em> are used to group and classify users; each user can be assigned one or more roles. Typically there are two pre-defined roles: <em>Anonymous user</em> (users that are not logged in), and <em>Authenticated user</em> (users that are registered and logged in). Depending on how your site was set up, an <em>Administrator</em> role may also be available: users with this role will automatically be assigned any new permissions whenever a module is enabled. You can create additional roles on the <a href=":roles">Roles administration page</a>.', [
':roles' => Url::fromRoute('entity.user_role.collection')
->toString(),
]) . '</dd>';
$output .= '<dt>' . t('Setting permissions') . '</dt>';
$output .= '<dd>' . t('After creating roles, you can set permissions for each role on the <a href=":permissions_user">Permissions page</a>. Granting a permission allows users who have been assigned a particular role to perform an action on the site, such as viewing content, editing or creating a particular type of content, administering settings for a particular module, or using a particular function of the site (such as search).', [
':permissions_user' => Url::fromRoute('user.admin_permissions')
->toString(),
]) . '</dd>';
$output .= '<dt>' . t('Managing account settings') . '</dt>';
$output .= '<dd>' . t('The <a href=":accounts">Account settings page</a> allows you to manage settings for the displayed name of the Anonymous user role, personal contact forms, user registration settings, and account cancellation settings. On this page you can also manage settings for account personalization, and adapt the text for the email messages that users receive when they register or request a password recovery. You may also set which role is automatically assigned new permissions whenever a module is enabled (the Administrator role).', [
':accounts' => Url::fromRoute('entity.user.admin_form')
->toString(),
]) . '</dd>';
$output .= '<dt>' . t('Managing user account fields') . '</dt>';
$output .= '<dd>' . t('Because User accounts are an entity type, you can extend them by adding fields through the Manage fields tab on the <a href=":accounts">Account settings page</a>. By adding fields for e.g., a picture, a biography, or address, you can a create a custom profile for the users of the website. For background information on entities and fields, see the <a href=":field_help">Field module help page</a>.', [
':field_help' => \Drupal::moduleHandler()
->moduleExists('field') ? Url::fromRoute('help.page', [
'name' => 'field',
])
->toString() : '#',
':accounts' => Url::fromRoute('entity.user.admin_form')
->toString(),
]) . '</dd>';
$output .= '</dl>';
return $output;
case 'user.admin_create':
return '<p>' . t("This web page allows administrators to register new users. Users' email addresses and usernames must be unique.") . '</p>';
case 'user.admin_permissions':
return '<p>' . t('Permissions let you control what users can do and see on your site. You can define a specific set of permissions for each role. (See the <a href=":role">Roles</a> page to create a role.) Any permissions granted to the Authenticated user role will be given to any user who is logged in to your site. From the <a href=":settings">Account settings</a> page, you can make any role into an Administrator role for the site, meaning that role will be granted all new permissions automatically. You should be careful to ensure that only trusted users are given this access and level of control of your site.', [
':role' => Url::fromRoute('entity.user_role.collection')
->toString(),
':settings' => Url::fromRoute('entity.user.admin_form')
->toString(),
]) . '</p>';
case 'entity.user_role.collection':
return '<p>' . t('A role defines a group of users that have certain privileges. These privileges are defined on the <a href=":permissions">Permissions page</a>. Here, you can define the names and the display sort order of the roles on your site. It is recommended to order roles from least permissive (for example, Anonymous user) to most permissive (for example, Administrator user). Users who are not logged in have the Anonymous user role. Users who are logged in have the Authenticated user role, plus any other roles granted to their user account.', [
':permissions' => Url::fromRoute('user.admin_permissions')
->toString(),
]) . '</p>';
case 'entity.user.field_ui_fields':
return '<p>' . t('This form lets administrators add and edit fields for storing user data.') . '</p>';
case 'entity.entity_form_display.user.default':
return '<p>' . t('This form lets administrators configure how form fields should be displayed when editing a user profile.') . '</p>';
case 'entity.entity_view_display.user.default':
return '<p>' . t('This form lets administrators configure how fields should be displayed when rendering a user profile page.') . '</p>';
}
}
/**
* Implements hook_theme().
*/
function user_theme() {
return [
'user' => [
'render element' => 'elements',
],
'username' => [
'variables' => [
'account' => NULL,
'attributes' => [],
'link_options' => [],
],
],
];
}
/**
* Implements hook_js_settings_alter().
*/
function user_js_settings_alter(&$settings, AttachedAssetsInterface $assets) {
// Provide the user ID in drupalSettings to allow JavaScript code to customize
// the experience for the end user, rather than the server side, which would
// break the render cache.
// Similarly, provide a permissions hash, so that permission-dependent data
// can be reliably cached on the client side.
$user = \Drupal::currentUser();
$settings['user']['uid'] = $user
->id();
$settings['user']['permissionsHash'] = \Drupal::service('user_permissions_hash_generator')
->generate($user);
}
/**
* Returns whether this site supports the default user picture feature.
*
* This approach preserves compatibility with node/comment templates. Alternate
* user picture implementations (e.g., Gravatar) should provide their own
* add/edit/delete forms and populate the 'picture' variable during the
* preprocess stage.
*/
function user_picture_enabled() {
$field_definitions = \Drupal::service('entity_field.manager')
->getFieldDefinitions('user', 'user');
return isset($field_definitions['user_picture']);
}
/**
* Implements hook_entity_extra_field_info().
*/
function user_entity_extra_field_info() {
$fields['user']['user']['form']['account'] = [
'label' => t('User name and password'),
'description' => t('User module account form elements.'),
'weight' => -10,
];
$fields['user']['user']['form']['language'] = [
'label' => t('Language settings'),
'description' => t('User module form element.'),
'weight' => 0,
];
if (\Drupal::config('system.date')
->get('timezone.user.configurable')) {
$fields['user']['user']['form']['timezone'] = [
'label' => t('Timezone'),
'description' => t('System module form element.'),
'weight' => 6,
];
}
$fields['user']['user']['display']['member_for'] = [
'label' => t('Member for'),
'description' => t("User module 'member for' view element."),
'weight' => 5,
];
return $fields;
}
/**
* Implements hook_ENTITY_TYPE_presave() for user entities.
*
* @todo https://www.drupal.org/project/drupal/issues/3112704 Move to
* \Drupal\user\Entity\User::preSave().
*/
function user_user_presave(UserInterface $account) {
$config = \Drupal::config('system.date');
if ($config
->get('timezone.user.configurable') && !$account
->getTimeZone() && !$config
->get('timezone.user.default')) {
$account->timezone = $config
->get('timezone.default');
}
}
/**
* Fetches a user object by email address.
*
* @param string $mail
* String with the account's email address.
*
* @return object|bool
* A fully-loaded $user object upon successful user load or FALSE if user
* cannot be loaded.
*
* @see \Drupal\user\Entity\User::loadMultiple()
*/
function user_load_by_mail($mail) {
$users = \Drupal::entityTypeManager()
->getStorage('user')
->loadByProperties([
'mail' => $mail,
]);
return $users ? reset($users) : FALSE;
}
/**
* Fetches a user object by account name.
*
* @param string $name
* String with the account's user name.
*
* @return object|bool
* A fully-loaded $user object upon successful user load or FALSE if user
* cannot be loaded.
*
* @see \Drupal\user\Entity\User::loadMultiple()
*/
function user_load_by_name($name) {
$users = \Drupal::entityTypeManager()
->getStorage('user')
->loadByProperties([
'name' => $name,
]);
return $users ? reset($users) : FALSE;
}
/**
* Verify the syntax of the given name.
*
* @param string $name
* The user name to validate.
*
* @return string|null
* A translated violation message if the name is invalid or NULL if the name
* is valid.
*/
function user_validate_name($name) {
$definition = BaseFieldDefinition::create('string')
->addConstraint('UserName', []);
$data = \Drupal::typedDataManager()
->create($definition);
$data
->setValue($name);
$violations = $data
->validate();
if (count($violations) > 0) {
return $violations[0]
->getMessage();
}
}
/**
* Generate a random alphanumeric password.
*
* @param int $length
* The desired password length, in characters.
*
* @return string
* The generated random password.
*
* @deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use
* \Drupal\Core\Password\PasswordGeneratorInterface::generate() instead.
*
* @see https://www.drupal.org/node/3153113
*/
function user_password($length = 10) {
@trigger_error('user_password() is deprecated in drupal:9.1.0 and is removed from drupal:10.0.0. Use \\Drupal\\Core\\Password\\PasswordGeneratorInterface::generate() instead. See https://www.drupal.org/node/3153113', E_USER_DEPRECATED);
return \Drupal::service('password_generator')
->generate($length);
}
/**
* Determine the permissions for one or more roles.
*
* @param array $roles
* An array of role IDs.
*
* @return array
* An array indexed by role ID. Each value is an array of permission strings
* for the given role.
*/
function user_role_permissions(array $roles) {
if (defined('MAINTENANCE_MODE') && MAINTENANCE_MODE == 'update') {
return _user_role_permissions_update($roles);
}
$entities = Role::loadMultiple($roles);
$role_permissions = [];
foreach ($roles as $rid) {
$role_permissions[$rid] = isset($entities[$rid]) ? $entities[$rid]
->getPermissions() : [];
}
return $role_permissions;
}
/**
* Determine the permissions for one or more roles during update.
*
* A separate version is needed because during update the entity system can't
* be used and in non-update situations the entity system is preferred because
* of the hook system.
*
* @param array $roles
* An array of role IDs.
*
* @return array
* An array indexed by role ID. Each value is an array of permission strings
* for the given role.
*/
function _user_role_permissions_update($roles) {
$role_permissions = [];
foreach ($roles as $rid) {
$role_permissions[$rid] = \Drupal::config("user.role.{$rid}")
->get('permissions') ?: [];
}
return $role_permissions;
}
/**
* Checks for usernames blocked by user administration.
*
* @param string $name
* A string containing a name of the user.
*
* @return bool
* TRUE if the user is blocked, FALSE otherwise.
*/
function user_is_blocked($name) {
return (bool) \Drupal::entityQuery('user')
->accessCheck(FALSE)
->condition('name', $name)
->condition('status', 0)
->execute();
}
/**
* Implements hook_ENTITY_TYPE_view() for user entities.
*/
function user_user_view(array &$build, UserInterface $account, EntityViewDisplayInterface $display) {
if ($display
->getComponent('member_for')) {
$build['member_for'] = [
'#type' => 'item',
'#markup' => '<h4 class="label">' . t('Member for') . '</h4> ' . \Drupal::service('date.formatter')
->formatTimeDiffSince($account
->getCreatedTime()),
];
}
}
/**
* Implements hook_ENTITY_TYPE_view_alter() for user entities.
*
* This function adds a default alt tag to the user_picture field to maintain
* accessibility.
*/
function user_user_view_alter(array &$build, UserInterface $account, EntityViewDisplayInterface $display) {
if (!empty($build['user_picture']) && user_picture_enabled()) {
foreach (Element::children($build['user_picture']) as $key) {
if (!isset($build['user_picture'][$key]['#item']) || !$build['user_picture'][$key]['#item'] instanceof ImageItem) {
// User picture field is provided by standard profile install. If the
// display is configured to use a different formatter, the #item render
// key may not exist, or may not be an image field.
continue;
}
/** @var \Drupal\image\Plugin\Field\FieldType\ImageItem $item */
$item = $build['user_picture'][$key]['#item'];
if (!$item
->get('alt')
->getValue()) {
$item
->get('alt')
->setValue(\Drupal::translation()
->translate('Profile picture for user @username', [
'@username' => $account
->getAccountName(),
]));
}
}
}
}
/**
* Implements hook_preprocess_HOOK() for block templates.
*/
function user_preprocess_block(&$variables) {
if ($variables['configuration']['provider'] == 'user') {
switch ($variables['elements']['#plugin_id']) {
case 'user_login_block':
$variables['attributes']['role'] = 'form';
break;
}
}
}
/**
* Implements hook_template_preprocess_default_variables_alter().
*
* @see user_user_login()
* @see user_user_logout()
*/
function user_template_preprocess_default_variables_alter(&$variables) {
$user = \Drupal::currentUser();
$variables['user'] = clone $user;
// Remove password and session IDs, since themes should not need nor see them.
unset($variables['user']->pass, $variables['user']->sid, $variables['user']->ssid);
$variables['is_admin'] = $user
->hasPermission('access administration pages');
$variables['logged_in'] = $user
->isAuthenticated();
}
/**
* Prepares variables for username templates.
*
* Default template: username.html.twig.
*
* Modules that make any changes to variables like 'name' or 'extra' must ensure
* that the final string is safe.
*
* @param array $variables
* An associative array containing:
* - account: The user account (\Drupal\Core\Session\AccountInterface).
*/
function template_preprocess_username(&$variables) {
$account = $variables['account'] ?: new AnonymousUserSession();
$variables['extra'] = '';
$variables['uid'] = $account
->id();
if (empty($variables['uid'])) {
if (theme_get_setting('features.comment_user_verification')) {
$variables['extra'] = ' (' . t('not verified') . ')';
}
}
// Set the name to a formatted name that is safe for printing and
// that won't break tables by being too long. Keep an unshortened,
// 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 = $account
->getDisplayName();
$variables['name_raw'] = $account
->getAccountName();
if (mb_strlen($name) > 20) {
$name = Unicode::truncate($name, 15, FALSE, TRUE);
$variables['truncated'] = TRUE;
}
else {
$variables['truncated'] = FALSE;
}
$variables['name'] = $name;
if ($account instanceof AccessibleInterface) {
$variables['profile_access'] = $account
->access('view');
}
else {
$variables['profile_access'] = \Drupal::currentUser()
->hasPermission('access user profiles');
}
$external = FALSE;
// Populate link path and attributes if appropriate.
if ($variables['uid'] && $variables['profile_access']) {
// We are linking to a local user.
$variables['attributes']['title'] = t('View user profile.');
$variables['link_path'] = 'user/' . $variables['uid'];
}
elseif (!empty($account->homepage)) {
// Like the 'class' attribute, the 'rel' attribute can hold a
// space-separated set of values, so initialize it as an array to make it
// easier for other preprocess functions to append to it.
$variables['attributes']['rel'] = 'nofollow';
$variables['link_path'] = $account->homepage;
$variables['homepage'] = $account->homepage;
$external = TRUE;
}
// We have a link path, so we should generate a URL.
if (isset($variables['link_path'])) {
if ($external) {
$variables['attributes']['href'] = Url::fromUri($variables['link_path'], $variables['link_options'])
->toString();
}
else {
$variables['attributes']['href'] = Url::fromRoute('entity.user.canonical', [
'user' => $variables['uid'],
])
->toString();
}
}
}
/**
* Finalizes the login process and logs in a user.
*
* The function logs in the user, records a watchdog message about the new
* session, saves the login timestamp, calls hook_user_login(), and generates a
* new session.
*
* The current user is replaced with the passed in account.
*
* @param \Drupal\user\UserInterface $account
* The account to log in.
*
* @see hook_user_login()
* @see \Drupal\user\Authentication\Provider\Cookie
*/
function user_login_finalize(UserInterface $account) {
\Drupal::currentUser()
->setAccount($account);
\Drupal::logger('user')
->notice('Session opened for %name.', [
'%name' => $account
->getAccountName(),
]);
// Update the user table timestamp noting user has logged in.
// This is also used to invalidate one-time login links.
$account
->setLastLoginTime(REQUEST_TIME);
\Drupal::entityTypeManager()
->getStorage('user')
->updateLastLoginTimestamp($account);
// Regenerate the session ID to prevent against session fixation attacks.
// This is called before hook_user_login() in case one of those functions
// fails or incorrectly does a redirect which would leave the old session
// in place.
/** @var \Symfony\Component\HttpFoundation\Session\SessionInterface $session */
$session = \Drupal::service('session');
$session
->migrate();
$session
->set('uid', $account
->id());
$session
->set('check_logged_in', TRUE);
\Drupal::moduleHandler()
->invokeAll('user_login', [
$account,
]);
}
/**
* Implements hook_user_login().
*/
function user_user_login(UserInterface $account) {
// Reset static cache of default variables in template_preprocess() to reflect
// the new user.
drupal_static_reset('template_preprocess');
// If the user has a NULL time zone, notify them to set a time zone.
$config = \Drupal::config('system.date');
if (!$account
->getTimezone() && $config
->get('timezone.user.configurable') && $config
->get('timezone.user.warn')) {
\Drupal::messenger()
->addStatus(t('Configure your <a href=":user-edit">account time zone setting</a>.', [
':user-edit' => $account
->toUrl('edit-form', [
'query' => \Drupal::destination()
->getAsArray(),
'fragment' => 'edit-timezone',
])
->toString(),
]));
}
}
/**
* Implements hook_user_logout().
*/
function user_user_logout(AccountInterface $account) {
// Reset static cache of default variables in template_preprocess() to reflect
// the new user.
drupal_static_reset('template_preprocess');
}
/**
* Generates a unique URL for a user to log in and reset their password.
*
* @param \Drupal\user\UserInterface $account
* An object containing the user account.
* @param array $options
* (optional) A keyed array of settings. Supported options are:
* - langcode: A language code to be used when generating locale-sensitive
* URLs. If langcode is NULL the users preferred language is used.
*
* @return string
* A unique URL that provides a one-time log in for the user, from which
* they can change their password.
*/
function user_pass_reset_url($account, $options = []) {
$timestamp = REQUEST_TIME;
$langcode = isset($options['langcode']) ? $options['langcode'] : $account
->getPreferredLangcode();
return Url::fromRoute('user.reset', [
'uid' => $account
->id(),
'timestamp' => $timestamp,
'hash' => user_pass_rehash($account, $timestamp),
], [
'absolute' => TRUE,
'language' => \Drupal::languageManager()
->getLanguage($langcode),
])
->toString();
}
/**
* Generates a URL to confirm an account cancellation request.
*
* @param \Drupal\user\UserInterface $account
* The user account object.
* @param array $options
* (optional) A keyed array of settings. Supported options are:
* - langcode: A language code to be used when generating locale-sensitive
* URLs. If langcode is NULL the users preferred language is used.
*
* @return string
* A unique URL that may be used to confirm the cancellation of the user
* account.
*
* @see user_mail_tokens()
* @see \Drupal\user\Controller\UserController::confirmCancel()
*/
function user_cancel_url(UserInterface $account, $options = []) {
$timestamp = REQUEST_TIME;
$langcode = isset($options['langcode']) ? $options['langcode'] : $account
->getPreferredLangcode();
$url_options = [
'absolute' => TRUE,
'language' => \Drupal::languageManager()
->getLanguage($langcode),
];
return Url::fromRoute('user.cancel_confirm', [
'user' => $account
->id(),
'timestamp' => $timestamp,
'hashed_pass' => user_pass_rehash($account, $timestamp),
], $url_options)
->toString();
}
/**
* Creates a unique hash value for use in time-dependent per-user URLs.
*
* This hash is normally used to build a unique and secure URL that is sent to
* the user by email for purposes such as resetting the user's password. In
* order to validate the URL, the same hash can be generated again, from the
* same information, and compared to the hash value from the URL. The hash
* contains the time stamp, the user's last login time, the numeric user ID,
* and the user's email address.
* For a usage example, see user_cancel_url() and
* \Drupal\user\Controller\UserController::confirmCancel().
*
* @param \Drupal\user\UserInterface $account
* An object containing the user account.
* @param int $timestamp
* A UNIX timestamp, typically REQUEST_TIME.
*
* @return string
* A string that is safe for use in URLs and SQL statements.
*/
function user_pass_rehash(UserInterface $account, $timestamp) {
$data = $timestamp;
$data .= $account
->getLastLoginTime();
$data .= $account
->id();
$data .= $account
->getEmail();
return Crypt::hmacBase64($data, Settings::getHashSalt() . $account
->getPassword());
}
/**
* Cancel a user account.
*
* Since the user cancellation process needs to be run in a batch, either
* Form API will invoke it, or batch_process() needs to be invoked after calling
* this function and should define the path to redirect to.
*
* @param array $edit
* An array of submitted form values.
* @param int $uid
* The user ID of the user account to cancel.
* @param string $method
* The account cancellation method to use.
*
* @see _user_cancel()
*/
function user_cancel($edit, $uid, $method) {
$account = User::load($uid);
if (!$account) {
\Drupal::messenger()
->addError(t('The user account %id does not exist.', [
'%id' => $uid,
]));
\Drupal::logger('user')
->error('Attempted to cancel non-existing user account: %id.', [
'%id' => $uid,
]);
return;
}
// Initialize batch (to set title).
$batch_builder = (new BatchBuilder())
->setTitle(t('Cancelling account'));
batch_set($batch_builder
->toArray());
// When the 'user_cancel_delete' method is used, user_delete() is called,
// which invokes hook_ENTITY_TYPE_predelete() and hook_ENTITY_TYPE_delete()
// for the user entity. Modules should use those hooks to respond to the
// account deletion.
if ($method != 'user_cancel_delete') {
// Allow modules to add further sets to this batch.
\Drupal::moduleHandler()
->invokeAll('user_cancel', [
$edit,
$account,
$method,
]);
}
// Finish the batch and actually cancel the account.
$batch_builder = (new BatchBuilder())
->setTitle(t('Cancelling user account'))
->addOperation('_user_cancel', [
$edit,
$account,
$method,
]);
// After cancelling account, ensure that user is logged out.
if ($account
->id() == \Drupal::currentUser()
->id()) {
// Batch API stores data in the session, so use the finished operation to
// manipulate the current user's session id.
$batch_builder
->setFinishCallback('_user_cancel_session_regenerate');
}
batch_set($batch_builder
->toArray());
// Batch processing is either handled via Form API or has to be invoked
// manually.
}
/**
* Implements callback_batch_operation().
*
* Last step for cancelling a user account.
*
* Since batch and session API require a valid user account, the actual
* cancellation of a user account needs to happen last.
* @param array $edit
* An array of submitted form values.
* @param \Drupal\user\UserInterface $account
* The user ID of the user account to cancel.
* @param string $method
* The account cancellation method to use.
*
* @see user_cancel()
*/
function _user_cancel($edit, $account, $method) {
$logger = \Drupal::logger('user');
switch ($method) {
case 'user_cancel_block':
case 'user_cancel_block_unpublish':
default:
// Send account blocked notification if option was checked.
if (!empty($edit['user_cancel_notify'])) {
_user_mail_notify('status_blocked', $account);
}
$account
->block();
$account
->save();
\Drupal::messenger()
->addStatus(t('%name has been disabled.', [
'%name' => $account
->getDisplayName(),
]));
$logger
->notice('Blocked user: %name %email.', [
'%name' => $account
->getAccountName(),
'%email' => '<' . $account
->getEmail() . '>',
]);
break;
case 'user_cancel_reassign':
case 'user_cancel_delete':
// Send account canceled notification if option was checked.
if (!empty($edit['user_cancel_notify'])) {
_user_mail_notify('status_canceled', $account);
}
$account
->delete();
\Drupal::messenger()
->addStatus(t('%name has been deleted.', [
'%name' => $account
->getDisplayName(),
]));
$logger
->notice('Deleted user: %name %email.', [
'%name' => $account
->getAccountName(),
'%email' => '<' . $account
->getEmail() . '>',
]);
break;
}
// After cancelling account, ensure that user is logged out. We can't destroy
// their session though, as we might have information in it, and we can't
// regenerate it because batch API uses the session ID, we will regenerate it
// in _user_cancel_session_regenerate().
if ($account
->id() == \Drupal::currentUser()
->id()) {
\Drupal::currentUser()
->setAccount(new AnonymousUserSession());
}
}
/**
* Implements callback_batch_finished().
*
* Finished batch processing callback for cancelling a user account.
*
* @see user_cancel()
*/
function _user_cancel_session_regenerate() {
// Regenerate the users session instead of calling session_destroy() as we
// want to preserve any messages that might have been set.
\Drupal::service('session')
->migrate();
}
/**
* Helper function to return available account cancellation methods.
*
* See documentation of hook_user_cancel_methods_alter().
*
* @return array
* An array containing all account cancellation methods as form elements.
*
* @see hook_user_cancel_methods_alter()
* @see user_admin_settings()
*/
function user_cancel_methods() {
$user_settings = \Drupal::config('user.settings');
$anonymous_name = $user_settings
->get('anonymous');
$methods = [
'user_cancel_block' => [
'title' => t('Disable the account and keep its content.'),
'description' => t('Your account will be blocked and you will no longer be able to log in. All of your content will remain attributed to your username.'),
],
'user_cancel_block_unpublish' => [
'title' => t('Disable the account and unpublish its content.'),
'description' => t('Your account will be blocked and you will no longer be able to log in. All of your content will be hidden from everyone but administrators.'),
],
'user_cancel_reassign' => [
'title' => t('Delete the account and make its content belong to the %anonymous-name user.', [
'%anonymous-name' => $anonymous_name,
]),
'description' => t('Your account will be removed and all account information deleted. All of your content will be assigned to the %anonymous-name user.', [
'%anonymous-name' => $anonymous_name,
]),
],
'user_cancel_delete' => [
'title' => t('Delete the account and its content.'),
'description' => t('Your account will be removed and all account information deleted. All of your content will also be deleted.'),
'access' => \Drupal::currentUser()
->hasPermission('administer users'),
],
];
// Allow modules to customize account cancellation methods.
\Drupal::moduleHandler()
->alter('user_cancel_methods', $methods);
// Turn all methods into real form elements.
$form = [
'#options' => [],
'#default_value' => $user_settings
->get('cancel_method'),
];
foreach ($methods as $name => $method) {
$form['#options'][$name] = $method['title'];
// Add the description for the confirmation form. This description is never
// shown for the cancel method option, only on the confirmation form.
// Therefore, we use a custom #confirm_description property.
if (isset($method['description'])) {
$form[$name]['#confirm_description'] = $method['description'];
}
if (isset($method['access'])) {
$form[$name]['#access'] = $method['access'];
}
}
return $form;
}
/**
* Implements hook_mail().
*/
function user_mail($key, &$message, $params) {
$token_service = \Drupal::token();
$language_manager = \Drupal::languageManager();
$langcode = $message['langcode'];
$variables = [
'user' => $params['account'],
];
$language = $language_manager
->getLanguage($langcode);
$original_language = $language_manager
->getConfigOverrideLanguage();
$language_manager
->setConfigOverrideLanguage($language);
$mail_config = \Drupal::config('user.mail');
$token_options = [
'langcode' => $langcode,
'callback' => 'user_mail_tokens',
'clear' => TRUE,
];
$message['subject'] .= PlainTextOutput::renderFromHtml($token_service
->replace($mail_config
->get($key . '.subject'), $variables, $token_options));
$message['body'][] = $token_service
->replace($mail_config
->get($key . '.body'), $variables, $token_options);
$language_manager
->setConfigOverrideLanguage($original_language);
}
/**
* Token callback to add unsafe tokens for user mails.
*
* This function is used by \Drupal\Core\Utility\Token::replace() to set up
* some additional tokens that can be used in email messages generated by
* user_mail().
*
* @param array $replacements
* An associative array variable containing mappings from token names to
* values (for use with strtr()).
* @param array $data
* An associative array of token replacement values. If the 'user' element
* exists, it must contain a user account object with the following
* properties:
* - login: The UNIX timestamp of the user's last login.
* - pass: The hashed account login password.
* @param array $options
* A keyed array of settings and flags to control the token replacement
* process. See \Drupal\Core\Utility\Token::replace().
*/
function user_mail_tokens(&$replacements, $data, $options) {
if (isset($data['user'])) {
$replacements['[user:one-time-login-url]'] = user_pass_reset_url($data['user'], $options);
$replacements['[user:cancel-url]'] = user_cancel_url($data['user'], $options);
}
}
/**
* Retrieves the names of roles matching specified conditions.
*
* @param bool $membersonly
* (optional) Set this to TRUE to exclude the 'anonymous' role. Defaults to
* FALSE.
* @param string|null $permission
* (optional) A string containing a permission. If set, only roles
* containing that permission are returned. Defaults to NULL, which
* returns all roles.
*
* @return array
* An associative array with the role id as the key and the role name as
* value.
*/
function user_role_names($membersonly = FALSE, $permission = NULL) {
return array_map(function ($item) {
return $item
->label();
}, user_roles($membersonly, $permission));
}
/**
* Implements hook_ENTITY_TYPE_insert() for user_role entities.
*/
function user_user_role_insert(RoleInterface $role) {
// Ignore the authenticated and anonymous roles or the role is being synced.
if (in_array($role
->id(), [
RoleInterface::AUTHENTICATED_ID,
RoleInterface::ANONYMOUS_ID,
]) || $role
->isSyncing()) {
return;
}
$add_id = 'user_add_role_action.' . $role
->id();
if (!Action::load($add_id)) {
$action = Action::create([
'id' => $add_id,
'type' => 'user',
'label' => t('Add the @label role to the selected user(s)', [
'@label' => $role
->label(),
]),
'configuration' => [
'rid' => $role
->id(),
],
'plugin' => 'user_add_role_action',
]);
$action
->trustData()
->save();
}
$remove_id = 'user_remove_role_action.' . $role
->id();
if (!Action::load($remove_id)) {
$action = Action::create([
'id' => $remove_id,
'type' => 'user',
'label' => t('Remove the @label role from the selected user(s)', [
'@label' => $role
->label(),
]),
'configuration' => [
'rid' => $role
->id(),
],
'plugin' => 'user_remove_role_action',
]);
$action
->trustData()
->save();
}
}
/**
* Implements hook_ENTITY_TYPE_delete() for user_role entities.
*/
function user_user_role_delete(RoleInterface $role) {
// Delete role references for all users.
$user_storage = \Drupal::entityTypeManager()
->getStorage('user');
$user_storage
->deleteRoleReferences([
$role
->id(),
]);
// Ignore the authenticated and anonymous roles or the role is being synced.
if (in_array($role
->id(), [
RoleInterface::AUTHENTICATED_ID,
RoleInterface::ANONYMOUS_ID,
]) || $role
->isSyncing()) {
return;
}
$actions = Action::loadMultiple([
'user_add_role_action.' . $role
->id(),
'user_remove_role_action.' . $role
->id(),
]);
foreach ($actions as $action) {
$action
->delete();
}
}
/**
* Retrieve an array of roles matching specified conditions.
*
* @param bool $membersonly
* (optional) Set this to TRUE to exclude the 'anonymous' role. Defaults to
* FALSE.
* @param string|null $permission
* (optional) A string containing a permission. If set, only roles
* containing that permission are returned. Defaults to NULL, which
* returns all roles.
*
* @return \Drupal\user\RoleInterface[]
* An associative array with the role id as the key and the role object as
* value.
*/
function user_roles($membersonly = FALSE, $permission = NULL) {
$roles = Role::loadMultiple();
if ($membersonly) {
unset($roles[RoleInterface::ANONYMOUS_ID]);
}
if (!empty($permission)) {
$roles = array_filter($roles, function ($role) use ($permission) {
return $role
->hasPermission($permission);
});
}
return $roles;
}
/**
* Change permissions for a user role.
*
* This function may be used to grant and revoke multiple permissions at once.
* For example, when a form exposes checkboxes to configure permissions for a
* role, the form submit handler may directly pass the submitted values for the
* checkboxes form element to this function.
*
* @param mixed $rid
* The ID of a user role to alter.
* @param array $permissions
* (optional) An associative array, where the key holds the permission name
* and the value determines whether to grant or revoke that permission. Any
* value that evaluates to TRUE will cause the permission to be granted.
* Any value that evaluates to FALSE will cause the permission to be
* revoked.
* @code
* array(
* 'administer nodes' => 0, // Revoke 'administer nodes'
* 'administer blocks' => FALSE, // Revoke 'administer blocks'
* 'access user profiles' => 1, // Grant 'access user profiles'
* 'access content' => TRUE, // Grant 'access content'
* 'access comments' => 'access comments', // Grant 'access comments'
* )
* @endcode
* Existing permissions are not changed, unless specified in $permissions.
*
* @see user_role_grant_permissions()
* @see user_role_revoke_permissions()
*/
function user_role_change_permissions($rid, array $permissions = []) {
// Grant new permissions for the role.
$grant = array_filter($permissions);
if (!empty($grant)) {
user_role_grant_permissions($rid, array_keys($grant));
}
// Revoke permissions for the role.
$revoke = array_diff_assoc($permissions, $grant);
if (!empty($revoke)) {
user_role_revoke_permissions($rid, array_keys($revoke));
}
}
/**
* Grant permissions to a user role.
*
* @param mixed $rid
* The ID of a user role to alter.
* @param array $permissions
* (optional) A list of permission names to grant.
*
* @see user_role_change_permissions()
* @see user_role_revoke_permissions()
*/
function user_role_grant_permissions($rid, array $permissions = []) {
// Grant new permissions for the role.
if ($role = Role::load($rid)) {
foreach ($permissions as $permission) {
$role
->grantPermission($permission);
}
$role
->trustData()
->save();
}
}
/**
* Revoke permissions from a user role.
*
* @param mixed $rid
* The ID of a user role to alter.
* @param array $permissions
* (optional) A list of permission names to revoke.
*
* @see user_role_change_permissions()
* @see user_role_grant_permissions()
*/
function user_role_revoke_permissions($rid, array $permissions = []) {
// Revoke permissions for the role.
$role = Role::load($rid);
foreach ($permissions as $permission) {
$role
->revokePermission($permission);
}
$role
->trustData()
->save();
}
/**
* Conditionally create and send a notification email when a certain
* operation happens on the given user account.
*
* @param string $op
* The operation being performed on the account. Possible values:
* - 'register_admin_created': Welcome message for user created by the admin.
* - 'register_no_approval_required': Welcome message when user
* self-registers.
* - 'register_pending_approval': Welcome message, user pending admin
* approval.
* - 'password_reset': Password recovery request.
* - 'status_activated': Account activated.
* - 'status_blocked': Account blocked.
* - 'cancel_confirm': Account cancellation request.
* - 'status_canceled': Account canceled.
* @param \Drupal\Core\Session\AccountInterface $account
* The user object of the account being notified. Must contain at
* least the fields 'uid', 'name', and 'mail'.
* @param string $langcode
* (deprecated) (optional) Language code to use for the notification,
* overriding account language. Specifying the notification language using
* the $langcode parameter is deprecated in drupal:9.2.0 and is removed from
* drupal:10.0.0. Omit the parameter. See https://www.drupal.org/node/3187082
*
* @return array
* An array containing various information about the message.
* See \Drupal\Core\Mail\MailManagerInterface::mail() for details.
*
* @see user_mail_tokens()
*/
function _user_mail_notify($op, AccountInterface $account, $langcode = NULL) {
if ($langcode) {
@trigger_error('Specifying the notification language using the $langcode parameter is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Omit the parameter. See https://www.drupal.org/node/3187082', E_USER_DEPRECATED);
}
if (\Drupal::config('user.settings')
->get('notify.' . $op)) {
$params['account'] = $account;
$langcode = $langcode ? $langcode : $account
->getPreferredLangcode();
// Get the custom site notification email to use as the from email address
// if it has been set.
$site_mail = \Drupal::config('system.site')
->get('mail_notification');
// If the custom site notification email has not been set, we use the site
// default for this.
if (empty($site_mail)) {
$site_mail = \Drupal::config('system.site')
->get('mail');
}
if (empty($site_mail)) {
$site_mail = ini_get('sendmail_from');
}
$mail = \Drupal::service('plugin.manager.mail')
->mail('user', $op, $account
->getEmail(), $langcode, $params, $site_mail);
if ($op == 'register_pending_approval') {
// If a user registered requiring admin approval, notify the admin, too.
// We use the site default language for this.
\Drupal::service('plugin.manager.mail')
->mail('user', 'register_pending_approval_admin', $site_mail, \Drupal::languageManager()
->getDefaultLanguage()
->getId(), $params);
}
}
return empty($mail) ? NULL : $mail['result'];
}
/**
* Implements hook_element_info_alter().
*/
function user_element_info_alter(array &$types) {
if (isset($types['password_confirm'])) {
$types['password_confirm']['#process'][] = 'user_form_process_password_confirm';
}
}
/**
* Form element process handler for client-side password validation.
*
* This #process handler is automatically invoked for 'password_confirm' form
* elements to add the JavaScript and string translations for dynamic password
* validation.
*/
function user_form_process_password_confirm($element) {
$password_settings = [
'confirmTitle' => t('Passwords match:'),
'confirmSuccess' => t('yes'),
'confirmFailure' => t('no'),
'showStrengthIndicator' => FALSE,
];
if (\Drupal::config('user.settings')
->get('password_strength')) {
$password_settings['showStrengthIndicator'] = TRUE;
$password_settings += [
'strengthTitle' => t('Password strength:'),
'hasWeaknesses' => t('Recommendations to make your password stronger:'),
'tooShort' => t('Make it at least 12 characters'),
'addLowerCase' => t('Add lowercase letters'),
'addUpperCase' => t('Add uppercase letters'),
'addNumbers' => t('Add numbers'),
'addPunctuation' => t('Add punctuation'),
'sameAsUsername' => t('Make it different from your username'),
'weak' => t('Weak'),
'fair' => t('Fair'),
'good' => t('Good'),
'strong' => t('Strong'),
'username' => \Drupal::currentUser()
->getAccountName(),
];
}
$element['#attached']['library'][] = 'user/drupal.user';
$element['#attached']['drupalSettings']['password'] = $password_settings;
return $element;
}
/**
* Implements hook_modules_uninstalled().
*/
function user_modules_uninstalled($modules) {
// Remove any potentially orphan module data stored for users.
\Drupal::service('user.data')
->delete($modules);
}
/**
* Saves visitor information as a cookie so it can be reused.
*
* @param array $values
* An array of key/value pairs to be saved into a cookie.
*/
function user_cookie_save(array $values) {
foreach ($values as $field => $value) {
// Set cookie for 365 days.
setrawcookie('Drupal.visitor.' . $field, rawurlencode($value), REQUEST_TIME + 31536000, '/');
}
}
/**
* Delete a visitor information cookie.
*
* @param string $cookie_name
* A cookie name such as 'homepage'.
*/
function user_cookie_delete($cookie_name) {
setrawcookie('Drupal.visitor.' . $cookie_name, '', REQUEST_TIME - 3600, '/');
}
/**
* Implements hook_toolbar().
*/
function user_toolbar() {
$user = \Drupal::currentUser();
$items['user'] = [
'#type' => 'toolbar_item',
'tab' => [
'#type' => 'link',
'#title' => $user
->getDisplayName(),
'#url' => Url::fromRoute('user.page'),
'#attributes' => [
'title' => t('My account'),
'class' => [
'toolbar-icon',
'toolbar-icon-user',
],
],
'#cache' => [
// Vary cache for anonymous and authenticated users.
'contexts' => [
'user.roles:anonymous',
],
],
],
'tray' => [
'#heading' => t('User account actions'),
],
'#weight' => 100,
'#attached' => [
'library' => [
'user/drupal.user.icons',
],
],
];
if ($user
->isAnonymous()) {
$links = [
'login' => [
'title' => t('Log in'),
'url' => Url::fromRoute('user.page'),
],
];
$items['user']['tray']['user_links'] = [
'#theme' => 'links__toolbar_user',
'#links' => $links,
'#attributes' => [
'class' => [
'toolbar-menu',
],
],
];
}
else {
$items['user']['tab']['#title'] = [
'#lazy_builder' => [
'user.toolbar_link_builder:renderDisplayName',
[],
],
'#create_placeholder' => TRUE,
];
$items['user']['tray']['user_links'] = [
'#lazy_builder' => [
'user.toolbar_link_builder:renderToolbarLinks',
[],
],
'#create_placeholder' => TRUE,
];
}
return $items;
}
/**
* Logs the current user out.
*/
function user_logout() {
$user = \Drupal::currentUser();
\Drupal::logger('user')
->notice('Session closed for %name.', [
'%name' => $user
->getAccountName(),
]);
\Drupal::moduleHandler()
->invokeAll('user_logout', [
$user,
]);
// Destroy the current session, and reset $user to the anonymous user.
// Note: In Symfony the session is intended to be destroyed with
// Session::invalidate(). Regrettably this method is currently broken and may
// lead to the creation of spurious session records in the database.
// @see https://github.com/symfony/symfony/issues/12375
\Drupal::service('session_manager')
->destroy();
$user
->setAccount(new AnonymousUserSession());
}
/**
* Prepares variables for user templates.
*
* Default template: user.html.twig.
*
* @param array $variables
* An associative array containing:
* - elements: An associative array containing the user information and any
* fields attached to the user. Properties used:
* - #user: A \Drupal\user\Entity\User object. The user account of the
* profile being viewed.
* - attributes: HTML attributes for the containing element.
*/
function template_preprocess_user(&$variables) {
$variables['user'] = $variables['elements']['#user'];
// Helpful $content variable for templates.
foreach (Element::children($variables['elements']) as $key) {
$variables['content'][$key] = $variables['elements'][$key];
}
}
/**
* Implements hook_form_FORM_ID_alter() for \Drupal\system\Form\RegionalForm.
*/
function user_form_system_regional_settings_alter(&$form, FormStateInterface $form_state) {
$config = \Drupal::config('system.date');
$form['timezone']['configurable_timezones'] = [
'#type' => 'checkbox',
'#title' => t('Users may set their own time zone'),
'#default_value' => $config
->get('timezone.user.configurable'),
];
$form['timezone']['configurable_timezones_wrapper'] = [
'#type' => 'container',
'#states' => [
// Hide the user configured timezone settings when users are forced to use
// the default setting.
'invisible' => [
'input[name="configurable_timezones"]' => [
'checked' => FALSE,
],
],
],
];
$form['timezone']['configurable_timezones_wrapper']['empty_timezone_message'] = [
'#type' => 'checkbox',
'#title' => t('Remind users at login if their time zone is not set'),
'#default_value' => $config
->get('timezone.user.warn'),
'#description' => t('Only applied if users may set their own time zone.'),
];
$form['timezone']['configurable_timezones_wrapper']['user_default_timezone'] = [
'#type' => 'radios',
'#title' => t('Time zone for new users'),
'#default_value' => $config
->get('timezone.user.default'),
'#options' => [
UserInterface::TIMEZONE_DEFAULT => t('Default time zone'),
UserInterface::TIMEZONE_EMPTY => t('Empty time zone'),
UserInterface::TIMEZONE_SELECT => t('Users may set their own time zone at registration'),
],
'#description' => t('Only applied if users may set their own time zone.'),
];
$form['#submit'][] = 'user_form_system_regional_settings_submit';
}
/**
* Additional submit handler for \Drupal\system\Form\RegionalForm.
*/
function user_form_system_regional_settings_submit($form, FormStateInterface $form_state) {
\Drupal::configFactory()
->getEditable('system.date')
->set('timezone.user.configurable', $form_state
->getValue('configurable_timezones'))
->set('timezone.user.warn', $form_state
->getValue('empty_timezone_message'))
->set('timezone.user.default', $form_state
->getValue('user_default_timezone'))
->save();
}
/**
* Implements hook_filter_format_disable().
*/
function user_filter_format_disable(FilterFormatInterface $filter_format) {
// Remove the permission from any roles.
$permission = $filter_format
->getPermissionName();
/** @var \Drupal\user\Entity\Role $role */
foreach (Role::loadMultiple() as $role) {
if ($role
->hasPermission($permission)) {
$role
->revokePermission($permission)
->save();
}
}
}Functions
Name |
Description |
|---|---|
| template_preprocess_user | Prepares variables for user templates. |
| template_preprocess_username | Prepares variables for username templates. |
| user_cancel | Cancel a user account. |
| user_cancel_methods | Helper function to return available account cancellation methods. |
| user_cancel_url | Generates a URL to confirm an account cancellation request. |
| user_cookie_delete | Delete a visitor information cookie. |
| user_cookie_save | Saves visitor information as a cookie so it can be reused. |
| user_element_info_alter | Implements hook_element_info_alter(). |
| user_entity_extra_field_info | Implements hook_entity_extra_field_info(). |
| user_filter_format_disable | Implements hook_filter_format_disable(). |
| user_form_process_password_confirm | Form element process handler for client-side password validation. |
| user_form_system_regional_settings_alter | Implements hook_form_FORM_ID_alter() for \Drupal\system\Form\RegionalForm. |
| user_form_system_regional_settings_submit | Additional submit handler for \Drupal\system\Form\RegionalForm. |
| user_help | Implements hook_help(). |
| user_is_blocked | Checks for usernames blocked by user administration. |
| user_js_settings_alter | Implements hook_js_settings_alter(). |
| user_load_by_mail | Fetches a user object by email address. |
| user_load_by_name | Fetches a user object by account name. |
| user_login_finalize | Finalizes the login process and logs in a user. |
| user_logout | Logs the current user out. |
| user_mail | Implements hook_mail(). |
| user_mail_tokens | Token callback to add unsafe tokens for user mails. |
| user_modules_uninstalled | Implements hook_modules_uninstalled(). |
| user_password Deprecated | Generate a random alphanumeric password. |
| user_pass_rehash | Creates a unique hash value for use in time-dependent per-user URLs. |
| user_pass_reset_url | Generates a unique URL for a user to log in and reset their password. |
| user_picture_enabled | Returns whether this site supports the default user picture feature. |
| user_preprocess_block | Implements hook_preprocess_HOOK() for block templates. |
| user_roles | Retrieve an array of roles matching specified conditions. |
| user_role_change_permissions | Change permissions for a user role. |
| user_role_grant_permissions | Grant permissions to a user role. |
| user_role_names | Retrieves the names of roles matching specified conditions. |
| user_role_permissions | Determine the permissions for one or more roles. |
| user_role_revoke_permissions | Revoke permissions from a user role. |
| user_template_preprocess_default_variables_alter | Implements hook_template_preprocess_default_variables_alter(). |
| user_theme | Implements hook_theme(). |
| user_toolbar | Implements hook_toolbar(). |
| user_user_login | Implements hook_user_login(). |
| user_user_logout | Implements hook_user_logout(). |
| user_user_presave | Implements hook_ENTITY_TYPE_presave() for user entities. |
| user_user_role_delete | Implements hook_ENTITY_TYPE_delete() for user_role entities. |
| user_user_role_insert | Implements hook_ENTITY_TYPE_insert() for user_role entities. |
| user_user_view | Implements hook_ENTITY_TYPE_view() for user entities. |
| user_user_view_alter | Implements hook_ENTITY_TYPE_view_alter() for user entities. |
| user_validate_name | Verify the syntax of the given name. |
| _user_cancel | Implements callback_batch_operation(). |
| _user_cancel_session_regenerate | Implements callback_batch_finished(). |
| _user_mail_notify | Conditionally create and send a notification email when a certain operation happens on the given user account. |
| _user_role_permissions_update | Determine the permissions for one or more roles during update. |