Unofficial SMF API Documentation

./Sources/Subs-MembersOnline.php

getMembersOnlineStats

function getMembersOnlineStats(array $membersOnlineOptions): array

Retrieve a list and several other statistics of the users currently online.

Used by the board index and SSI. Also returns the membergroups of the users that are currently online. (optionally) hides members that chose to hide their online presence.

Type Parameter Description
array $membersOnlineOptions An array of options for the list
Integration hooks
integrate_online_stats

trackStatsUsersOnline

function trackStatsUsersOnline(int $total_users_online): void

Check if the number of users online is a record and store it.

Type Parameter Description
int $total_users_online The total number of members online

Suggest an edit to this page on GitHub