Shortcode

Shortcode installation and options

You can easily install Wise Chat Pro using a shortcode. You just have to put it in a post or a page. Here is the basic form of the shortcode that will open Wise Chat Pro in the default channel “global”.

[wise-chat]

If the channel does not exist it will be created during first use (when first user visits a page containing the chat).

All options available on plugin’s Settings page can be used as attributes in the shortode. For example – in order to enable “Cold Dark” theme and to show list of users you can use the following shortcode:

[wise-chat theme="colddark" show_users="1"]

All attributes

Here is a list of all attributes available in version 2.1 of the Wise Chat Pro plugin.

channel – Channel

Opens given channel. Allowed values: all ASCII characters. Default: global

[wise-chat channel="My Room"]

General: General Settings

mode – Mode

Sets overall chat mode:
Classic chat: displays a classic chat window embedded in a page or a post
Facebook-like chat: displays a chat window and users list attached to the right side of the browser’s window
Allowed values:

• 0 – Classic chat
• 1 – Facebook-like chat

Default: 0

access_mode – Disable Anonymous Users

Only regular WP users are allowed to enter the chat. Choose user roles below.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

access_roles – Access For Roles

Access only for these user roles
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: Array

force_user_name_selection – Force Username Selection

Blocks access to the chat until an user enters his/her name.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

read_only_for_anonymous – Read-only For Anonymous

Makes the chat read-only for anonymous users. Only logged in WordPress users are allowed to send messages. You can choose read-only roles below.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

read_only_for_roles – Read-only For Roles

Selected roles have read-only access to the chat.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: Array

collect_user_stats – Collect User Statistics

Collects various statistics of users, including country, city, etc.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

enable_buddypress – Enable BuddyPress

Enables BuddyPress integration features.
Notice: Please remember to enable User Groups support in BuddyPress settings otherwise the integration will not work.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

External Login: Anonymous Login

anonymous_login_enabled – Enable

Shows a button for anonymous login.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

External Login: Facebook Login

facebook_login_enabled – Enable

Enables login through Facebook API. Every user that enters the chat must pass authorization through Facebook.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

facebook_login_app_id – Application ID

Required application ID.
Allowed values: a text
Default: [not set]

facebook_login_app_secret – Application Secret

Required application secret key
Allowed values: a text
Default: [not set]

External Login: Twitter Login

twitter_login_enabled – Enable

Enables login through Twitter API. Every user that enters the chat must pass authorization through Twitter.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

twitter_login_api_key – API Key

Required API Key.
Allowed values: a text
Default: [not set]

twitter_login_api_secret – API Secret

Required API Secret
Allowed values: a text
Default: [not set]

External Login: Google Login

google_login_enabled – Enable

Enables login through Google API. Every user that enters the chat must pass authorization through Google.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

google_login_client_id – Client ID

Required Client ID.
Allowed values: a text
Default: [not set]

google_login_client_secret – Client Secret

Required Client Secret
Allowed values: a text
Default: [not set]

Messages Posting: General Settings

message_max_length – Message Maximum Length

Maximum length of a message sent by an user
Allowed values: a positive number
Default: 400

allow_post_links – Enable Links

Makes posted links clickable
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

enable_twitter_hashtags – Enable Twitter Hashtags

Detects Twitter hashtags and converts them to links
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

Messages Posting: Users Notifications

enable_title_notifications – Enable Title Notifications

Shows notifications in browser’s window title when new messages arrives and the browser window is hidden / inactive
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

sound_notification – Message Sound Notification

Plays a sound when new messages arrives.
Allowed values:

• [not set] – Disabled
• sound-01 – Legacy Sound 1
• sound-02 – Legacy Sound 2
• sound-03 – Legacy Sound 3
• sound-04 – Legacy Sound 4
• wise-chat-01 – Wise Chat 1
• wise-chat-02 – Wise Chat 2
• wise-chat-03 – Wise Chat 3
• wise-chat-04 – Wise Chat 4
• wise-chat-05 – Wise Chat 5
• wise-chat-06 – Wise Chat 6
• wise-chat-07 – Wise Chat 7
• wise-chat-08 – Wise Chat 8
• wise-chat-09 – Wise Chat 9
• wise-chat-10 – Wise Chat 10
• wise-chat-11 – Wise Chat 11
• wise-chat-12 – Wise Chat 12
• wise-chat-13 – Wise Chat 13
• wise-chat-14 – Wise Chat 14
• wise-chat-15 – Wise Chat 15
• wise-chat-16 – Wise Chat 16
• wise-chat-17 – Wise Chat 17
• wise-chat-18 – Wise Chat 18
• wise-chat-19 – Wise Chat 19
• wise-chat-20 – Wise Chat 20

Default: [not set]

enable_join_notification – Enable Join Notification

When user joins the channel it displays the following message: User has joined the channel.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

join_sound_notification – Join Sound Notification

Plays a sound when user joins the chat.
Allowed values:

