function UserDataInterface::delete

Same name in other branches
  1. 9 core/modules/user/src/UserDataInterface.php \Drupal\user\UserDataInterface::delete()
  2. 8.9.x core/modules/user/src/UserDataInterface.php \Drupal\user\UserDataInterface::delete()
  3. 10 core/modules/user/src/UserDataInterface.php \Drupal\user\UserDataInterface::delete()

Deletes data stored for a user account.

Parameters

string|array $module: (optional) The name of the module the data is associated with. Can also be an array to delete the data of multiple modules.

int|array $uid: (optional) The user account ID the data is associated with. If omitted, all data for $module is deleted. Can also be an array of IDs to delete the data of multiple user accounts.

string $name: (optional) The name of the data key. If omitted, all data associated with $module and $uid is deleted.

File

core/modules/user/src/UserDataInterface.php, line 62

Class

UserDataInterface
Defines the user data service interface.

Namespace

Drupal\user

Code

public function delete($module = NULL, $uid = NULL, $name = NULL);

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