WordPress Plugin
Full reference for the Kerabie WordPress plugin.
The Kerabie WordPress plugin is the easiest way to add live chat to a WordPress site. It installs the widget automatically on every page without touching any code.
For the basic installation walkthrough, see Integrations → WordPress.
Plugin settings reference
After activation, go to WP Admin → Kerabie → Settings to configure:
General
| Setting | Description |
|---|---|
| Widget Key | Your Kerabie widget key (wk_...), required |
| Enable on all pages | Toggle the widget on every page of your site |
| Enable on specific pages | Enter comma-separated page IDs to restrict to those pages |
| Hide for logged-out users | Only show the widget to logged-in WordPress users |
| Hide for admins | Suppress the widget in WP Admin screens |
User identity
| Setting | Description |
|---|---|
| Pass WordPress user data | When on, logged-in users' name and email are sent to Kerabie automatically |
| Pass user ID | Also sends the WordPress user ID as userId |
| Custom user meta | Pass additional user meta fields as custom attributes (comma-separated meta keys) |
Widget appearance
The widget's colours, greeting, and position are controlled from your Kerabie dashboard under Settings → Chat Widget, not from the WordPress plugin. Changes there reflect immediately on your site without a plugin update.
Hooks and filters
The plugin provides WordPress hooks for developers who need custom control:
Filter: kerabie_widget_settings
Modify the window.KERConfig object before it's output:
add_filter('kerabie_widget_settings', function($settings) {
if (is_user_logged_in()) {
$user = wp_get_current_user();
$settings['user']['plan'] = get_user_meta($user->ID, 'subscription_plan', true);
}
return $settings;
});Action: kerabie_before_widget_script
Run code before the widget script tag:
add_action('kerabie_before_widget_script', function() {
// e.g. output a nonce or inline config
});WooCommerce integration
If WooCommerce is active, the plugin automatically passes the customer's order count and total spend as custom attributes:
user: {
orders_count: 5,
total_spend: "349.00"
}These appear in the conversation sidebar and can be used in automation conditions.
Updating the plugin
Updates are delivered through the standard WordPress plugin updater. You'll see an update notification in WP Admin → Plugins when a new version is available. Always update, older versions may not receive new widget features.
Compatibility
- WordPress 5.8+
- PHP 7.4+
- Compatible with all major page builders (Elementor, Divi, Oxygen, Bricks)
- Compatible with WP Rocket, W3 Total Cache, LiteSpeed Cache, add
cdn.kerabie.comto each cache plugin's script exclusion list