Private Messages Setup

Overview

This document provides instructions on our Private Messages extension.

Contents

Settings #

Extension's settings #

When the extension Private Messages is activated, it adds a Messaging tab to the page [Ultimate Member > Settings > Extension]. In the Messaging tab you should see the following options:

  • Show messages button in member directory - Enable/disable buttons "Message" on the Members page. Note: "Message" buttons can be disabled for certain directory using option "Hide message button in directory".
  • Show unread messages first - Show conversation with unread messages first.
  • Message character limit - You can set the maximum number of characters allowed in each conversation reply.
  • Block users from sending messages - You can add user IDs that cannot send messages on the site. Use comma to separate the list.
  • Primary color - You can also select the color of the message box outline, links and send message button.
  • How often do you want the AJAX refresh conversation (in seconds) - AJAX timeout. Too small value may slow down the site.
  • New Message Notification - If turned on, a notification will be sent to user when a new private message is received. You can edit the subject and content of the email notification.
  • Send email notifications If user did not login for - You can set the last log in time period to send email notifications about new messages if the user's last login time exceeds that period.
  • Send email notifications If user didn't read message for [n] hours - Send email notifications about unread message if the user didn't read it during that period.
  • Send email notifications not more then [m] times - Email notifications about unread message will be send every [n] hours but no more then [m] times.

[Ultimate Member > Settings > Extensions > Private Messaging]

Profile Menu settings #

The extension adds settings to the page [wp-admin > Ultimate Member > Settings > Appearance > Profile Menu]. These settings allow you to manage the "Messages" item in the profile menu:

  • Messages Tab – Allows to enable/disable "Messages" item in the Profile menu. Note: only profile owners and the Administrator can see the "Messages" item in the Profile menu.

User Role settings #

The extension allows you to control private messages on specific user roles. To modify the settings on a specific role, go to the page [wp-admin > Ultimate Member > User Roles] and choose the user role to modify. You will be navigated to the page "Edit Role". On this page scroll down to the Private Messages options:

  • Enable Messaging feature? - Enable or disable a messaging feature for this role.
  • Can start conversations? - Allow this role to start a conversation with other users.
  • Can read private messages? - Allow this role to read private messages from other users.
  • Can reply private messages? - Allow this role to reply to other users.
  • Maximum number of messages they can send - Limit the maximum number of messages they can send.

[Ultimate Member > User Roles > Edit Role]

Member Directories settings #

Extension " Private Messages" adds buttons "Message" on the Members page. There are two settings that allow to enable/disable these buttons:

  • Show messages button in member directory at the [Ultimate Member > Settings > Extensions > Private Messaging] page - enable/disable buttons "Message" for all member directories;
  • Hide message button in directory at the [Ultimate Member > Member Directories > Edit Member Directory] page - disable buttons "Message" for certain directory.

Buttons "Message" on the Members page

User Profile #

Extension " Private Messages" adds these elements:

  • "Messages" tab on member Profile page;
  • Button "Message" on other members Profile pages;
  • Member option "Who can send me private messages?" on Account page.

Users can send private messages by clicking the button "Message" on the user profile page or the member directory. Once the message button is clicked, a pop up window will appear where users can easily exchange texts, links and emojis.

Note: The button "Message" is shown for guests and logged in members with proper settings. The button is hidden if:
 - current user is a recipient;
 - current user or recipient is blocked by the setting "Block users from sending/receiving messages";
 - current user is blocked by recipient or recipient is blocked by current user;
 - the messaging feature is blocked by the setting "Who can send me private messages?" in the recipient's account;
 - the messaging feature is disabled for the current user user role or for the for the recipient user role;
 - the recipient user role can't read private messages;

"Messages" tab on Profile page

Button "Message" on other members Profile pages

Member option "Who can send me private messages?" on Account page

Privacy and Notifications #

If Followers and Real-time notifications extensions are also integrated on your site, users are given the option to control who can send them private messages and if they want to receive email notifications for new messages directly on their account settings.

Shortcode #

The extension adds these shortcodes:

[ultimatemember_message_button] #

Used for: Show the message button of a specific user. You may put this shortcode into the post (page) content or to the sidebar text widget.

Example:

[ultimatemember_message_button user_id="123"]

The shortcode attributes:

  • user_id (integer) - the identification number of the user - recipient. Required. Default value: the post author ID if post(page) or 0.

Examples:

The shortcode in the post content

The shortcode in the text widget

[ultimatemember_message_count] #

Used for: Show the total unread messages of a specific user.

Example:

[ultimatemember_message_count user_id="123"]

The shortcode attributes:

  • user_id (integer) - the identification number of the user. Required. Default value: current user ID.

[ultimatemember_messages] #

Used for: Show the message box of a specific user.

Example:

[ultimatemember_messages user_id="123"]

The shortcode attributes:

  • user_id (integer) - the identification number of the user - recipient. Required. Default value: current user ID.