• [not set] – Disabled
• sound-01 – Legacy Sound 1
• sound-02 – Legacy Sound 2
• sound-03 – Legacy Sound 3
• sound-04 – Legacy Sound 4
• wise-chat-01 – Wise Chat 1
• wise-chat-02 – Wise Chat 2
• wise-chat-03 – Wise Chat 3
• wise-chat-04 – Wise Chat 4
• wise-chat-05 – Wise Chat 5
• wise-chat-06 – Wise Chat 6
• wise-chat-07 – Wise Chat 7
• wise-chat-08 – Wise Chat 8
• wise-chat-09 – Wise Chat 9
• wise-chat-10 – Wise Chat 10
• wise-chat-11 – Wise Chat 11
• wise-chat-12 – Wise Chat 12
• wise-chat-13 – Wise Chat 13
• wise-chat-14 – Wise Chat 14
• wise-chat-15 – Wise Chat 15
• wise-chat-16 – Wise Chat 16
• wise-chat-17 – Wise Chat 17
• wise-chat-18 – Wise Chat 18
• wise-chat-19 – Wise Chat 19
• wise-chat-20 – Wise Chat 20

Default: [not set]

enable_leave_notification – Enable Leave Notification

When user leaves the channel it displays the following message: User has left the channel.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

leave_sound_notification – Leave Sound Notification

Plays a sound when user leaves the chat.
Allowed values:

• [not set] – Disabled
• sound-01 – Legacy Sound 1
• sound-02 – Legacy Sound 2
• sound-03 – Legacy Sound 3
• sound-04 – Legacy Sound 4
• wise-chat-01 – Wise Chat 1
• wise-chat-02 – Wise Chat 2
• wise-chat-03 – Wise Chat 3
• wise-chat-04 – Wise Chat 4
• wise-chat-05 – Wise Chat 5
• wise-chat-06 – Wise Chat 6
• wise-chat-07 – Wise Chat 7
• wise-chat-08 – Wise Chat 8
• wise-chat-09 – Wise Chat 9
• wise-chat-10 – Wise Chat 10
• wise-chat-11 – Wise Chat 11
• wise-chat-12 – Wise Chat 12
• wise-chat-13 – Wise Chat 13
• wise-chat-14 – Wise Chat 14
• wise-chat-15 – Wise Chat 15
• wise-chat-16 – Wise Chat 16
• wise-chat-17 – Wise Chat 17
• wise-chat-18 – Wise Chat 18
• wise-chat-19 – Wise Chat 19
• wise-chat-20 – Wise Chat 20

Default: [not set]

mentioning_sound_notification – Mentioning Sound Notification

Plays a sound when user has been mentioned using @UserName notation.
Allowed values:

• [not set] – Disabled
• sound-01 – Legacy Sound 1
• sound-02 – Legacy Sound 2
• sound-03 – Legacy Sound 3
• sound-04 – Legacy Sound 4
• wise-chat-01 – Wise Chat 1
• wise-chat-02 – Wise Chat 2
• wise-chat-03 – Wise Chat 3
• wise-chat-04 – Wise Chat 4
• wise-chat-05 – Wise Chat 5
• wise-chat-06 – Wise Chat 6
• wise-chat-07 – Wise Chat 7
• wise-chat-08 – Wise Chat 8
• wise-chat-09 – Wise Chat 9
• wise-chat-10 – Wise Chat 10
• wise-chat-11 – Wise Chat 11
• wise-chat-12 – Wise Chat 12
• wise-chat-13 – Wise Chat 13
• wise-chat-14 – Wise Chat 14
• wise-chat-15 – Wise Chat 15
• wise-chat-16 – Wise Chat 16
• wise-chat-17 – Wise Chat 17
• wise-chat-18 – Wise Chat 18
• wise-chat-19 – Wise Chat 19
• wise-chat-20 – Wise Chat 20

Default: [not set]

Messages Posting: Images Settings

allow_post_images – Enable Images

Downloads posted images (links pointing to images) into Media Library and displays them
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

enable_images_uploader – Enable Uploader

Enables the uploader for sending pictures either from local storage or from a camera (on a mobile device).
In order to see sent pictures “Enable Images” option has to be enabled
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

images_size_limit – Size Limit

Size limit (in bytes) of images that are posted by users
Allowed values: a positive number
Default: 3145728

images_width_limit – Maximum Width

Resize images to the declared width
Allowed values: a positive number
Default: 1000

images_height_limit – Maximum Height

Resize images to the declared height
Allowed values: a positive number
Default: 1000

images_thumbnail_width_limit – Thumbnails Maximum Width

Maximum width of the generated thumbnail
Allowed values: a positive number
Default: 60

images_thumbnail_height_limit – Thumbnails Maximum Height

Maximum height of the generated thumbnail
Allowed values: a positive number
Default: 60

Messages Posting: File Attachments Settings

enable_attachments_uploader – Enable Uploader

Enables the uploader for sending file attachments from local storage. You can specify allowed file formats below
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

attachments_file_formats – Allowed File Extensions

Comma-separated list of allowed extensions
Allowed values: a text
Default: pdf,doc,docx

attachments_size_limit – Size Limit

Size limit (in bytes) of attachments that are posted by users
Allowed values: a positive number
Default: 3145728

Messages Posting: YouTube Videos Settings

enable_youtube – Enable YouTube Videos

Detects YouTube links and converts them to video players
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

youtube_width – Player Width

Width of the video player
Allowed values: a positive number
Default: 186

youtube_height – Player Height

Height of the video player
Allowed values: a positive number
Default: 105

Moderation: Moderation Permissions

enable_message_actions – Enable Admin Actions

Displays Approval, User Ban and Removal buttons next to each message. The buttons are visible only for roles defined below.
Note: Approval button is visible only for pending messages. You can turn on Pending Messages feature below.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

permission_approve_message_role – Approve Message Permission

An user role that is allowed to approve posted messages.
Alternatively you can assign “wise_chat_approve_message” capability to any custom role.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

enable_approval_confirmation – Approval Confirmation

Displays confirmation after clicking approval button.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

permission_edit_message_role – Edit Message Permission

An user role that is allowed to edit posted messages.
Alternatively you can assign “wise_chat_edit_message” capability to any custom role.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

permission_delete_message_role – Delete Message Permission

An user role that is allowed to delete posted messages.
Alternatively you can assign “wise_chat_delete_message” capability to any custom role.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

permission_ban_user_role – Ban User Permission

An user role that is allowed to ban users.
Alternatively you can assign “wise_chat_ban_user” capability to any custom role.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

permission_kick_user_role – Kick User Permission

An user role that is allowed to kick users.
Alternatively you can assign “wise_chat_kick_user” capability to any custom role.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

moderation_ban_duration – Ban Duration

Duration of the ban (in minutes) created by clicking on Ban button next a message. Empty field sets the value to 1440 minutes (1 day)
Allowed values: a positive number
Default: 1440

Moderation: Spam Reporting

spam_report_enable_all – Enable All

Enables spam reporting for all – including anonymous users.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

permission_spam_report_role – Enable Roles Only

User roles allowed to report spam messages.
Alternatively you can assign “wise_chat_spam_report” capability to any custom role.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

Moderation: Spam Reporting Notification

spam_report_recipient – Recipient

Allowed values: a text
Default: admin’s e-mail

spam_report_subject – Subject

Allowed values: a text
Default: [Wise Chat] Spam Report

spam_report_content – Content

Available variables: ${url}, ${channel}, ${message}, ${message-user}, ${message-user-ip}, ${report-user}, ${report-user-ip}
Allowed values: a text
Default: Wise Chat Spam Report

Channel: ${channel}
Message: ${message}
Posted by: ${message-user}
Posted from IP: ${message-user-ip}

—
This e-mail was sent by ${report-user} from ${url}
${report-user-ip}

Moderation: Pending Messages

new_messages_hidden – Enable

All new messages are hidden. They will become visible as soon as they are manually approved.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

show_hidden_messages_roles – Show Hidden Messages For

Shows hidden messages for selected user roles.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

no_hidden_messages_roles – Don’t Hide Messages For

Prevents from hiding messages for selected user roles.
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: administrator

approving_messages_mode – Approving Messages Mode

Determines what date and time to set for hidden messages that have been approved.
Allowed values:

• 1 – Date and time of the message
• 2 – Date and time of the approval

Default: 1

Appearance: Chat Window Appearance

theme – Theme

Allowed values:

• [not set] – Default
• lightgray – Light Gray
• colddark – Cold Dark
• airflow – Air Flow
• crystal – Crystal
• clear – Clear
• balloon – Balloon

Default: [not set]

background_color_chat – Background Color

Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_color_chat – Font Color

Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_size_chat – Font Size

Allowed values:

• [not set] – Default
• 0.5em – 50 %
• 0.6em – 60 %
• 0.7em – 70 %
• 0.8em – 80 %
• 0.9em – 90 %
• 1.0em – 100 %
• 1.1em – 110 %
• 1.2em – 120 %
• 1.3em – 130 %
• 1.4em – 140 %
• 1.5em – 150 %
• 2.0em – 200 %
• 3.0em – 300 %
• 8px – 8
• 9px – 9
• 10px – 10
• 11px – 11
• 12px – 12
• 13px – 13
• 14px – 14
• 15px – 15
• 16px – 16
• 17px – 17
• 18px – 18
• 20px – 20
• 22px – 22
• 24px – 24
• 26px – 26
• 28px – 28
• 30px – 30
• 36px – 36

Default: [not set]

chat_width – Width

Allowed values: a number with or without an unit (px or %), default: 100%.
Notice: You cannot use percentage unit when Facebook-like mode is set. All values here will be converted into px unit.
Default: 100%

chat_height – Height

Allowed values: a number with or without an unit (px or %), default: 200px
Default: 200px

Appearance: Messages List Appearance

messages_limit – Messages Limit

Maximum number of messages loaded on start-up
Allowed values: a positive number
Default: 30

private_messages_limit – Private Messages Limit

