Skip to content

Document the existing Presence API extension points #13

Description

@raftaar1191

Rewritten 2026-07-26. The original framing, that presence is backend and editor only and needs opt-in front-end extension points, is stale: includes/heartbeat.php:41-62 reports front-end presence with page titles for logged-in users whenever the admin bar shows. #17 was closed as not planned but the capability landed anyway.

@mindctrl's position on the original issue stands and is the project's: build something reliable and performant, let it soak, open it up once real use cases exist. #122 is the first of those arriving.

What is actionable now is that the extension points which already exist are undocumented:

  • wp_presence_default_ttl filter (includes/functions.php:190-197)
  • post_type_supports( $type, 'presence' ) as the opt-in for per-post rooms (includes/functions.php:169, registered for post and page at presence-api.php:102-105)
  • wp_presence_screen_revision_bumped action (includes/screen-revisions.php:120)
  • The six public functions listed at includes/functions.php:5-11, versus the private helpers below the divider at :176-181

Document these in README.md with the public/private boundary made explicit. Broader extensibility architecture stays deferred.

Metadata

Metadata

Assignees

No one assigned

    Labels

    [Area] REST APIIssues for the REST API subsystem[Type] DocumentationDocumentation to be added or enhanced[Type] EnhancementA suggestion for improvement of an existing feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions