public function UserDataInterface::delete in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 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.

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 core/modules/user/src/UserData.php

Deletes data stored for a user account.

File

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

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);