Maximum number of messages loaded on start-up for private conversations
Allowed values: a positive number
Default: 200

messages_order – Messages Order

Sorting order of the messages
Allowed values:

• [not set] – Newest on the bottom
• descending – Newest on the top

Default: [not set]

Appearance: Message Appearance

background_color – Background Color

Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_color – Font Color

Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_color_user – Username Font Color (any user)

Font color of username text in messages sent by any user
Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_color_logged_user – Username Font Color (logged in users)

Font color of username text in messages sent by logged in users
Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_color_user_roles – Username Font Color (logged in users in roles)

Allowed values: a text
Default: [not set]

text_size – Font Size

Allowed values:

• [not set] – Default
• 0.5em – 50 %
• 0.6em – 60 %
• 0.7em – 70 %
• 0.8em – 80 %
• 0.9em – 90 %
• 1.0em – 100 %
• 1.1em – 110 %
• 1.2em – 120 %
• 1.3em – 130 %
• 1.4em – 140 %
• 1.5em – 150 %
• 2.0em – 200 %
• 3.0em – 300 %
• 8px – 8
• 9px – 9
• 10px – 10
• 11px – 11
• 12px – 12
• 13px – 13
• 14px – 14
• 15px – 15
• 16px – 16
• 17px – 17
• 18px – 18
• 20px – 20
• 22px – 22
• 24px – 24
• 26px – 26
• 28px – 28
• 30px – 30
• 36px – 36

Default: [not set]

messages_time_mode – Message Time Mode

Format of the date and time displayed next to each message
Allowed values:

• hidden – Hidden
• [not set] – Full
• elapsed – Elapsed

Default: [not set]

messages_date_format – Message Date Format

Format of date displayed next to each message. Empty value means web browser’s local date format is used.
For detailed format options check the docs.
Allowed values: a text
Default: [not set]

messages_time_format – Message Time Format

Format of time displayed next to each message. Empty value means web browser’s local time format is used.
For detailed format options check the docs.
Allowed values: a text
Default: [not set]

messages_inline – Inline Message

Displays message and username in the same line
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

link_wp_user_name – Username Display Mode

Controls how username is displayed in each message:
– Plain text: username is displayed as a plain text.
– Link to the page: username is displayed as a link. The link is displayed only if the message was sent either by WordPress user or externally logged user (through Facebook, Twitter or Google).
In case of WordPress user the link direct to the auhtor’s page. In case of externally logged user the link direct to the profile of that user.
If you would like to link every user name (including anonymous users) provide a template for the link (see the option below).
– Link for @mentioning the user: username is displayed as a link that inserts “@UserName: “ text into the message input field. Useful when an user wants to mention someone.

Allowed values:

• 0 – Plain text
• 1 – Link to the page
• 2 – Link for @mentioning the user

Default: 0

link_user_name_template – Username Link Template

A template of the URL used to construct a link from username in each message (see the option above). While creating the template you can use the following dynamic variables: id, username, displayname.
Example 1: http://my.website.com/users/{username}/profile
Example 2: http://my.website.com/{id}/about
Example 3: http://my.website.com/search?user={displayname}

Allowed values: a text
Default: [not set]

show_avatars – Show Avatar

Shows user avatar next to each message
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

enable_edit_own_messages – Enable Message Editing

Enables editing of own messages
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

Appearance: Input Section Appearance

background_color_input – Background Color

Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_color_input_field – Font Color

Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

show_users_counter – Show Users Counter

Shows number of users visiting current channel
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

counter_without_anonymous – Counter Without Anonymous

Does not include anonymous users in counter calculation
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

show_emoticon_insert_button – Show Emoticon Button

Shows a button, near the message input field, that enables to insert an emoticon
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

show_message_submit_button – Show Submit Button

Displays the submit button next to the message input field, might be useful on mobile devices
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

show_user_name – Show User Name

Shows the name of the current user near the message input field
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

multiline_support – Multiline Messages

Changes input field into multiline input field. ENTER key sends the message. Shift+ENTER key combination can be used in order to move cursor to the new line.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

input_controls_location – Input Controls Location

Location of the input field, submit button and customizations panel section
Notice: This option makes no effect when Facebook-like mode is set.
Allowed values:

• [not set] – Bottom
• top – Top

Default: [not set]

allow_change_user_name – Allow To Change User Name

Permits an anonymous user to change his/her name displayed on the chat
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

disable_user_name_duplication_check – Disable User Name Duplication Check

Permits the use of user names of inactive users. By default all user names are locked for 24 hours counting from the last activity time.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

user_name_lock_window_seconds – User Names Lock Time

Determines how many seconds user name is locked since the last activity. When user name is locked it cannot be used by other user if the option above is not checked. Empty field means 86400 seconds (24 hours)
Allowed values: a positive number
Default: [not set]

user_name_length_limit – User Name Length Limit

Maximum length of user name. Empty field means there is no limit to the length.
Allowed values: a positive number
Default: 25

allow_mute_sound – Allow To Mute Sounds

