Actions

API15

JUser/load

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 load a JUser object by user id number

[<! removed edit link to red link >]

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

Syntax

load($id)
Parameter Name Default Value Description
$id $identifier The user id of the user to load

Returns

boolean True on success

Defined in

libraries/joomla/user/user.php

Importing

jimport( 'joomla.user.user' );

Source Body

function load($id)
{
        // Create the user table object
        $table  =& $this->getTable();
 
         // Load the JUserModel object based on the user id or throw a warning.
         if(!$table->load($id)) {
                JError::raiseWarning( 'SOME_ERROR_CODE', 'JUser::_load: Unable to load user with id: '.$id );
                return false;
        }
 
        /*
         * Set the user parameters using the default xml file.  We might want to
         * extend this in the future to allow for the ability to have custom
         * user parameters, but for right now we'll leave it how it is.
         */
        $this->_params->loadINI($table->params);
 
        // Assuming all is well at this point lets bind the data
        $this->setProperties($table->getProperties());
 
        return true;
}

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

Examples

<CodeExamplesForm />