Legacy Documentation

You are using the documentation for version 3.5.17. Go here for the latest version or check here for your available upgrades to the latest version.

Login Controller Extension Hooks¶

login_authenticate_start ¶

login_authenticate_start()¶

Perform additional actions prior to/take over the control panel login routine.

How it’s called:

$this->extensions->call('login_authenticate_start');
if ($this->extensions->end_script === TRUE) return;

Return type:	Void

New in version 1.4.2.

cp_member_login($hook_data)¶

Executes after control panel session is instantiated, allows additional processing on control panel logins.

How it’s called:

ee()->extensions->call('cp_member_login', $this->_hook_data());
if (ee()->extensions->end_script === TRUE) return;

Parameters:	$hook_data (object) – Member object with session ID (`$hook_data->session_id`) and CP permission boolean (`$hook_data->can_access_cp`)
Return type:	Void

New in version 1.4.0.

cp_member_logout()¶

Perform additional actions after a user logs out of the control panel.

How it’s called:

$this->extensions->call('cp_member_logout');
if ($this->extensions->end_script === TRUE) return;

Return type:	Void

New in version 1.6.1.

cp_member_reset_password()¶

Perform additional actions after a user resets their password via the control panel.

How it’s called:

$this->extensions->call('cp_member_process_reset_password');
if ($this->extensions->end_script === TRUE) return;

Return type:	Void

New in version 2.9.3.