Description
PeerKit Chat embeds two-person text chat on any WordPress page or post. Add the Gutenberg block peerkit/chat, or use the [peerkit_chat] shortcode. Visitors join a live PeerKit data session. The public page loads the bundled PeerKit Chat Core script and does not use React.
What this plugin does
- Open rooms for the first two visitors, or private conversations with a WordPress invitation link
- Match your theme colors, or customize appearance in the block inspector
- Keep the PeerKit project API key on the server — encrypted in WordPress, or set with
PEERKIT_CHAT_API_KEYinwp-config.php - Optional invitation email through WordPress
wp_mail()
Messages travel peer-to-peer on the PeerKit data channel while both people are connected. PeerKit does not store the conversation transcript.
Powered by PeerKit
PeerKit is a platform for real-time peer-to-peer experiences. Beyond this WordPress plugin, PeerKit provides developer SDKs and ready-to-use components for messaging, file sharing, voice, video calling, and local recording. See peerkit.dev and the Chat component.
This plugin is the WordPress interface to PeerKit Chat. Other PeerKit components and SDKs are available separately for custom applications.
See a short PeerKit Chat walkthrough on the Chat component page: https://peerkit.dev/components/chat
PeerKit product information: https://peerkit.dev/
PeerKit docs: https://peerkit.dev/docs
PeerKit pricing (free plan available; paid plans optional): https://peerkit.dev/pricing
PeerKit contact: https://peerkit.dev/contact
PeerKit Terms of Service: https://peerkit.dev/terms
PeerKit Privacy Policy: https://peerkit.dev/privacy
Screenshots




Blocks
This plugin provides 1 block.
- PeerKit Chat
Installation
- Upload the
peerkit-chatfolder to/wp-content/plugins/, or install the ZIP from Plugins Add New Upload Plugin. - Activate PeerKit Chat.
- Create a PeerKit project and API key (
pk_live_…) in the PeerKit dashboard. - Open Settings PeerKit Chat, paste the project API key (or define
PEERKIT_CHAT_API_KEYinwp-config.php), and save to test the connection. - Add the PeerKit Chat block, or
[peerkit_chat mode="private" appearance="match"].
FAQ
-
Where do messages go?
-
They move on the PeerKit data channel between the two joined browsers. PeerKit does not store the conversation.
-
Can more than two people join?
-
No. A data session has one publisher seat and one viewer seat. A third visitor is asked to wait until the session ends.
-
Does the public page need React?
-
No. React is only inside the WordPress block editor, which already uses it.
-
Which external services does this plugin use?
-
This plugin is an interface to the PeerKit hosted service. After an administrator saves a PeerKit project API key and tests the connection, WordPress calls the PeerKit API (
https://api.peerkit.devby default) to register this site origin, create or resume data sessions, issue short-lived invitations, and end idle sessions. Those requests send the server-side API key and session metadata. They do not send WordPress passwords.The public chat page loads a bundled copy of the PeerKit Chat Core script (
@peerkit-dev/chat-core0.1.2, shipped asassets/vendor/chat-core/element.global.jswith its license notices). Joined browsers then connect to PeerKit signaling (media.peerkit.dev) with a short-lived participant token. Message contents travel peer-to-peer on the PeerKit data channel; PeerKit does not store the conversation transcript.Optional invitation email uses WordPress
wp_mail()when the host chooses to send one. The invitation link points back to this WordPress site.PeerKit product information: https://peerkit.dev/
PeerKit docs: https://peerkit.dev/docs
PeerKit pricing (free plan available; paid plans optional): https://peerkit.dev/pricing
PeerKit contact: https://peerkit.dev/contact
PeerKit Terms of Service: https://peerkit.dev/terms
PeerKit Privacy Policy: https://peerkit.dev/privacy -
Does chat work without a PeerKit account?
-
No. An administrator needs a PeerKit project API key (
pk_live_…) from the PeerKit dashboard. The WordPress plugin itself is free. PeerKit offers a free plan and optional paid plans for organization minutes and limits. -
What is the difference between an open room and a private conversation?
-
An open room lets the first two visitors talk without an invitation. A private conversation admits only the person who starts it and the person who opens their invitation link. The host can copy that link or email it. Leaving keeps the conversation open. Ending it, which only the host can do, asks for confirmation, then closes the PeerKit session and invalidates the link. Existing blocks stay open rooms. New blocks start as private conversations. New blocks match the active theme. Existing color choices are kept until the block’s Appearance setting is changed. Buttons stay compact.
-
How does PeerKit Chat relate to the rest of PeerKit?
-
This plugin embeds PeerKit Chat on WordPress. PeerKit also ships JavaScript, Web Component, and React packages for Chat, Share, Voice, Call, and Record, plus an SDK for creating sessions from your own backend. Those packages are separate from this plugin. See https://peerkit.dev/ and https://peerkit.dev/docs
Reviews
There are no reviews for this plugin.
Contributors & Developers
“PeerKit Chat” is open source software. The following people have contributed to this plugin.
ContributorsTranslate “PeerKit Chat” into your language.
Interested in development?
Browse the code, check out the SVN repository, or subscribe to the development log by RSS.
Changelog
0.1.6
- Keep the conversation actions menu over the chat instead of pushing messages down.
- Make invitation-link copying clearer with a compact Copy control beside the link, and keep the menu action.
0.1.5
- Satisfy WordPress Plugin Check input handling, uninstall naming, and translation loading guidance for WordPress.org.
0.1.4
- Use a compact chat composer, header, and conversation menu. Invitation sharing stays behind Invite someone, and End still asks for confirmation.
- An invited guest joins the host’s PeerKit session. A guest who never connected, or whose browser has been gone through the reconnect grace period, no longer blocks the next person with the invitation.
- Closing the page releases the browser lock and starts that grace period. Leave, a live guest, a second tab, and an ended invitation are still rejected.
- Heartbeats and seat checks use their own rate limits, and a rate-limited seat check is not retried.
- Bundle Theme Adapter 0.1.1 for Match my site, and cache-bust plugin CSS and JavaScript when those files change.
- Ship
@peerkit-dev/chat-core0.1.2 inside the plugin instead of loading it from jsDelivr. - Correct the send control icon size, centering, and disabled contrast.
0.1.3
- Style conversation buttons from the WordPress theme, with inspector controls for button colors, border, radius, and size.
- Add private conversations with a WordPress invitation link, and keep existing blocks as open rooms.
- Let the host leave, rejoin, or end the conversation. Ending closes the PeerKit session and invalidates the invitation.
- Expire invitation links, and end PeerKit sessions that have been idle so the quota can be released.
- Let the host email an invitation with wp_mail(). The link still works when mail is not sent.
0.1.2
- Chat follows the connection state signaling already reached, instead of staying on Connecting after the socket opens.
0.1.1
- Public chat no longer sends a WordPress REST nonce without the login cookie.
- An occupied seat stays with its participant until that visitor leaves, and the same browser can reconnect.
- The two participants keep distinct seats for the life of the session.
0.1.0
- First release. Settings, block, shortcode, and server-side invitations.
