WC_Privacy_Background_Process
extends WC_Background_Process
in package
WC_Privacy_Background_Process class.
Table of Contents
- __construct() : mixed
- Initiate new background process.
- delete_all_batches() : WC_Background_Process
- Delete all batches.
- kill_process() : mixed
- Kill process.
- schedule_cron_healthcheck() : array<string|int, mixed>
- Schedule cron healthcheck.
- batch_limit_exceeded() : bool
- See if the batch limit has been exceeded.
- get_batch() : stdClass
- Get batch.
- get_memory_limit() : int
- Get memory limit.
- handle() : mixed
- Handle.
- is_queue_empty() : bool
- Is queue empty.
- task() : bool
- Code to execute for each item in the queue
Methods
__construct()
Initiate new background process.
public
__construct() : mixed
Return values
mixed —delete_all_batches()
Delete all batches.
public
delete_all_batches() : WC_Background_Process
Return values
WC_Background_Process —kill_process()
Kill process.
public
kill_process() : mixed
Stop processing queue items, clear cronjob and delete all batches.
Return values
mixed —schedule_cron_healthcheck()
Schedule cron healthcheck.
public
schedule_cron_healthcheck(array<string|int, mixed> $schedules) : array<string|int, mixed>
Parameters
- $schedules : array<string|int, mixed>
-
Schedules.
Return values
array<string|int, mixed> —batch_limit_exceeded()
See if the batch limit has been exceeded.
protected
batch_limit_exceeded() : bool
Return values
bool —get_batch()
Get batch.
protected
get_batch() : stdClass
Return values
stdClass — Return the first batch from the queue.get_memory_limit()
Get memory limit.
protected
get_memory_limit() : int
Return values
int —handle()
Handle.
protected
handle() : mixed
Pass each queue item to the task handler, while remaining within server memory and time limit constraints.
Return values
mixed —is_queue_empty()
Is queue empty.
protected
is_queue_empty() : bool
Return values
bool —task()
Code to execute for each item in the queue
protected
task(string $item) : bool
Parameters
- $item : string
-
Queue item to iterate over.