modUser.remove

modUser::remove¶

Removes the User record and wraps the xPDO removal in the two User events. Both events run whenever the xpdo instance is a modX: OnUserRemove fires even when the parent removal returned false, unlike OnUserSave in save().

$ancestors carries the objects already removed in the current chain, which xPDO uses to break circular references. Top-level calls leave it empty.

Syntax¶

boolean remove ([array $ancestors = array()])

• $ancestors (array) Already removed objects, by default array().

Example¶

$user = $modx->getObject('modUser', array('username' => 'foobar'));
$user->remove();

See Also¶

• modUser
• OnUserBeforeRemove
• OnUserRemove