' . t('About') . '';
$output .= '' . 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 online documentation for the User module.', array('!user_docs' => 'https://drupal.org/documentation/modules/user')) . '
';
$output .= '' . t('Uses') . '
';
$output .= '';
$output .= '- ' . t('Creating and managing users') . '
';
$output .= '- ' . t('Through the People administration page you can add and cancel user accounts and assign users to roles. By editing one particular user you can change their user name, email address, password, and information in other fields.', array('!people' => \Drupal::url('user.admin_account'))) . '
';
$output .= '- ' . t('Configuring user roles') . '
';
$output .= '- ' . t('Roles are used to group and classify users; each user can be assigned one or more roles. Typically there are two pre-defined roles: Anonymous user (users that are not logged in), and Authenticated user (users that are registered and logged in). Depending on how your site was set up, an Administrator 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 Roles administration page.', array('!roles' => \Drupal::url('user.role_list'))) . '
';
$output .= '- ' . t('Setting permissions') . '
';
$output .= '- ' . t('After creating roles, you can set permissions for each role on the Permissions page. 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).', array('!permissions_user' => \Drupal::url('user.admin_permissions'))) . '
';
$output .= '- ' . t('Managing account settings') . '
';
$output .= '- ' . t('The Account settings page 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 (including signatures), 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).', array('!accounts' => \Drupal::url('user.account_settings'))) . '
';
$output .= '- ' . t('Managing user account fields') . '
';
$output .= '- ' . t('Because User accounts are an entity type, you can extend them by adding fields through the Manage fields tab on the Account settings page. 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.', array('!entity_help' => \Drupal::url('help.page', array('name' => 'entity')),'!field_help'=>\Drupal::url('help.page', array('name' => 'field')), '!accounts' => \Drupal::url('user.account_settings'))) . '
';
$output .= '
';
return $output;
case 'user.admin_create':
return '' . t("This web page allows administrators to register new users. Users' email addresses and usernames must be unique.") . '
';
case 'user.admin_permissions':
return '' . 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 Roles 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 Account settings 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.', array('!role' => \Drupal::url('user.role_list'), '!settings' => \Drupal::url('user.account_settings'))) . '
';
case 'user.role_list':
return '' . t('A role defines a group of users that have certain privileges. These privileges are defined on the Permissions page. 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.', array('!permissions' => \Drupal::url('user.admin_permissions'))) . '
';
case 'field_ui.overview_user':
return '' . t('This form lets administrators add and edit fields for storing user data.') . '
';
case 'field_ui.form_display_overview_user':
return '' . t('This form lets administrators configure how form fields should be displayed when editing a user profile.') . '
';
case 'field_ui.display_overview_user':
return '' . t('This form lets administrators configure how fields should be displayed when rendering a user profile page.') . '
';
}
}
/**
* Implements hook_theme().
*/
function user_theme() {
return array(
'user' => array(
'render element' => 'elements',
'file' => 'user.pages.inc',
'template' => 'user',
),
'user_permission_description' => array(
'variables' => array('permission_item' => NULL, 'hide' => NULL),
'file' => 'user.admin.inc',
),
'user_signature' => array(
'variables' => array('signature' => NULL),
),
'username' => array(
'variables' => array('account' => NULL, 'attributes' => array()),
),
);
}
/**
* Implements hook_page_build().
*/
function user_page_build(&$page) {
$path = drupal_get_path('module', 'user');
$page['#attached']['css'][$path . '/css/user.module.css'] = array('every_page' => TRUE);
}
/**
* Implements hook_js_alter().
*/
function user_js_alter(&$javascript) {
// If >=1 JavaScript asset has declared a dependency on drupalSettings, the
// 'settings' key will exist. Thus when that key does not exist, return early.
if (!isset($javascript['settings'])) {
return;
}
// 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();
$javascript['settings']['data'][] = array(
'user' => array(
'uid' => $user->id(),
'permissionsHash' => \Drupal::service('user.permissions_hash')->generate($user),
),
);
}
/**
* Entity URI callback.
*/
function user_uri($user) {
return new Url('user.view', array(
'user' => $user->id(),
));
}
/**
* Populates $entity->account for each prepared entity.
*
* Called by Drupal\Core\Entity\EntityViewBuilderInterface::buildComponents()
* implementations.
*
* @param array &$build
* A renderable array representing the entity content.
* @param \Drupal\user\EntityOwnerInterface[] $entities
* The entities keyed by entity ID.
*/
function user_attach_accounts(array &$build, array $entities) {
$uids = array();
foreach ($entities as $entity) {
$uids[] = $entity->getOwnerId();
}
$uids = array_unique($uids);
$accounts = user_load_multiple($uids);
$anonymous = entity_create('user', array('uid' => 0));
foreach ($entities as $id => $entity) {
if (isset($accounts[$entity->getOwnerId()])) {
$entities[$id]->setOwner($accounts[$entity->getOwnerId()]);
}
else {
$entities[$id]->setOwner($anonymous);
}
}
}
/**
* 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::entityManager()->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'] = array(
'label' => t('User name and password'),
'description' => t('User module account form elements.'),
'weight' => -10,
);
if (\Drupal::config('user.settings')->get('signatures')) {
$fields['user']['user']['form']['signature_settings'] = array(
'label' => t('Signature settings'),
'description' => t('User module form element.'),
'weight' => 1,
);
}
$fields['user']['user']['form']['language'] = array(
'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'] = array(
'label' => t('Timezone'),
'description' => t('System module form element.'),
'weight' => 6,
);
}
$fields['user']['user']['display']['member_for'] = array(
'label' => t('Member for'),
'description' => t('User module \'member for\' view element.'),
'weight' => 5,
);
return $fields;
}
/**
* Loads multiple users based on certain conditions.
*
* This function should be used whenever you need to load more than one user
* from the database. Users are loaded into memory and will not require
* database access if loaded again during the same page request.
*
* @param array $uids
* (optional) An array of entity IDs. If omitted, all entities are loaded.
* @param bool $reset
* A boolean indicating that the internal cache should be reset. Use this if
* loading a user object which has been altered during the page request.
*
* @return array
* An array of user objects, indexed by uid.
*
* @see entity_load_multiple()
* @see user_load()
* @see user_load_by_mail()
* @see user_load_by_name()
* @see \Drupal\Core\Entity\Query\QueryInterface
*
* @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
* Use \Drupal\user\Entity\User::loadMultiple().
*/
function user_load_multiple(array $uids = NULL, $reset = FALSE) {
if ($reset) {
\Drupal::entityManager()->getStorage('user')->resetCache($uids);
}
return User::loadMultiple($uids);
}
/**
* Loads a user object.
*
* Drupal has a global $user object, which represents the currently-logged-in
* user. So to avoid confusion and to avoid clobbering the global $user object,
* it is a good idea to assign the result of this function to a different local
* variable, generally $account. If you actually do want to act as the user you
* are loading, it is essential to call drupal_save_session(FALSE); first.
* See
* @link http://drupal.org/node/218104 Safely impersonating another user @endlink
* for more information.
*
* @param int $uid
* Integer specifying the user ID to load.
* @param bool $reset
* TRUE to reset the internal cache and load from the database; FALSE
* (default) to load from the internal cache, if set.
*
* @return \Drupal\user\UserInterface
* A fully-loaded user object upon successful user load, or NULL if the user
* cannot be loaded.
*
* @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
* Use \Drupal\user\Entity\User::load().
*
* @see user_load_multiple()
*/
function user_load($uid, $reset = FALSE) {
if ($reset) {
\Drupal::entityManager()->getStorage('user')->resetCache(array($uid));
}
return User::load($uid);
}
/**
* 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 user_load_multiple()
*/
function user_load_by_mail($mail) {
$users = entity_load_multiple_by_properties('user', array('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 user_load_multiple()
*/
function user_load_by_name($name) {
$users = entity_load_multiple_by_properties('user', array('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 = DataDefinition::create('string')
->addConstraint('UserName', array());
$data = \Drupal::typedDataManager()->create($definition);
$data->setValue($name);
$violations = $data->validate();
if (count($violations) > 0) {
return $violations[0]->getMessage();
}
}
/**
* Generate a random alphanumeric password.
*/
function user_password($length = 10) {
// This variable contains the list of allowable characters for the
// password. Note that the number 0 and the letter 'O' have been
// removed to avoid confusion between the two. The same is true
// of 'I', 1, and 'l'.
$allowable_characters = 'abcdefghijkmnopqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789';
// Zero-based count of characters in the allowable list:
$len = strlen($allowable_characters) - 1;
// Declare the password as a blank string.
$pass = '';
// Loop the number of times specified by $length.
for ($i = 0; $i < $length; $i++) {
do {
// Find a secure random number within the range needed.
$index = ord(Crypt::randomBytes(1));
} while ($index > $len);
// Each iteration, pick a random character from the
// allowable string and append it to the password:
$pass .= $allowable_characters[$index];
}
return $pass;
}
/**
* 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 = entity_load_multiple('user_role', $roles);
$role_permissions = array();
foreach ($roles as $rid) {
$role_permissions[$rid] = isset($entities[$rid]) ? $entities[$rid]->getPermissions() : array();
}
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 = array();
foreach ($roles as $rid) {
$role_permissions[$rid] = \Drupal::config("user.role.$rid")->get('permissions') ?: array();
}
return $role_permissions;
}
/**
* Determine whether the user has a given privilege.
*
* @param $string
* The permission, such as "administer nodes", being checked for.
* @param \Drupal\Core\Session\AccountInterface $account
* (optional) The account to check, if not given use currently logged in user.
*
* @return bool
* Boolean TRUE if the current user has the requested permission.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Drupal\Core\Session\AccountInterface::hasPermission().
*/
function user_access($string, AccountInterface $account = NULL) {
global $user;
if (!isset($account)) {
// In the installer request session is not set, so we have to fall back
// to the global $user. In all other cases the session key is preferred.
$account = \Drupal::currentUser() ?: $user;
}
return $account->hasPermission($string);
}
/**
* Checks for usernames blocked by user administration.
*
* @param $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')
->condition('name', $name)
->condition('status', 0)
->execute();
}
/**
* Implements hook_permission().
*/
function user_permission() {
return array(
'administer permissions' => array(
'title' => t('Administer permissions'),
'restrict access' => TRUE,
),
'administer account settings' => array(
'title' => t('Administer account settings'),
'description' => t('Configure site-wide settings and behavior for user accounts and registration.', array('@url' => url('admin/config/people'))),
'restrict access' => TRUE,
),
'administer users' => array(
'title' => t('Administer users'),
'restrict access' => TRUE,
),
'access user profiles' => array(
'title' => t('View user profiles'),
),
'change own username' => array(
'title' => t('Change own username'),
),
'cancel account' => array(
'title' => t('Cancel own user account'),
'description' => t('Note: content may be kept, unpublished, deleted or transferred to the %anonymous-name user depending on the configured user settings.', array('%anonymous-name' => \Drupal::config('user.settings')->get('anonymous'), '@user-settings-url' => url('admin/config/people/accounts'))),
),
'select account cancellation method' => array(
'title' => t('Select method for cancelling own account'),
'restrict access' => TRUE,
),
);
}
/**
* Implements hook_user_view().
*/
function user_user_view(array &$build, UserInterface $account, EntityViewDisplayInterface $display) {
if ($display->getComponent('member_for')) {
$build['member_for'] = array(
'#type' => 'item',
'#title' => t('Member for'),
'#markup' => format_interval(REQUEST_TIME - $account->getCreatedTime()),
);
}
}
/**
* Sets the value of the user register and profile forms' langcode element.
*/
function _user_language_selector_langcode_value($element, $input, &$form_state) {
// Only add to the description if the form element have a description.
if (isset($form_state['complete_form']['language']['preferred_langcode']['#description'])) {
$form_state['complete_form']['language']['preferred_langcode']['#description'] .= ' ' . t("This is also assumed to be the primary language of this account's profile information.");
}
return $form_state['values']['preferred_langcode'];
}
/**
* Form validation handler for the current password on the user account form.
*
* @see AccountForm::form()
*/
function user_validate_current_pass(&$form, &$form_state) {
$account = $form_state['user'];
foreach ($form_state['values']['current_pass_required_values'] as $key => $name) {
// This validation only works for required textfields (like mail) or
// form values like password_confirm that have their own validation
// that prevent them from being empty if they are changed.
$current_value = $account->hasField($key) ? $account->get($key)->value : $account->$key;
if ((strlen(trim($form_state['values'][$key])) > 0) && ($form_state['values'][$key] != $current_value)) {
$current_pass_failed = empty($form_state['values']['current_pass']) || !\Drupal::service('password')->check($form_state['values']['current_pass'], $account);
if ($current_pass_failed) {
form_set_error('current_pass', $form_state, t("Your current password is missing or incorrect; it's required to change the %name.", array('%name' => $name)));
form_set_error($key, $form_state);
}
// We only need to check the password once.
break;
}
}
}
/**
* 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;
}
}
}
/**
* Format a username.
*
* @param \Drupal\Core\Session\Interface $account
* The account object for the user whose name is to be formatted.
*
* @return
* An unsanitized string with the username 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.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Drupal\Core\Session\Interface::getUsername().
*/
function user_format_name(AccountInterface $account) {
return $account->getUsername();
}
/**
* 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();
// If this function is called from the installer after Drupal has been
// installed then $user will not be set.
if (!is_object($user)) {
return;
}
$variables['user'] = clone $user;
// Remove password and session IDs, $form_state, 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();
}
/**
* Preprocesses variables for theme_username().
*
* Modules that make any changes to variables like 'name' or 'extra' must ensure
* that the final string is safe to include directly in the output by using
* \Drupal\Component\Utility\String::checkPlain() or
* \Drupal\Component\Utility\Xss::filter().
*/
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 = $variables['name_raw'] = $account->getUsername();
if (drupal_strlen($name) > 20) {
$name = Unicode::truncate($name, 15, FALSE, TRUE);
$variables['truncated'] = TRUE;
}
else {
$variables['truncated'] = FALSE;
}
$variables['name'] = String::checkPlain($name);
$variables['profile_access'] = \Drupal::currentUser()->hasPermission('access user profiles');
// Populate link path and attributes if appropriate.
if ($variables['uid'] && $variables['profile_access']) {
// We are linking to a local user.
$variables['link_options']['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['link_options']['attributes']['rel'] = 'nofollow';
$variables['link_path'] = $account->homepage;
$variables['homepage'] = $account->homepage;
}
// We do not want the l() function to
// \Drupal\Component\Utility\String::checkPlain() a second time.
$variables['link_options']['html'] = TRUE;
// Set a default class.
$variables['link_options']['attributes']['class'] = array('username');
}
/**
* Returns HTML for a username, potentially linked to the user's page.
*
* @param $variables
* An associative array containing:
* - account: The user object to format.
* - name: The user's name, sanitized.
* - truncated: A boolean indicating if $variables['name'] has been shortened.
* - extra: Additional text to append to the user's name, sanitized.
* - link_path: The path or URL of the user's profile page, home page, or
* other desired page to link to for more information about the user.
* - link_options: An array of options to pass to the l() function's $options
* parameter if linking the user's name to the user's page.
* - attributes: An array of attributes to instantiate the
* Drupal\Core\Template\Attribute class if not linking to the user's page.
*
* @see template_preprocess_username()
*/
function theme_username($variables) {
if (isset($variables['link_path'])) {
// We have a link path, so we should generate a link using l().
// Additional classes may be added as array elements like
// $variables['link_options']['attributes']['class'][] = 'myclass';
$output = l($variables['name'] . $variables['extra'], $variables['link_path'], $variables['link_options']);
}
else {
// Modules may have added important attributes so they must be included
// in the output. Additional classes may be added as array elements like
// $variables['attributes']['class'][] = 'myclass';
$output = '' . $variables['name'] . $variables['extra'] . '';
}
return $output;
}
/**
* Implements hook_menu_link_presave().
*/
function user_menu_link_presave(MenuLink $menu_link) {
// The path 'user' must be accessible for anonymous users, but only visible
// for authenticated users. Authenticated users should see "My account", but
// anonymous users should not see it at all. Therefore, invoke
// user_menu_link_load() to conditionally hide the link.
if ($menu_link->machine_name == 'user.page') {
$menu_link->options['alter'] = TRUE;
}
}
/**
* Implements hook_menu_breadcrumb_alter().
*/
function user_menu_breadcrumb_alter(&$active_trail, $item) {
// Remove "My account" from the breadcrumb when $item is descendant-or-self
// of system path user/%.
if (isset($active_trail[1]['module']) && $active_trail[1]['machine_name'] == 'user.page' && strpos($item['path'], 'user/%') === 0) {
array_splice($active_trail, 1, 1);
}
}
/**
* Implements hook_translated_menu_link_alter().
*/
function user_translated_menu_link_alter(MenuLink &$menu_link) {
// Hide the "User account" link for anonymous users.
if ($menu_link->machine_name == 'user.page' && \Drupal::currentUser()->isAnonymous()) {
$menu_link->hidden = 1;
}
}
/**
* Try to validate the user's login credentials locally.
*
* @param $name
* User name to authenticate.
* @param $password
* A plain-text password, such as trimmed text from form values.
* @return
* The user's uid on success, or FALSE on failure to authenticate.
*
* @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
* Use \Drupal\user\UserAuth::authenticate() instead.
*/
function user_authenticate($name, $password) {
return \Drupal::service('user.auth')->authenticate($name, $password);
}
/**
* 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 global $user object is replaced with the passed in account.
*
* @param \Drupal\user\UserInterface $account
* The account to log in.
*
* @see hook_user_login()
*/
function user_login_finalize(UserInterface $account) {
global $user;
$user = $account;
\Drupal::logger('user')->notice('Session opened for %name.', array('%name' => $account->getUsername()));
// 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::entityManager()
->getStorage('user')
->updateLastLoginTimestamp($account);
// Regenerate the session ID to prevent against session fixation attacks.
// This is called before hook_user in case one of those functions fails
// or incorrectly does a redirect which would leave the old session in place.
\Drupal::service('session_manager')->regenerate();
\Drupal::moduleHandler()->invokeAll('user_login', array($account));
}
/**
* Implements hook_user_login().
*/
function user_user_login($account) {
// Reset static cache of default variables in template_preprocess() to reflect
// the new user.
drupal_static_reset('template_preprocess');
}
/**
* Implements hook_user_logout().
*/
function user_user_logout($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 login and reset their password.
*
* @param object $account
* An object containing the user account, which must contain at least the
* following properties:
* - uid: The user ID number.
* - login: The UNIX timestamp of the user's last login.
* @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
* 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 = array()) {
$timestamp = REQUEST_TIME;
$langcode = isset($options['langcode']) ? $options['langcode'] : $account->getPreferredLangcode();
$url_options = array('absolute' => TRUE, 'language' => \Drupal::languageManager()->getLanguage($langcode));
return url("user/reset/" . $account->id() . "/$timestamp/" . user_pass_rehash($account->getPassword(), $timestamp, $account->getLastLoginTime()), $url_options);
}
/**
* Generates a URL to confirm an account cancellation request.
*
* @param object $account
* The user account object, which must contain at least the following
* properties:
* - uid: The user ID number.
* - pass: The hashed user password string.
* - login: The UNIX timestamp of the user's last login.
* @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
* A unique URL that may be used to confirm the cancellation of the user
* account.
*
* @see user_mail_tokens()
* @see user_cancel_confirm()
*/
function user_cancel_url($account, $options = array()) {
$timestamp = REQUEST_TIME;
$langcode = isset($options['langcode']) ? $options['langcode'] : $account->getPreferredLangcode();
$url_options = array('absolute' => TRUE, 'language' => \Drupal::languageManager()->getLanguage($langcode));
return url("user/" . $account->id() . "/cancel/confirm/$timestamp/" . user_pass_rehash($account->getPassword(), $timestamp, $account->getLastLoginTime()), $url_options);
}
/**
* 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 URL
* normally contains both the time stamp and the numeric user ID. The login
* timestamp and hashed password are retrieved from the database as necessary.
* For a usage example, see user_cancel_url() and user_cancel_confirm().
*
* @param string $password
* The hashed user account password value.
* @param int $timestamp
* A UNIX timestamp, typically REQUEST_TIME.
* @param int $login
* The UNIX timestamp of the user's last login.
*
* @return
* A string that is safe for use in URLs and SQL statements.
*/
function user_pass_rehash($password, $timestamp, $login) {
return Crypt::hmacBase64($timestamp . $login, drupal_get_hash_salt() . $password);
}
/**
* 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 $edit
* An array of submitted form values.
* @param $uid
* The user ID of the user account to cancel.
* @param $method
* The account cancellation method to use.
*
* @see _user_cancel()
*/
function user_cancel($edit, $uid, $method) {
$account = user_load($uid);
if (!$account) {
drupal_set_message(t('The user account %id does not exist.', array('%id' => $uid)), 'error');
\Drupal::logger('user')->error('Attempted to cancel non-existing user account: %id.', array('%id' => $uid));
return;
}
// Initialize batch (to set title).
$batch = array(
'title' => t('Cancelling account'),
'operations' => array(),
);
batch_set($batch);
// When the 'user_cancel_delete' method is used, user_delete() is called,
// which invokes hook_user_predelete() and hook_user_delete(). 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', array($edit, $account, $method));
}
// Finish the batch and actually cancel the account.
$batch = array(
'title' => t('Cancelling user account'),
'operations' => array(
array('_user_cancel', array($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['finished'] = '_user_cancel_session_regenerate';
}
batch_set($batch);
// Batch processing is either handled via Form API or has to be invoked
// manually.
}
/**
* Last batch processing 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.
*
* @see user_cancel()
*/
function _user_cancel($edit, $account, $method) {
global $user;
$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_set_message(t('%name has been disabled.', array('%name' => $account->getUsername())));
$logger->notice('Blocked user: %name %email.', array('%name' => $account->getUsername(), '%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_set_message(t('%name has been deleted.', array('%name' => $account->getUsername())));
$logger->notice('Deleted user: %name %email.', array('%name' => $account->getUsername(), '%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() == $user->id()) {
$user = new AnonymousUserSession();
}
}
/**
* 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_manager')->regenerate();
}
/**
* 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 = array(
'user_cancel_block' => array(
'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 user name.'),
),
'user_cancel_block_unpublish' => array(
'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' => array(
'title' => t('Delete the account and make its content belong to the %anonymous-name user.', array('%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.', array('%anonymous-name' => $anonymous_name)),
),
'user_cancel_delete' => array(
'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 = array(
'#options' => array(),
'#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;
}
/**
* Delete a user.
*
* @param $uid
* A user ID.
*/
function user_delete($uid) {
user_delete_multiple(array($uid));
}
/**
* Delete multiple user accounts.
*
* @param $uids
* An array of user IDs.
*
* @see hook_user_predelete()
* @see hook_user_delete()
*/
function user_delete_multiple(array $uids) {
entity_delete_multiple('user', $uids);
}
/**
* Generate an array for rendering the given user.
*
* When viewing a user profile, the $page array contains:
*
* - $page['content']['member_for']:
* Contains the default "Member for" profile data for a user.
* - $page['content']['#user']:
* The user account of the profile being viewed.
*
* To theme user profiles, copy core/modules/user/templates/user.html.twig
* to your theme directory, and edit it as instructed in that file's comments.
*
* @param $account
* A user object.
* @param $view_mode
* View mode, e.g. 'full'.
* @param $langcode
* (optional) A language code to use for rendering. Defaults to the global
* content language of the current request.
*
* @return
* An array as expected by drupal_render().
*/
function user_view($account, $view_mode = 'full', $langcode = NULL) {
return entity_view($account, $view_mode, $langcode);
}
/**
* Constructs a drupal_render() style array from an array of loaded users.
*
* @param $accounts
* An array of user accounts as returned by user_load_multiple().
* @param $view_mode
* (optional) View mode, e.g., 'full', 'teaser'... Defaults to 'teaser.'
* @param $langcode
* (optional) A language code to use for rendering. Defaults to the global
* content language of the current request.
*
* @return
* An array in the format expected by drupal_render().
*/
function user_view_multiple($accounts, $view_mode = 'full', $langcode = NULL) {
return entity_view_multiple($accounts, $view_mode, $langcode);
}
/**
* Implements hook_mail().
*/
function user_mail($key, &$message, $params) {
$token_service = \Drupal::token();
$language_manager = \Drupal::languageManager();
$langcode = $message['langcode'];
$variables = array('user' => $params['account']);
$language = \Drupal::languageManager()->getLanguage($params['account']->getPreferredLangcode());
$original_language = $language_manager->getConfigOverrideLanguage();
$language_manager->setConfigOverrideLanguage($language);
$mail_config = \Drupal::config('user.mail');
// We do not sanitize the token replacement, since the output of this
// replacement is intended for an email message, not a web browser.
$token_options = array('langcode' => $langcode, 'callback' => 'user_mail_tokens', 'sanitize' => FALSE, 'clear' => TRUE);
$message['subject'] .= $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 $replacements
* An associative array variable containing mappings from token names to
* values (for use with strtr()).
* @param $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 $options
* Unused parameter required by \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);
}
}
/*** Administrative features ***********************************************/
/**
* Retrieve an array of roles matching specified conditions.
*
* @param $membersonly
* Set this to TRUE to exclude the 'anonymous' role.
* @param $permission
* A string containing a permission. If set, only roles containing that
* permission are returned.
*
* @return
* 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_user_role_insert().
*/
function user_user_role_insert(RoleInterface $role) {
// Ignore the authenticated and anonymous roles or the role is being synced.
if (in_array($role->id(), array(DRUPAL_AUTHENTICATED_RID, DRUPAL_ANONYMOUS_RID)) || $role->isSyncing()) {
return;
}
$add_id = 'user_add_role_action.' . $role->id();
if (!entity_load('action', $add_id)) {
$action = entity_create('action', array(
'id' => $add_id,
'type' => 'user',
'label' => t('Add the @label role to the selected users', array('@label' => $role->label())),
'configuration' => array(
'rid' => $role->id(),
),
'plugin' => 'user_add_role_action',
));
$action->save();
}
$remove_id = 'user_remove_role_action.' . $role->id();
if (!entity_load('action', $remove_id)) {
$action = entity_create('action', array(
'id' => $remove_id,
'type' => 'user',
'label' => t('Remove the @label role from the selected users', array('@label' => $role->label())),
'configuration' => array(
'rid' => $role->id(),
),
'plugin' => 'user_remove_role_action',
));
$action->save();
}
}
/**
* Implements hook_user_role_delete().
*/
function user_user_role_delete(RoleInterface $role) {
// Ignore the authenticated and anonymous roles or the role is being synced.
if (in_array($role->id(), array(DRUPAL_AUTHENTICATED_RID, DRUPAL_ANONYMOUS_RID)) || $role->isSyncing()) {
return;
}
$actions = entity_load_multiple('action', array(
'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 $membersonly
* Set this to TRUE to exclude the 'anonymous' role.
* @param $permission
* A string containing a permission. If set, only roles containing that
* permission are returned.
*
* @return
* An associative array with the role id as the key and the role object as
* value.
*/
function user_roles($membersonly = FALSE, $permission = NULL) {
$user_roles = &drupal_static(__FUNCTION__);
// Do not cache roles for specific permissions. This data is not requested
// frequently enough to justify the additional memory use.
if (empty($permission)) {
$cid = $membersonly ? DRUPAL_AUTHENTICATED_RID : DRUPAL_ANONYMOUS_RID;
if (isset($user_roles[$cid])) {
return $user_roles[$cid];
}
}
$roles = entity_load_multiple('user_role');
if ($membersonly) {
unset($roles[DRUPAL_ANONYMOUS_RID]);
}
if (!empty($permission)) {
$roles = array_filter($roles, function ($role) use ($permission) {
return $role->hasPermission($permission);
});
}
if (empty($permission)) {
$user_roles[$cid] = $roles;
}
return $roles;
}
/**
* Fetches a user role by role ID.
*
* @param $rid
* A string representing the role ID.
*
* @return
* A fully-loaded role object if a role with the given ID exists, or NULL
* otherwise.
*
* @deprecated in Drupal 8.x, will be removed before Drupal 9.0.
* Use \Drupal\user\Entity\Role::load().
*/
function user_role_load($rid) {
return Role::load($rid);
}
/**
* Determine the modules that permissions belong to.
*
* @return
* An associative array in the format $permission => $module.
*/
function user_permission_get_modules() {
$permissions = array();
foreach (\Drupal::moduleHandler()->getImplementations('permission') as $module) {
$perms = \Drupal::moduleHandler()->invoke($module, 'permission');
foreach ($perms as $key => $value) {
$permissions[$key] = $module;
}
}
return $permissions;
}
/**
* 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 $rid
* The ID of a user role to alter.
* @param $permissions
* 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 = array()) {
// 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 $rid
* The ID of a user role to alter.
* @param $permissions
* 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 = array()) {
// Grant new permissions for the role.
$role = entity_load('user_role', $rid);
foreach ($permissions as $permission) {
$role->grantPermission($permission);
}
$role->save();
}
/**
* Revoke permissions from a user role.
*
* @param $rid
* The ID of a user role to alter.
* @param $permissions
* 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 = array()) {
// Revoke permissions for the role.
$role = entity_load('user_role', $rid);
foreach ($permissions as $permission) {
$role->revokePermission($permission);
}
$role->save();
}
/**
* Returns HTML for a user signature.
*
* @param $variables
* An associative array containing:
* - signature: The user's signature.
*
* @ingroup themeable
*/
function theme_user_signature($variables) {
$signature = $variables['signature'];
$output = '';
if ($signature) {
$output .= '';
$output .= '
—
';
$output .= $signature;
$output .= '