API15:JUserHelper/activateUser

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 activate a user

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

Syntax

activateUser($activation)

Parameter Name	Default Value	Description
$activation		$activation Activation string

Returns

boolean True on success

Defined in

libraries/joomla/user/helper.php

Importing

jimport( 'joomla.user.helper' );

Source Body

function activateUser($activation)
{
        //Initialize some variables
        $db = & JFactory::getDBO();
 
        // Lets get the id of the user we want to activate
        $query = 'SELECT id'
        . ' FROM #__users'
        . ' WHERE activation = '.$db->Quote($activation)
        . ' AND block = 1'
        . ' AND lastvisitDate = '.$db->Quote('0000-00-00 00:00:00');
        ;
        $db->setQuery( $query );
        $id = intval( $db->loadResult() );
 
        // Is it a valid user to activate?
        if ($id)
        {
                $user =& JUser::getInstance( (int) $id );
 
                $user->set('block', '0');
                $user->set('activation', '');
 
                // Time to take care of business.... store the user.
                if (!$user->save())
                {
                        JError::raiseWarning( "SOME_ERROR_CODE", $user->getError() );
                        return false;
                }
        }
        else
        {
                JError::raiseWarning( "SOME_ERROR_CODE", JText::_('UNABLE TO FIND A USER WITH GIVEN ACTIVATION STRING') );
                return false;
        }
 
        return true;
}

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

Examples

<CodeExamplesForm />