Permits an user to mute all sounds generated by the chat. The option will be visible only if sound notifications are enabled.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: [not set]

allow_change_text_color – Allow To Change Text Color

After enabling this option user is allowed to change color of some parts of the chat related to him/her.
You can configure what is affected by this option below.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

text_color_parts – Text Color Setting Affects

Determines what chat parts are affected by text color change.
Allowed values:

• message – Message Text
• messageUserName – User Name in Message

Default: Array

Appearance: Users List Appearance

show_users – Show Users List

Shows users currently visiting the channel
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

show_users_list_search_box – Show Users Search Box

Displays users search box
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

enable_private_messages – Enable Private Messages

Allows users to exchange private messages. I have to show users list (option above) in order to enable private messages.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

private_message_confirmation – Private Message Confirmation

Displays a confirmation dialog when a new private message arrives. If this option is disabled then every private message is opened automatically.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

show_users_list_avatars – Show Avatars

Shows user avatar next to each username on the list
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

show_users_flags – Show National Flags

Shows national flag next to each user on the list. Country is obtained from IP address and this may not be successful sometimes.
Notice: In order to show flags enable “Collect User Statistics” option in General tab

Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

show_users_city_and_country – Show City And Country

Shows city and country code next to each user on the list. City and country are obtained from IP address and this may not be successful sometimes.
Notice: In order to show cities and countries enable “Collect User Statistics” option in General tab

Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

show_users_online_offline_mark – Show Online / Offline Mark

Displays little icon that indicates whether user is online or offline. It usually goes with “Enable Offline Users” option (see few lines below).
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

users_list_width – Users List Width

Percentage width of the list of users. Empty field sets default value of 29%.
Notice: When Facebook-like mode is set this value is treated as px unit value.

Allowed values: a positive number
Default: [not set]

background_color_users_list – Background Color

Background color of the users list
Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_color_users_list – Font Color

Font color of the texts inside the users list
Allowed values: a color in hex format, eg. #ef2244
Default: [not set]

text_size_users_list – Font Size

Font size
Allowed values:

• [not set] – Default
• 0.5em – 50 %
• 0.6em – 60 %
• 0.7em – 70 %
• 0.8em – 80 %
• 0.9em – 90 %
• 1.0em – 100 %
• 1.1em – 110 %
• 1.2em – 120 %
• 1.3em – 130 %
• 1.4em – 140 %
• 1.5em – 150 %
• 2.0em – 200 %
• 3.0em – 300 %
• 8px – 8
• 9px – 9
• 10px – 10
• 11px – 11
• 12px – 12
• 13px – 13
• 14px – 14
• 15px – 15
• 16px – 16
• 17px – 17
• 18px – 18
• 20px – 20
• 22px – 22
• 24px – 24
• 26px – 26
• 28px – 28
• 30px – 30
• 36px – 36

Default: [not set]

autohide_users_list – Auto-hide Users List

Auto-hides users lists when the chat window gets narrow enough (see the threshold below)
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

autohide_users_list_width – Auto-hide Width Threshold

Minimum width of the chat window when users list is visible
Allowed values: a positive number
Default: 300

users_list_linking – Usernames Mode

Makes usernames like it is set in Username Display Mode option.
Notice: This option will work only if private messages are disabled.

Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

Appearance: Users List Info Window Appearance

show_users_list_info_windows – Show Info Windows

Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

users_list_info_windows_template – Info Window Template

HTML template of info windows. Dynamic variables: {profileLink}, {role}, {roles}, {profileURL}, {avatar}, {privateMessageButton}, {id}, {username}, {displayname}
Allowed values: a text
Default: {avatar}
{profileLink}<br />
{role}<br />
{privateMessageButton}

Appearance: Users List Sources

users_list_offline_enable – Enable Offline Users

Lists users that are not online and allows to send private messages to them.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

users_list_bp_users_only – BuddyPress Friends Only

Displays BuddyPress friends only.
Notice: Please remember to enable BuddyPress integration in General settings and friends component in BuddyPress configuration.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

users_list_hide_anonymous – Hide Anonymous Users

Hides anonymous users on the users list
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

users_list_hide_roles – Hide User Roles

Hides users belonging to these roles on the users list
Allowed values:

• subscriber – Subscriber
• contributor – Contributor
• author – Author
• editor – Editor
• administrator – Administrator

Default: Array

Appearance: Facebook-like Mode Appearance

fb_users_list_top_offset – Users List Top Offset

Moves users list down by defined offset (in px unit). It is useful when the theme displays some kind of top toolbar which can be covered by users list in the top right corner.
Allowed values: a positive number
Default: [not set]

fb_bottom_offset – Bottom Offset

Moves users list and chat windows up by defined offset (in px unit). It is useful when the theme displays some kind of bottom toolbar which can be covered by users list and chat windows.
Allowed values: a positive number
Default: [not set]

fb_bottom_offset_threshold – Bottom Offset Threshold

Determines maximal screen width (in px unit) for which Bottom Offset (see above) option takes effect. It is useful when you want to enable bottom offset only for narrow screens like mobile phones or tablets. Empty value means no limit is enabled.
Allowed values: a positive number
Default: [not set]

