Online Users Setup
Overview
This document provides instructions on how to set up the Online Users extension.
Contents:
Settings #
Once the extension is activated, it adds the Online tab to the wp-admin > Ultimate Member > Settings > Extensions screen. In this tab you should see the following options:
- Show online stats in member directory - Enable or disable online status in the member directory.
The extension adds a green circle near the user's profile photo in the profile card in the directory if the user is online.
User profile #
The extension adds a green circle next to the user’s name on their profile if the user is online.
The extension adds the Online Status field which allows you to display the user’s online status in the profile form section. Go to wp-admin > Ultimate Members > Forms > Edit Form. Click the plus "+" sign button in the Form Builder to add a field. The Fields Manager window will appear, select the Online Status from the predefined fields. Click on the Update button to save changes.
User account #
The extension adds an option to the Privacy tab on the user account page so users can decide if they want other users to know when they are online or not.
Shortcodes #
[ultimatemember_online] #
This shortcode displays online members.
The shortcode attributes:
| Key | Type | Default | Description |
| max | integer | 11 | Maximum amount of members shown on a one screen. |
| roles | string | 'all' | Filters members by user roles. |
Example:
[ultimatemember_online max="6" roles="administrator,subscriber"]
Widgets #
The extension adds the "Ultimate Member - Online Users" widget which you can add to your sidebar or footer. The widget allows you to add a title, select the maximum number of profile photos to show in the first view (default is 20). If more than 20 users are online users will have to click the text link to reveal the other users. You can select to show all user roles or only one role.
Go to wp-admin > Appearance > Widgets. Click on the plus sign button to add a widget, search "online", and drag the widget to sidebar. Click the Update button to save changes.
