JAuthentication::authenticate: Difference between revisions
From Joomla! Documentation
Bulk upload by Doxiki2 |
Layout updates |
||
| Line 12: | Line 12: | ||
===Synopsis=== | ===Synopsis=== | ||
<source lang="php"> | <source lang="php"> | ||
public | public JAuthentication::authenticate ($credentials, $options) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 35: | Line 35: | ||
mixed Integer userid for valid user if credentials are valid or boolean false if they are not | mixed Integer userid for valid user if credentials are valid or boolean false if they are not | ||
===Defined in=== | ===Defined in=== | ||
libraries/joomla/user/authentication.php | libraries/joomla/user/authentication.php (line 87) | ||
* see source code in [[jplatform:user/authentication.php#cl-87|BitBucket]] | |||
===Referenced by=== | ===Referenced by=== | ||
===See also=== | ===See also=== | ||
Revision as of 00:55, 24 April 2011
JAuthentication::authenticate
Description
Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines.
Template:Description:JAuthentication::authenticate [Edit Descripton]
Since
Synopsis
public JAuthentication::authenticate ($credentials, $options)
| Parameter | Type | Default | Description |
|---|---|---|---|
| $credentials | array | Array holding the user credentials | |
| $options |
Returns
mixed Integer userid for valid user if credentials are valid or boolean false if they are not
Defined in
libraries/joomla/user/authentication.php (line 87)
- see source code in BitBucket
Referenced by
See also
Template:SeeAlso:JAuthentication::authenticate
Examples
<CodeExamplesForm />