fb_show_users_list_title – Show Users List Title

Displays a title bar above the users list.Notice: Enable this option if you would like to display pending chats indicator (usable with Enable Offline Users option).
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

fb_minimize_users_list_option – Allow To Minimize Users List

Displays a button in title bar to minimize users list. In order to enable this option please make users list title visible (see option above).
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

fb_minimize_on_start – Minimized By Default

Minimizes both the chat window and users list by default. If user maximizes chat window and/or users list then this setting no longer applies.
This option will become effective again after the user clears LocalStorage in Web browser.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

fb_disable_channel – Hide Channel Window

Hides the public channel window.
Notice: This option will take effect only if users lists and private messages are enabled (see section Users List Appearance).
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

Appearance: BuddyPress Customization

bp_member_profile_chat_button – Show Chat Button On Member Profile

Displays chat button on member profiles. Clicking the button opens a private chat window if and only if the chat is currently visible on the member profile page.
Read more
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

Appearance: Advanced Customization

custom_styles – Custom CSS Styles

Custom CSS styles for the chat, valid CSS syntax is required.
Allowed values: a text
Default: [not set]

css_classes_for_user_roles – CSS Classes For Roles

Adds CSS classes indicating user roles for users list and for each posted message.
Notice: Enable this option only if you want to add custom styles depending on user roles.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

Emoticons: General Settings

emoticons_enabled – Emoticons Theme

Displays emoticons (like or etc.) as images. Additionally, you can enable a button that allows to insert emoticons from popup layer. The option is in Appearance settings.
Notice: This setting takes no effect if Custom Emoticons (see below) option is enabled.
Allowed values: a positive number
Default: 1

Emoticons: Custom Emoticons

custom_emoticons_enabled – Enable Custom Emoticons

Enable custom set of emoticons. Below you can specify width of the emoticons layer and the list of emoticons.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

custom_emoticons_popup_width – Popup Width

Width of the emoticons popup (px unit). If the value is empty a default width is used.
Allowed values: a positive number
Default: [not set]

custom_emoticons_popup_height – Popup Height

Height of the emoticons popup (px unit). If the value is empty the height is set to contain all emoticons.
Allowed values: a positive number
Default: [not set]

custom_emoticons_emoticon_max_width_in_popup – Emoticon Width In Popup

Maximum width of a single emoticon in the popup (px unit). If the value is empty a default width is used.
Allowed values: a positive number
Default: [not set]

custom_emoticons_emoticon_width – Emoticon Width In Chat

Width of a single emoticon in the chat window.
Allowed values:

• [not set] –
• thumbnail – Thumbnail
• medium – Medium
• medium_large – Medium Large
• large – Large
• post-thumbnail – post-thumbnail

Default: [not set]

custom_emoticon_add – New Emoticon

Allowed values: a text
Default: [not set]

Channels: Channels Settings

auto_clean_after – Auto-remove Messages

The chat will delete messages older than given amount of minutes. Empty field means no messages will be deleted.
Allowed values: a positive number
Default: [not set]

channel_users_limit – Users Limit

Maximum amount of users allowed to enter a channel. Empty field means there is no limit.
Allowed values: a positive number
Default: [not set]

channels_limit – Channels Limit

Maximum amount of channels that an user can participate simultaneously. Empty field means there is no limit.
Allowed values: a positive number
Default: [not set]

Notifications: Notifications

notifications – Notifications

Allowed values: a text
Default: [not set]

notification_add – New Notification

Allowed values: a text
Default: [not set]

Filters: Bad Words Filter

filter_bad_words – Enable Filter

Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1

bad_words_replacement_text – Replacement Text

A text that is used to replace a bad word. Empty field means that asterisk is used.
Allowed values: a text
Default: [not set]

Bans: Automatic Bans

enable_autoban – Enable Automatic Bans

Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

autoban_threshold – Threshold

Determines how many messages containing bad words can be posted by an user before the user gets automatically banned
Allowed values: a positive number
Default: 3

autoban_duration – Duration

Duration of the automatic ban (in minutes). Empty field sets the value to 1440 minutes (1 day)
Allowed values: a positive number
Default: 1440

Bans: Flood Control

enable_flood_control – Enable Flood Control

Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

flood_control_threshold – Threshold

Determines how many messages (in given time window) could be posted by an user before the user gets automatically banned
Allowed values: a positive number
Default: 200

flood_control_time_frame – Time Window

Time window (in minutes) for flood control
Allowed values: a positive number
Default: 1

flood_control_ban_duration – Duration

Duration of the ban (in minutes). Empty field sets the value to 1440 minutes (1 day)
Allowed values: a positive number
Default: 1440

Localization: Localization Settings

hint_message – Hint Message

A hint message displayed in the message input field
Allowed values: a text
Default: Enter message here

user_name_prefix – User Name Prefix

Anonymous user’s name prefix
Allowed values: a text
Default: Anonymous

