API15:JUser/delete

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

Method to delete the JUser object from the database

Syntax

delete()

Returns

boolean True on success

Defined in

libraries/joomla/user/user.php

Importing

jimport( 'joomla.user.user' );

Source Body

function delete( )
{
        JPluginHelper::importPlugin( 'user' );
 
        //trigger the onBeforeDeleteUser event
        $dispatcher =& JDispatcher::getInstance();
        $dispatcher->trigger( 'onBeforeDeleteUser', array( $this->getProperties() ) );
 
        // Create the user table object
        $table  =& $this->getTable();
 
        $result = false;
        if (!$result = $table->delete($this->id)) {
                $this->setError($table->getError());
        }
 
        //trigger the onAfterDeleteUser event
        $dispatcher->trigger( 'onAfterDeleteUser', array( $this->getProperties(), $result, $this->getError()) );
        return $result;
 
}

Examples

<CodeExamplesForm />