Download the PHP package gdarko/wp-batch-processing without Composer
On this page you can find all versions of the php package gdarko/wp-batch-processing. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gdarko/wp-batch-processing
More information about gdarko/wp-batch-processing
Files in gdarko/wp-batch-processing
Package wp-batch-processing
Short Description Easily process large batches of data in WordPress. Provide the data, setup the processing procedure, run the batch processor from the admin dashboard. Profit.
License GPL-2.0-or-later
Informations about the package wp-batch-processing
WP Batch Processing
WP Batch Processing is WordPress plugin for creating batches of data and processing the data items one by one. It allows you to define a batch and to process the queued batch items one by one. There is also option to resume/continue later in case your internet connection goes down.
Installation
There are two ways to install this library:
-
Install this library as a plugin. It doesn't require anything from below or,
- Install it as a composer package (read the notes bellow)
Note: The boot()
method should be called only if you install the plugin via composer somewhere in your plugin or theme.
Note: If using composer, the library will attempt to find its path, however if you see messed up screen it means that it was unable to find the stylesheet/JS files and you will need to define them manually before boot()
method.
How it works
To define a batch you just need to extend the class WP_Batch
and later register it. Follow the examples below to learn how.
The class provides the following attributes and methods
$id
- Identifies the batch (must be unique),$title
- Shown in the admin area,setup()
- Method that you use it to fed your data withWP_Batch_Item
instances,process(WP_Batch_Item $item)
- Method that will be used to process each next item in the batch
After creating the class, class instance needs to be registered in order to be available in the batches list in the admin area.
That's it.
Filters and Actions
Set delay between processing items. Default is 0 (no delay)
Example use cases
The tool can be used in many different ways. For example
- Importing data
- Downloading data
- Emailing
- Database modifications
Contribute
If you notice a bug or you want to propose improvements feel free to create a pull request!
License
The plugin is licensed under GPL v2