JAuthentication::authenticate: Difference between revisions
From Joomla! Documentation
m →User contributed notes: moving preparation |
m preparing for archive only |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines. | Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines. | ||
<source lang="php"> | <source lang="php"> | ||
public function authenticate ( | public function authenticate ( | ||
| Line 37: | Line 35: | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JAuthentication::authenticate source code''' on [[jplatform:user/authentication.php#cl-75|BitBucket]] | * {{JVer|11.1}} '''JAuthentication::authenticate source code''' on [[jplatform:user/authentication.php#cl-75|BitBucket]] | ||
* {{JVer|11.1}} Class [[JAuthentication | * {{JVer|11.1}} Class [[API17:JAuthentication|JAuthentication]] | ||
* {{JVer|11.1}} Subpackage [[Subpackage_User | * {{JVer|11.1}} Subpackage [[API17:Subpackage_User|User]] | ||
* [[JAuthentication::authenticate|Other versions of JAuthentication::authenticate]] | * [[API17:JAuthentication::authenticate|Other versions of JAuthentication::authenticate]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JAuthentication::authenticate | category=JAuthentication::authenticate | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
Latest revision as of 02:21, 25 March 2017
JAuthentication::authenticate
Description
Finds out if a set of login credentials are valid by asking all obvserving objects to run their respective authentication routines.
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
User contributed notes
Code Examples