Presence API

Priskribo

Presence API gives WordPress a system-wide awareness layer. It tracks which users are logged in, which admin screen they are on, and which posts they are editing.

Data flows through the Heartbeat API and is stored in a dedicated wp_presence table with a 60-second TTL. No writes to wp_postmeta means no post-cache invalidation on every heartbeat.

Features

  • Who’s Online dashboard widget with idle detection
  • Active Posts dashboard widget grouped by post
  • Admin bar indicator showing other users on the same page
  • Editors column in the post list
  • Online filter in the Users list

Try it

Test in WordPress Playground without installing anything.

Watch the demo on YouTube

For Developers

PHP functions, REST endpoints, WP-CLI commands, filters, and room conventions are documented in the GitHub repository.

Background

An experimental feature plugin sponsored by the WordPress Core team, exploring what system-wide presence could look like for a future WordPress release. Follow development on make.wordpress.org/core with the tag #presence-api.

Instalo

  1. In your WordPress admin, go to Plugins Add New Plugin and search for “Presence API”, then click Install Now.
  2. Activate through the Plugins menu.

Or install manually:

  1. Download the zip and upload the presence-api folder to /wp-content/plugins/.
  2. Activate through the Plugins menu.

Or try it in WordPress Playground without installing anything.

Pritaksoj

There are no reviews for this plugin.

Kontribuantoj k. programistoj

“Presence API” estas liberkoda programo. La sekvaj homoj kontribuis al la kromprogramo.

Kontribuantoj

Traduki “Presence API” en vian lingvon.

Ĉu interesita en programado?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Ŝanĝprotokolo

0.1.8

  • Add AI Tools disclosure to automated contributor PR body.
  • Add concurrency group, use default_branch instead of hardcoded main.
  • Robot PR body for first contributions, suppress props-bot on contributor PRs.
  • Suppress props-bot on release-please PRs.
  • Use user.type for bot detection, wrap fetch in full try/catch.
  • Remove AI disclosure from automated PR body.

0.1.7

  • Add validate_callback validation check to REST screen_key.
  • Use correct REST route in PHPUnit tests.

0.1.6

  • Dispatch deploy workflow instead of calling as reusable to avoid startup failure.
  • Flatten deploy workflow to remove reusable nesting causing startup failure.
  • Use 10up action ASSETS_DIR instead of separate assets workflow.
  • Use correct heading format in Unlinked Accounts regex.

0.1.5

  • Check entry ownership before enforcing per-user presence limit (5698d94), closes #88.
  • Exclude expired entries from ownership check to keep cap exact.
  • Pass VERSION env var to deploy action so SVN tag matches git tag.
  • Preserve version headings in sync script and correct wp_options claim.

0.1.4

  • Maintenance release.

0.1.3

  • Add 40-user Playground blueprint.
  • Address stale-screen review feedback.
  • Address WordPress.org plugin review feedback.

0.1.2

  • Add WordPress Playground blueprint for one-click testing.
  • Remove demo CLI command from production builds.
  • Split CI into separate PHPCS, PHPUnit, and Multisite workflows.
  • Exclude vendor directory from release zip.
  • Add readme.txt for WordPress.org directory submission.
  • Add WordPress.org repository compliance files (CONTRIBUTING, CODEOWNERS, CODE_OF_CONDUCT).
  • Move community health files to .github/.
  • Replace deprecated get_page_by_title() with WP_Query.
  • Add ABSPATH guards to db-viewer.php and demo-seeder.php.

0.1.1

  • Fix Plugin Check errors for directory submission.

0.1.0

  • Dedicated wp_presence table with UNIQUE KEY (room, client_id) for atomic upserts via INSERT ... ON DUPLICATE KEY UPDATE.
  • 60-second TTL with batched cron cleanup.
  • Public API: wp_get_presence, wp_set_presence, wp_remove_presence, wp_remove_user_presence, wp_can_access_presence_room, wp_presence_post_room.
  • REST endpoints: GET/POST/DELETE /wp-presence/v1/presence, GET /wp-presence/v1/presence/rooms with SQL pagination and Cache-Control: no-store.
  • Heartbeat integration for admin and editor presence pings.
  • Post-lock bridge: translates wp-refresh-post-lock into presence entries.
  • Login/logout lifecycle hooks gated on edit_posts.
  • Dashboard widgets: Who’s Online (with idle detection, overflow threshold, avatar stacks) and Active Posts (grouped by post with editor counts).
  • Admin bar indicator: avatar stack for same-page users, dropdown grouped by “On this page” / “Elsewhere”, alphabetically sorted.
  • Post list “Editors” column with avatar stacks.
  • Users list “Online” filter tab.
  • WP-CLI: set, list, summary, cleanup.
  • Debugger widget (WP_DEBUG only): heartbeat monitor with live table viewer.
  • wp_presence_default_ttl filter and WP_PRESENCE_DEFAULT_TTL constant.
  • Multisite-aware uninstall.php.
  • Full i18n with .pot file.
  • WCAG AA accessibility: ARIA labels, aria-live, keyboard navigation.
  • 59 PHPUnit tests, 118 assertions.
  • Playwright e2e tests with screenshot artifacts.