Team Chat

You are here:
In this article

Basic shortcode

You can install Wise Chat plugin using a convenient shortcode. You can put it in a post or a page. This is the basic form of the shortcode:

[wise-chat]

It opens Wise Chat window on the “global” channel. If the channel does not exist it will be created on first use (when first user visits a page containing the chat).
Try Wise Chat Pro Buy PRO Version
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 type:

[wise-chat theme="colddark" show_users="0"]
Multiple values in attributes

Some options allow to specify multiple values, for example: Read-only For Roles, Opening Days, Delete Message Permission, etc. These are the options that allows to choose from multiple checkboxes on Wise Chat Settings page. Here is how to pass multiple values in attribute value:

[wise-chat permission_delete_message_role="{author,editor,administrator}"]

All attributes

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

channel – Channel

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

[wise-chat channel="My Room"]
General: General Settingsaccess_modeaccess_rolescollect_user_statsenable_buddypressforce_user_name_selectionread_only_for_anonymousread_only_for_roles
Messages Posting: General Settingsallow_post_linksemoticons_enabledenable_twitter_hashtagsmessage_max_length
Messages Posting: Users Notificationsenable_join_notificationenable_leave_notificationenable_title_notificationsjoin_sound_notificationleave_sound_notificationmentioning_sound_notificationsound_notification
Messages Posting: Images Settingsallow_post_imagesenable_images_uploaderimages_height_limitimages_size_limitimages_thumbnail_height_limitimages_thumbnail_width_limitimages_width_limit
Messages Posting: File Attachments Settingsattachments_file_formatsattachments_size_limitenable_attachments_uploader
Messages Posting: YouTube Videos Settingsenable_youtubeyoutube_heightyoutube_width
Moderation: Moderation Settingsenable_message_actionsmoderation_ban_durationpermission_ban_user_rolepermission_delete_message_rolepermission_edit_message_rolepermission_kick_user_role
Moderation: Spam Reportingpermission_spam_report_rolespam_report_enable_all
Moderation: Spam Reporting Notificationspam_report_contentspam_report_recipientspam_report_subject
Appearance: Chat Window Appearancebackground_color_chatchat_heightchat_widthtext_color_chattext_size_chattheme
Appearance: Messages List Appearancemessages_limitmessages_order
Appearance: Message Appearancebackground_colorlink_user_name_templatelink_wp_user_namemessages_date_formatmessages_inlinemessages_time_formatmessages_time_modetext_colortext_color_logged_usertext_color_usertext_color_user_rolestext_size
Appearance: Input Section Appearanceallow_change_text_colorallow_change_user_nameallow_mute_soundbackground_color_inputcounter_without_anonymousdisable_user_name_duplication_checkinput_controls_locationmultiline_supportshow_emoticon_insert_buttonshow_message_submit_buttonshow_user_nameshow_users_countertext_color_input_fieldtext_color_partsuser_name_length_limituser_name_lock_window_seconds
Appearance: Users List Appearanceautohide_users_listautohide_users_list_widthbackground_color_users_listshow_usersshow_users_city_and_countryshow_users_flagstext_color_users_listtext_size_users_listusers_list_hide_anonymoususers_list_hide_rolesusers_list_linkingusers_list_width
Appearance: Advanced Customizationcustom_styles
Channels: Channels Settingsauto_clean_afterchannel_users_limitchannels_limit
Filters: Bad Words Filterbad_words_replacement_textfilter_bad_words
Bans: Automatic Bansautoban_durationautoban_thresholdenable_autoban
Bans: Flood Controlenable_flood_controlflood_control_ban_durationflood_control_thresholdflood_control_time_frame
Localization: Localization Settingshint_messagemessage_attach_file_hintmessage_channel_password_authorization_hintmessage_customizemessage_enter_user_namemessage_error_1message_error_10message_error_11message_error_12message_error_2message_error_3message_error_4message_error_5message_error_6message_error_7message_error_8message_error_9message_has_joined_the_channelmessage_has_left_the_channelmessage_input_titlemessage_insert_emoticonmessage_insert_into_messagemessage_loginmessage_min_agomessage_mute_soundsmessage_namemessage_picture_upload_hintmessage_resetmessage_savemessage_sec_agomessage_sendingmessage_submit_button_captionmessage_text_1message_text_colormessage_total_usersmessage_users_list_emptymessage_yesterdayuser_name_prefixwindow_title
Advanced: Advanced Settingsajax_enginemessages_refresh_timeenabled_debugenabled_errorsajax_validity_timeenabled_xhr_check

 

General: General Settings

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. 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.
Allowed values:

  • 0 – disabled
  • 1 – enabled

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: 1

enable_twitter_hashtags – Enable Twitter Hashtags

Detects Twitter hashtags and converts them to links Allowed values:

  • 0 – disabled
  • 1 – enabled

Default: 1

emoticons_enabled – Emoticons Set

Displays posted emoticons (like or ;-)) as images. You can display a button that allows to insert emoticons. The option is in appearance settings. Allowed values: a positive number Default: 1

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: 1

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: 1

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: 1

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: 1

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 Settings

enable_message_actions – Enable Admin Actions

Displays ban and removal buttons next to each message. The buttons are visible only for roles defined below Allowed values:

  • 0 – disabled
  • 1 – enabled

Default: 1

permission_edit_message_role – Edit Message Permission

User roles 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: [not set]

permission_delete_message_role – Delete Message Permission

User roles 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

User roles 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

User roles 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}

Appearance: Chat Window Appearance

theme – Theme

Allowed values:

  • [not set] – Default
  • lightgray – Light Gray
  • colddark – Cold Dark
  • airflow – Air Flow

Default: lightgray

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% Default: 100%

chat_height – Height

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

Appearance: Messages List Appearance

messages_limit – Messages Limit

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

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: elapsed

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. By default the link directs to the author’s page. Only messages sent by WordPress users are taken into account. If you would like to link every user name 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]

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: 1

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: 1

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 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: 1

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 (see option below) 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: 1

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_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

users_list_width – Users List Width

Percentage width of the list of users. Empty field sets default value of 29%. 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_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

users_list_linking – Usernames Mode

Makes usernames like it is set in Username Display Mode option. 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]

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]

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

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_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

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

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

message_error_6 – Message error #6

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

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

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

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

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?

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:

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

Default: 3000

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

Was this article helpful?
Dislike 0

Leave a Comment