Doc update.

This commit is contained in:
Vedanshu Jain 2023-09-05 16:40:24 +05:30
parent 1d0665a8dd
commit 452a3ed81b
1 changed files with 2 additions and 2 deletions

View File

@ -1113,8 +1113,8 @@ WHERE
$data_sync_enabled = $data_synchronizer->data_sync_is_enabled();
if ( $data_sync_enabled ) {
/**
* Allow opportunity to disable sync on read, while keeping sync on write disabled. This adds another step as a large shop progresses from full sync to no sync with HPOS authoritative.
* This filter is only executed if data sync is enabled from settings in the first place as it's meant to be a step between full sync -> no sync, rather than be a control for enabling just the read on sync. Sync on read without sync on write is problematic as any update will reset on the next read, but sync on write without sync on read is fine.
* Allow opportunity to disable sync on read, while keeping sync on write enabled. This adds another step as a large shop progresses from full sync to no sync with HPOS authoritative.
* This filter is only executed if data sync is enabled from settings in the first place as it's meant to be a step between full sync -> no sync, rather than be a control for enabling just the sync on read. Sync on read without sync on write is problematic as any update will reset on the next read, but sync on write without sync on read is fine.
*
* @param bool $read_on_sync_enabled Whether to sync on read.
*