API17

Difference between revisions of "JTableUser::load"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (preparing for archive only)
 
(6 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
Method to load a user, user groups, and any other necessary data from the database so that it can be bound to the user object.  
 
Method to load a user, user groups, and any other necessary data from the database so that it can be bound to the user object.  
  
{{Description:JTableUser::load}}
+
 
<span class="editsection" style="font-size:76%;">
+
 
<nowiki>[</nowiki>[[Description:JTableUser::load|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
===Since===
 
{{JVer|1.0 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JTableUser->load ($userId=null, $reset=true)
+
public function load (
 +
        $userId=null
 +
        $reset=true
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 30:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True on success, false on failure.
boolean True on success, false on failure.
+
* '''Defined''' on line 52 of libraries/joomla/database/table/user.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/database/table/user.php
 
===Referenced by===
 
 
===See also===
 
===See also===
<span class="editsection" style="font-size:76%;">
+
* {{JVer|11.1}} '''JTableUser::load source code''' on [[jplatform:database/table/user.php#cl-44|BitBucket]]
<nowiki>[</nowiki>[[SeeAlso:JTableUser::load|Edit See Also]]<nowiki>]</nowiki>
+
* {{JVer|11.1}} Class [[API17:JTableUser|JTableUser]]
</span>
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Database|Database]]
* [[JTableUser/11.1|JTableUser]]
+
* [[API17:JTableUser::load|Other versions of JTableUser::load]]
* [[JTableUser::load|Other versions of this method]]
+
 
{{SeeAlso:JTableUser::load}}
+
 
===Examples===
+
===User contributed notes===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
noresultsheader=\n
 
noresultsheader=\n
 
category=JTableUser::load
 
category=JTableUser::load
category=CodeExample
+
namespace=CodeExample
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
<noinclude>[[Category:JTableUser]][[Category:JTableUser::load]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 22:51, 24 March 2017

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JTableUser::load[edit]

Description[edit]

Method to load a user, user groups, and any other necessary data from the database so that it can be bound to the user object.


public function load (
        $userId=null
        $reset=true
)
Parameter Type Default Description
$userId integer null An optional user id.
$reset true
  • Returns boolean True on success, false on failure.
  • Defined on line 52 of libraries/joomla/database/table/user.php
  • Since Joomla 11.1

See also[edit]


User contributed notes[edit]

Code Examples[edit]