class WP_HTTP_Polling_Sync_Server {}

In this article

This class’s access is marked private. This means it is not intended for use by plugin or theme developers, only by core. It is listed here for completeness.

Core class that contains an HTTP server used for collaborative editing.

Methods

NameDescription
WP_HTTP_Polling_Sync_Server::__constructConstructor.
WP_HTTP_Polling_Sync_Server::add_updateAdds an update to a room’s update list via storage.
WP_HTTP_Polling_Sync_Server::can_user_sync_entity_typeChecks if the current user can sync a specific entity type.
WP_HTTP_Polling_Sync_Server::check_permissionsChecks if the current user has permission to access a room.
WP_HTTP_Polling_Sync_Server::get_updatesGets sync updates for a specific client from a room after a given cursor.
WP_HTTP_Polling_Sync_Server::handle_requestHandles request: stores sync updates and awareness data, and returns updates the client is missing.
WP_HTTP_Polling_Sync_Server::process_awareness_updateProcesses and stores an awareness update from a client.
WP_HTTP_Polling_Sync_Server::process_sync_updateProcesses a sync update based on its type.
WP_HTTP_Polling_Sync_Server::register_routesRegisters REST API routes.
WP_HTTP_Polling_Sync_Server::validate_requestValidates that the request body does not exceed the maximum allowed size.

Source

Changelog

VersionDescription
7.0.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.