function UserDataInterface::get
Returns data stored for a user account.
Parameters
string $module: The name of the module the data is associated with.
int $uid: (optional) The user account ID the data is associated with.
string $name: (optional) The name of the data key.
Return value
mixed|array The requested user account data, depending on the arguments passed:
- For $module, $name, and $uid, the stored value is returned, or NULL if no value was found.
- For $module and $uid, an associative array is returned that contains the stored data name/value pairs.
- For $module and $name, an associative array is returned whose keys are user IDs and whose values contain the stored values.
- For $module only, an associative array is returned that contains all existing data for $module in all user accounts, keyed first by user ID and $name second.
File
-
core/
modules/ user/ src/ UserDataInterface.php, line 32
Class
- UserDataInterface
- Defines the user data service interface.
Namespace
Drupal\userCode
public function get($module, $uid = NULL, $name = NULL);