Actions

API15

JUser/delete

From Joomla! Documentation

< API15:JUser
Revision as of 13:57, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
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.

Contents

Description

Method to delete the JUser object from the database

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

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;
 
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />