Plugin/Events/Authentication
From Joomla! Documentation
Revision as of 08:40, 26 December 2016 by Thelordofweb (talk | contribs) (Created page with "{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}} Authentication events are triggered during the user authentication...")
Revision as of 08:40, 26 December 2016 by Thelordofweb (talk | contribs) (Created page with "{{version/tutor|2.5,3.x|alt=1.5|altlink=J1.5:Plugin/Events/Content|alttitle=this guide for old event names}} Authentication events are triggered during the user authentication...")
Authentication events are triggered during the user authentication process. This list gives a brief description of each event, what their parameters are, and some examples of their use in core plugins.
onUserAuthenticate
Description
This event is triggered to verify that a set of login credentials is valid.
Parameters
Array of credentials. Structure:\\ ['username']\\ ['password']\\ Alternative authentication mechanisms can supply additional credentials.
Return Value
An array of JAuthenticationResponse objects detailing the results of each called plugin, including success or failure.
Used in files
- libraries/joomla/user/authentication.php
- plugins/authentication/gmail.php
- plugins/authentication/joomla.php
- plugins/authentication/ldap.php
Example
- plugins/authentication/example.php