JAuthentication::authenticate: Difference between revisions
From Joomla! Documentation
Layout updates |
Updated to r1448:247ba8d88526 |
||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JAuthentication::authenticate|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JAuthentication::authenticate|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
<source lang="php"> | <source lang="php"> | ||
public | public function authenticate ( | ||
$credentials | |||
$options | |||
) | |||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 32: | Line 32: | ||
|- | |- | ||
|} | |} | ||
* '''Returns''' 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''' on line 83 of libraries/joomla/user/authentication.php | ||
* '''Since''' {{JVer|11.1 }} | |||
libraries/joomla/user/authentication.php | |||
* | |||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JAuthentication::authenticate source code''' on [[jplatform:user/authentication.php#cl-75|BitBucket]] | |||
* {{JVer|11.1}} Class [[JAuthentication/11.1|JAuthentication]] | |||
* {{JVer|11.1}} Subpackage [[Subpackage_User/11.1|User]] | |||
* [[JAuthentication::authenticate|Other versions of JAuthentication::authenticate]] | |||
{{SeeAlso:JAuthentication::authenticate}} | |||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JAuthentication::authenticate|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JAuthentication::authenticate|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
===User contributed notes=== | |||
=== | |||
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 53: | Line 52: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
namespace=CodeExample | |||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JAuthentication]][[Category:JAuthentication::authenticate]]</noinclude> | <noinclude>[[Category:JAuthentication]][[Category:JAuthentication::authenticate]]</noinclude> | ||
Revision as of 01:11, 28 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]
public function 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 on line 83 of libraries/joomla/user/authentication.php
- Since
See also
- JAuthentication::authenticate source code on BitBucket
- Class JAuthentication
- Subpackage User
- Other versions of JAuthentication::authenticate
Template:SeeAlso:JAuthentication::authenticate [Edit See Also]
User contributed notes
<CodeExamplesForm />