LLMS_Events_Core
LLMS_Events_Core class
Contents
Source Source
File: includes/class-llms-events-core.php
class LLMS_Events_Core {
/**
* Constructor.
*
* @since 3.36.0
*
* @return void
*/
public function __construct() {
add_action( 'wp_login', array( $this, 'on_signon' ), 10, 2 );
add_action( 'clear_auth_cookie', array( $this, 'on_signout' ) );
}
/**
* Record account.signon event via `wp_login` hook.
*
* @since 3.36.0
*
* @param string $username WP_Users's user_login.
* @param WP_User $user User object.
* @return LLMS_Event
*/
public function on_signon( $username, $user ) {
return llms()->events()->record(
array(
'actor_id' => $user->ID,
'object_type' => 'user',
'object_id' => $user->ID,
'event_type' => 'account',
'event_action' => 'signon',
)
);
}
/**
* Record an account.signout event via `wp_logout()`
*
* @since 3.36.0
* @since 4.5.0 Return `false` without recording any event if no user was logged in.
*
* @return LLMS_Event|false The instance of the `LLMS_Event` recorded or `false` when no user was logged in.
*/
public function on_signout() {
$uid = get_current_user_id();
if ( ! $uid ) {
return false;
}
return llms()->events()->record(
array(
'actor_id' => $uid,
'object_type' => 'user',
'object_id' => $uid,
'event_type' => 'account',
'event_action' => 'signout',
)
);
}
}
Expand full source code Collapse full source code View on GitHub
Methods Methods
- __construct — Constructor.
- on_signon — Record account.signon event via `wp_login` hook.
- on_signout — Record an account.signout event via `wp_logout()`
Changelog Changelog
| Version | Description |
|---|---|
| 3.36.0 | Introduced. |