message_submit_button_caption – Submit Button Caption

Caption for message submit button
Allowed values: a text
Default: Send

window_title – Window Title

Title of the messages window
Allowed values: a text
Default: Wise Chat Pro

users_list_title – Users List Title

Title of the users lists (displayed only in Facebook-like mode)
Allowed values: a text
Default: Users List

users_list_search_hint – Users List Search Hint

Allowed values: a text
Default: Search …

message_save – “Save” message

Allowed values: a text
Default: Save

message_reset – “Reset” message

Allowed values: a text
Default: Reset

message_name – “Name” message

Allowed values: a text
Default: Name

message_customize – “Customize” message

Allowed values: a text
Default: Customize

message_sending – “Sending” message

Allowed values: a text
Default: Sending …

message_mute_sounds – “Mute sounds” message

Allowed values: a text
Default: Mute sounds

message_text_color – “Text color” message

Allowed values: a text
Default: Text color

message_total_users – “Total users” message

Allowed values: a text
Default: Total users

message_sec_ago – “sec. ago” message

Allowed values: a text
Default: sec. ago

message_min_ago – “min. ago” message

Allowed values: a text
Default: min. ago

message_yesterday – “yesterday” message

Allowed values: a text
Default: yesterday

message_insert_emoticon – “Insert an emoticon” message

Allowed values: a text
Default: Insert an emoticon

message_insert_into_message – “Insert into message” message

Allowed values: a text
Default: Insert into message

message_picture_upload_hint – “Upload a picture” message

Allowed values: a text
Default: Upload a picture

message_attach_file_hint – “Attach a file” message

Allowed values: a text
Default: Attach a file

message_channel_password_authorization_hint – Channel Authorization Hint

Allowed values: a text
Default: This channel is protected. Enter your password:

message_login – “Log in” message

Allowed values: a text
Default: Log in

message_enter_user_name – “Enter your username” message

Allowed values: a text
Default: Enter your username

message_input_title – Message input hint

Allowed values: a text
Default: Use Shift+ENTER in order to move to the next line

message_has_left_the_channel – has left the channel

Allowed values: a text
Default: has left the channel

message_has_joined_the_channel – has joined the channel

Allowed values: a text
Default: has joined the channel

message_users_list_empty – “No users in the channel” message

Allowed values: a text
Default: No users in the channel

message_login_using – “Login using” message

Allowed values: a text
Default: Log in using

message_login_anonymously – “Log in anonymously” message

Allowed values: a text
Default: Log in anonymously

message_yes – “Yes” message

Allowed values: a text
Default: Yes

message_no – “No” message

Allowed values: a text
Default: No

message_ignore_user – “Ignore this user” message

Allowed values: a text
Default: Ignore this user

message_information – “Information” message

Allowed values: a text
Default: Information

message_invitation – “Invitation” message

Allowed values: a text
Default: Invitation

message_maximize – “Maximize” message

Allowed values: a text
Default: Maximize

message_minimize – “Minimize” message

Allowed values: a text
Default: Minimize

message_close – “Close” message

Allowed values: a text
Default: Close

message_send_a_message – “Send a message” message

Allowed values: a text
Default: Send a message

message_facebook_user – “Facebook user” message

Allowed values: a text
Default: Facebook user

message_twitter_user – “Twitter user” message

Allowed values: a text
Default: Twitter user

message_google_user – “Google user” message

Allowed values: a text
Default: Google user

message_anonymous_user – “Anonymous user” message

Allowed values: a text
Default: Anonymous user

message_no_recent_chats – “No recent chats” message

Allowed values: a text
Default: No recent chats

message_user_not_found_in_chat – “The user is not in the chat” message

Allowed values: a text
Default: The user is not in the chat

message_info_1 – Information message #1

Message: “This user is ignored by you. Would you like to stop ignoring this user?”
Allowed values: a text
Default: This user is ignored by you. Would you like to stop ignoring this user?

message_info_2 – Information message #2

Message: “XYZ invites you to the private chat. Do you accept it?”
Allowed values: a text
Default: invites you to the private chat. Do you accept it?

message_info_3 – Information message #3

Message: “The message has been posted, but first it must be approved by the administrator.”
Allowed values: a text
Default: The message has been posted, but first it must be approved by the administrator.

message_error_1 – Message error #1

Message: “Only letters, number, spaces, hyphens and underscores are allowed”
Allowed values: a text
Default: Only letters, number, spaces, hyphens and underscores are allowed

message_error_2 – Message error #2

Message: “This name is already occupied”
Allowed values: a text
Default: This name is already occupied

message_error_3 – Message error #3

Message: “You were banned from posting messages”
Allowed values: a text
Default: You were banned from posting messages

message_error_4 – Message error #4 (HTML)

Message: “Only logged in users are allowed to enter the chat”
Allowed values: a text
Default: Only logged in users are allowed to enter the chat

message_error_5 – Message error #5 (HTML)

Message: “The chat is closed now”
Allowed values: a text
Default: The chat is closed now

message_error_6 – Message error #6 (HTML)

