Plugin/Events/Authentication

From Joomla! Documentation

< Plugin‎ | Events
Other languages:
English • ‎Nederlands

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