Download the PHP package underpin/batch-task-loader without Composer
On this page you can find all versions of the php package underpin/batch-task-loader. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download underpin/batch-task-loader
More information about underpin/batch-task-loader
Files in underpin/batch-task-loader
Package batch-task-loader
Short Description Batch task Loader for Underpin
License GPL-2.0-or-later
Informations about the package batch-task-loader
Underpin batch task Loader
Loader That assists with adding batch tasks to a WordPress website.
Installation
Using Composer
composer require underpin/batch-task-loader
Manually
This plugin uses a built-in autoloader, so as long as it is required before Underpin, it should work as-expected.
require_once(__DIR__ . '/underpin-batch-tasks/batch-tasks.php');
Setup
- Install Underpin. See Underpin Docs
- Register new batch tasks as-needed.
Batch tasks
As a plugin matures, the need to break a big task (like replacing the value of every record in a database) into smaller tasks (replace 20 records until all are replaced) becomes commonplace.
The problem is, WordPress doesn't provide a way to create these tasks easily. This loader makes it possible to register and build your own batch tasks quickly.
Example
A very basic example could look something like this.
Alternatively, you can extend batch task
and reference the extended class directly, like so:
This is especially useful when using batch tasks, since they have a tendency to get quite long, and nest deep.
Enqueuing the batch notice
Once a batch task is registered, you can instruct Underpin to display the admin notice to run this task like so:
This will add a batch task notice to the admin area. Once clicked, the batch task will run, with a progress bar to indicate progress. When complete, it will self-close.
All versions of batch-task-loader with dependencies
underpin/style-loader Version ^1.0
underpin/underpin Version ^2.0