public function 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.

integer|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.

Return value

void

1 method overrides UserDataInterface::delete()
UserData::delete in drupal/core/modules/user/lib/Drupal/user/UserData.php
Implements \Drupal\user\UserDataInterface::delete().

File

drupal/core/modules/user/lib/Drupal/user/UserDataInterface.php, line 73
Contains Drupal\user\UserDataInterface.

Class

UserDataInterface
Defines the user data service interface.

Namespace

Drupal\user

Code

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