Message: “The chat is full now. Try again later.”
Allowed values: a text
Default: The chat is full now. Try again later.

message_error_7 – Message error #7

Message: “Unsupported type of file.”
Allowed values: a text
Default: Unsupported type of file.

message_error_8 – Message error #8

Message: “The size of the file exceeds allowed limit.”
Allowed values: a text
Default: The size of the file exceeds allowed limit.

message_error_9 – Message error #9

Message: “Invalid password.”
Allowed values: a text
Default: Invalid password.

message_error_10 – Message error #10 (HTML)

Message: “You cannot enter the chat due to the limit of channels you can participate simultaneously.”
Allowed values: a text
Default: You cannot enter the chat due to the limit of channels you can participate simultaneously.

message_error_11 – Message error #11 (HTML)

Message: “You are not allowed to enter the chat.”
Allowed values: a text
Default: You are not allowed to enter the chat.

message_error_12 – Message error #12 (HTML)

Message: “You are blocked from using the chat.”
Allowed values: a text
Default: You are blocked from using the chat.

message_error_13 – Message error #13

Message: “The length of the message exceeds allowed limit.”
Allowed values: a text
Default: The length of the message exceeds allowed limit.

message_text_1 – Message text #1

Message: “Are you sure you want to report the message as spam?”
Allowed values: a text
Default: Are you sure you want to report the message as spam?

Localization: BuddyPress Integration Localization

message_bp_manage_tab_name – Manage Chat Tab

Allowed values: a text
Default: Chat

message_bp_manage_enable_chat – Label #1

Label: “Enable Chat”
Allowed values: a text
Default: Enable Chat

message_bp_manage_tab_position – Label #2

Label: “Tab Position”
Allowed values: a text
Default: Tab Position

message_bp_manage_tab_label – Label #3

Label: “Tab Label”
Allowed values: a text
Default: Tab Label

message_bp_manage_permissions – Label #4

Label: “Tab Permissions”
Allowed values: a text
Default: Tab Permissions

message_bp_manage_permissions_mods_delete – Label #5

Label: “Allow mods to delete messages”
Allowed values: a text
Default: Allow mods to delete messages

message_bp_manage_permissions_mods_ban – Label #6

Label: “Allow mods to ban users”
Allowed values: a text
Default: Allow mods to ban users

message_bp_manage_permissions_admins_delete – Label #7

Label: “Allow admins to delete messages”
Allowed values: a text
Default: Allow admins to delete messages

message_bp_manage_permissions_admins_ban – Label #8

Label: “Allow admins to ban users”
Allowed values: a text
Default: Allow admins to ban users

message_bp_manage_notice – Label #9

Label: “Notice:”
Allowed values: a text
Default: Notice:

message_bp_manage_notice_text – Label #10

Label: “These permissions will work only with enabled admin actions in Wise Chat Pro settings”
Allowed values: a text
Default: These permissions will work only with enabled admin actions in Wise Chat Pro settings

message_bp_manage_shortcode – Label #11

Label: “Wise Chat Pro detailed parameters (shortcode syntax required)”
Allowed values: a text
Default: Wise Chat Pro detailed parameters (shortcode syntax required)

message_bp_manage_shortcode_example – Label #12

Label: “Example:”
Allowed values: a text
Default: Example:

message_bp_chat_message – Label #13

Label: “Chat Message”
Allowed values: a text
Default: Chat Message

Advanced: Advanced Settings

ajax_engine – AJAX Engine

Engine for AJAX requests generated by the chat.
The Default engine is the most compatible but it has a poor performance. The Lightweight AJAX and Ultra Lightweight AJAX engines are a lot faster and consume less CPU, however, it is slightly possible that they could be unstable in future versions of WordPress.
Allowed values:

• [not set] – Default
• lightweight – Lightweight AJAX
• ultralightweight – Ultra Lightweight AJAX

Default: ultralightweight

messages_refresh_time – Refresh Time

Determines how often the chat should check for new messages. Lower value means higher CPU usage and more HTTP requests.
Allowed values:

• 3000 – 3s
• 4000 – 4s
• 5000 – 5s
• 10000 – 10s
• 15000 – 15s
• 20000 – 20s
• 30000 – 30s
• 60000 – 60s
• 120000 – 120s

Default: 4000

enabled_debug – Enable Debug Mode

Displays extended error log. It is useful when reporting issues.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

enabled_errors – Enable Errors Reporting

Determines if all run-time errors should be displayed to chat users. It is useful when detecting issues.
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 0

ajax_validity_time – AJAX Validity Time

Determines how many minutes AJAX requests are considered as valid. It is useful to prevent indexing internal API calls by search engines and Web crawlers.
Warning: Too low value may cause errors on mobile devices. The default value is: 1 day (1440 minutes).
Allowed values: a positive number
Default: 1440

enabled_xhr_check – Enable XHR Request Check

Enabled check for “X-Requested-With” header in AJAX requests
Allowed values:

• 0 – disabled
• 1 – enabled

Default: 1