API17:JTableUser::delete
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JTableUser::delete|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JTableUser::delete|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function delete ($userId=null) |
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 27: | Line 24: | ||
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' boolean True on success, false on failure. | |
| − | boolean True on success, false on failure. | + | * '''Defined''' on line 314 of libraries/joomla/database/table/user.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/database/table/user.php | + | |
| − | * | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JTableUser::delete source code''' on [[jplatform:database/table/user.php#cl-306|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JTableUser/11.1|JTableUser]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Database/11.1|Database]] | ||
| + | * [[JTableUser::delete|Other versions of JTableUser::delete]] | ||
| + | {{SeeAlso:JTableUser::delete}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JTableUser::delete|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JTableUser::delete|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 48: | Line 44: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JTableUser]][[Category:JTableUser::delete]]</noinclude> | <noinclude>[[Category:JTableUser]][[Category:JTableUser::delete]]</noinclude> | ||
Revision as of 21:50, 27 April 2011
JTableUser::delete
Description
Method to delete a user, user groups, and any other necessary data from the database.
Description:JTableUser::delete [Edit Descripton]
public function delete ($userId=null)
| Parameter | Type | Default | Description |
|---|---|---|---|
| $userId | integer | null | An optional user id. |
- Returns boolean True on success, false on failure.
- Defined on line 314 of libraries/joomla/database/table/user.php
- Since
See also
- JTableUser::delete source code on BitBucket
- Class JTableUser
- Subpackage Database
- Other versions of JTableUser::delete
SeeAlso:JTableUser::delete [Edit See Also]
User contributed notes
<CodeExamplesForm />
