Joomla! Documentation™

The "API15" 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.

Description

Checks for a form token in the request

Syntax

checkToken($method= 'post')

Parameter Name	Default Value	Description
$method	'post'	The request method in which to look for the token key

Returns

boolean True if found and valid, false otherwise

Defined in

libraries/joomla/environment/request.php

Importing

jimport( 'joomla.environment.request' );

Source Body

function checkToken( $method = 'post' )
{
        $token  = JUtility::getToken();
        if(!JRequest::getVar( $token, '', $method, 'alnum' )) {
                $session = JFactory::getSession();
                if($session->isNew()) {
                        //Redirect to login screen
                        global $mainframe;
                        $return = JRoute::_('index.php');
;                               $mainframe->redirect($return, JText::_('SESSION_EXPIRED'));
                        $mainframe->close();
                } else {
                        return false;
                }
        } else {
                return true;
        }
}

Examples

<CodeExamplesForm />