function hook_user_cancel in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/user/user.api.php \hook_user_cancel()
2. 7 modules/user/user.api.php \hook_user_cancel()
3. 10 core/modules/user/user.api.php \hook_user_cancel()

Act on user account cancellations.

This hook is invoked from user_cancel() before a user account is canceled. Depending on the account cancellation method, the module should either do nothing, unpublish content, or anonymize content. See user_cancel_methods() for the list of default account cancellation methods provided by User module. Modules may add further methods via hook_user_cancel_methods_alter().

This hook is NOT invoked for the 'user_cancel_delete' account cancellation method. To react to that method, implement hook_ENTITY_TYPE_predelete() or hook_ENTITY_TYPE_delete() for user entities instead.

Expensive operations should be added to the global account cancellation batch by using batch_set().

Parameters

array $edit: The array of form values submitted by the user.

\Drupal\user\UserInterface $account: The user object on which the operation is being performed.

string $method: The account cancellation method.

See also

user_cancel_methods()

hook_user_cancel_methods_alter()

Related topics

3 functions implement hook_user_cancel()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

comment_user_cancel in core/modules/comment/comment.module

Implements hook_user_cancel().

history_user_cancel in core/modules/history/history.module

Implements hook_user_cancel().

node_user_cancel in core/modules/node/node.module

Implements hook_user_cancel().

1 invocation of hook_user_cancel()

user_cancel in core/modules/user/user.module

Cancel a user account.

File

core/modules/user/user.api.php, line 42

Hooks provided by the User module.

Code

function hook_user_cancel($edit, UserInterface $account, $method) {
  switch ($method) {
    case 'user_cancel_block_unpublish':

      // Unpublish nodes (current revisions).
      module_load_include('inc', 'node', 'node.admin');
      $nodes = \Drupal::entityQuery('node')
        ->accessCheck(FALSE)
        ->condition('uid', $account
        ->id())
        ->execute();
      node_mass_update($nodes, [
        'status' => 0,
      ], NULL, TRUE);
      break;
    case 'user_cancel_reassign':

      // Anonymize nodes (current revisions).
      module_load_include('inc', 'node', 'node.admin');
      $nodes = \Drupal::entityQuery('node')
        ->accessCheck(FALSE)
        ->condition('uid', $account
        ->id())
        ->execute();
      node_mass_update($nodes, [
        'uid' => 0,
      ], NULL, TRUE);

      // Anonymize old revisions.
      \Drupal::database()
        ->update('node_field_revision')
        ->fields([
        'uid' => 0,
      ])
        ->condition('uid', $account
        ->id())
        ->execute();
      break;
  }
}