function NotificationHandler::sendStatusCanceled

Same name and namespace in other branches
  1. 11.x core/modules/user/src/NotificationHandler.php \Drupal\user\NotificationHandler::sendStatusCanceled()

Notifies the user that their account has been canceled.

Parameters

\Drupal\user\UserInterface $account: The entity that represents the user who is being notified.

Return value

bool TRUE if the email has been sent successfully, FALSE if an error occurred or if the sending has been canceled.

File

core/modules/user/src/NotificationHandler.php, line 160

Class

NotificationHandler
Implements a service to dispatch user notification messages.

Namespace

Drupal\user

Code

public function sendStatusCanceled(UserInterface $account) : bool {
  return (bool) $this->sendToUser('status_canceled', $account);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.