WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_HTTP_Polling_Sync_Server::get_updates()

WP_HTTP_Polling_Sync_Server::get_updates( string $room, int $client_id, int $cursor, bool $is_compactor ): array{

In this article

Back to top

This function’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.

Gets sync updates for a specific client from a room after a given cursor.

Description

Delegates cursor-based retrieval to the storage layer, then applies client-specific filtering and compaction logic.

Parameters

$roomstringrequired
Room identifier.
$client_idintrequired
Client identifier.
$cursorintrequired
Return updates after this cursor.
$is_compactorboolrequired
True if this client is nominated to perform compaction.

Return

array{ end_cursor: int, should_compact: bool, room: string, total_updates: int, updates: array<int, array{data: string, type: string}>, } Response data for this room.

Source

View all references View on Trac

Changelog

VersionDescription
7.0.0Introduced.

User Contributed Notes

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