API17:JAuthentication::authenticate
From Joomla! Documentation
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 />