modUser.removeLocks

modUser::removeLocks¶

Releases the resource locks this User holds. It reads the locks registry directory, subscribes to /resource/ and pulls every lock message owned by this User. endSession() calls the method with no arguments before the session is destroyed.

$options has no effect: the body never reads it, even though the docblock promises control over lock types. The return value reports whether the scan ran, not whether anything was unlocked. It is false when the xpdo instance is not a modX or the registry service will not load.

Syntax¶

boolean removeLocks ([array $options = array()])

• $options (array) Accepted but unused, by default array().

Example¶

$user->removeLocks();

See Also¶

• modUser
• modUser.endSession