class User implements ExtenderInterface

Methods

displayNameDriver(string $identifier, string $driver)

Add a display name driver.

permissionGroups(callable|string $callback)

Dynamically process a user's list of groups when calculating permissions.

registerPreference(string $key, callable $transformer = null, $default = null)

Register a new user preference.

extend(Container $container, Extension $extension = null)

No description

Details

displayNameDriver(string $identifier, string $driver)

Add a display name driver.

Parameters

string $identifier Identifier for display name driver. E.g. 'username' for UserNameDriver
string $driver ::class attribute of driver class, which must implement Flarum\User\DisplayName\DriverInterface

permissionGroups(callable|string $callback)

Dynamically process a user's list of groups when calculating permissions.

This can be used to give a user permissions for groups they aren't actually in, based on context. It will not change the group badges displayed for the user.

Parameters

callable|string $callback The callable can be a closure or invokable class, and should accept: - \Flarum\User\User $user: the user in question. - array $groupIds: an array of ids for the groups the user belongs to.</p> <p>The callable should return: - array $groupIds: an array of ids for the groups the user belongs to.

registerPreference(string $key, callable $transformer = null, $default = null)

Register a new user preference.

Parameters

string $key
callable $transformer
$default

extend(Container $container, Extension $extension = null)

Parameters

Container $container
Extension $extension