PHPackages                             gdarko/wp-batch-processing - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. gdarko/wp-batch-processing

ActiveLibrary[Utility & Helpers](/categories/utility)

gdarko/wp-batch-processing
==========================

Easily process large batches of data in WordPress. Provide the data, setup the processing procedure, run the batch processor from the admin dashboard. Profit.

1.2.0(2y ago)1295.9k↓59.4%27[6 issues](https://github.com/gdarko/wp-batch-processing/issues)[2 PRs](https://github.com/gdarko/wp-batch-processing/pulls)GPL-2.0-or-laterPHPPHP >=5.3

Since Oct 23Pushed 2y ago11 watchersCompare

[ Source](https://github.com/gdarko/wp-batch-processing)[ Packagist](https://packagist.org/packages/gdarko/wp-batch-processing)[ RSS](/packages/gdarko-wp-batch-processing/feed)WikiDiscussions master Synced yesterday

READMEChangelog (6)DependenciesVersions (6)Used By (0)

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.

[![Example](examples/processing.gif)](examples/processing.gif)

Installation
------------

[](#installation)

There are two ways to install this library:

1. Install this library as a plugin. It doesn't require anything from below or,
2. Install it as a composer package (read the **notes** bellow)

```
composer require gdarko/wp-batch-processing

```

```
WP_Batch_Processor::boot();
```

**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.

```
// Manually define the path constants to eliminate
// possible errors when resolving the paths and also
// include trailing slash at the end.

if ( ! defined('WP_BP_PATH')) {
    define('WP_BP_PATH', '/path/to/wp-content/plugins/your-plugin/libraries/wp-batch-processing/');
}

if ( ! defined('WP_BP_URL')) {
    define('WP_BP_URL', 'https://site.com/wp-content/plugins/your-plugin/libraries/wp-batch-processing/');
}

WP_Batch_Processor::boot();
```

How it works
------------

[](#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 with `WP_Batch_Item` instances,
- `process(WP_Batch_Item $item)` - Method that will be used to process each next item in the batch

```
if ( class_exists( 'WP_Batch' ) ) {

	/**
	 * Class MY_Example_Batch
	 */
	class MY_Example_Batch extends WP_Batch {

		/**
		 * Unique identifier of each batch
		 * @var string
		 */
		public $id = 'email_post_authors';

		/**
		 * Describe the batch
		 * @var string
		 */
		public $title = 'Email Post Authors';

		/**
		 * To setup the batch data use the push() method to add WP_Batch_Item instances to the queue.
		 *
		 * Note: If the operation of obtaining data is expensive, cache it to avoid slowdowns.
		 *
		 * @return void
		 */
		public function setup() {

			$users = get_users( array(
				'number' => '40',
				'role'   => 'author',
			) );

			foreach ( $users as $user ) {
				$this->push( new WP_Batch_Item( $user->ID, array( 'author_id' => $user->ID ) ) );
			}
		}

		/**
		 * Handles processing of batch item. One at a time.
		 *
		 * In order to work it correctly you must return values as follows:
		 *
		 * - TRUE - If the item was processed successfully.
		 * - WP_Error instance - If there was an error. Add message to display it in the admin area.
		 *
		 * @param WP_Batch_Item $item
		 *
		 * @return bool|\WP_Error
		 */
		public function process( $item ) {

			// Retrieve the custom data
			$author_id = $item->get_value( 'author_id' );

			// Return WP_Error if the item processing failed (In our case we simply skip author with user id 5)
			if ( $author_id == 5 ) {
				return new WP_Error( 302, "Author skipped" );
			}

			// Do the expensive processing here.
			// ...

			// Return true if the item processing is successful.
			return true;
		}

		/**
		 * Called when specific process is finished (all items were processed).
		 * This method can be overriden in the process class.
		 * @return void
		 */
		public function finish() {
			// Do something after process is finished.
			// You have $this->items, etc.
		}
	}
}
```

After creating the class, class instance needs to be registered in order to be available in the batches list in the admin area.

```
/**
 * Initialize the batches.
 */
function wp_batch_processing_init() {
    $batch = new MY_Example_Batch();
    WP_Batch_Processor::get_instance()->register( $batch );
}
add_action( 'wp_batch_processing_init', 'wp_batch_processing_init', 15, 1 );
```

That's it.

Filters and Actions
-------------------

[](#filters-and-actions)

Set delay between processing items. Default is 0 (no delay)

```
function wp_bp_my_custom_delay($delay) {
   return 2; // in seconds
}
add_filter('wp_batch_processing_delay', 'wp_bp_my_custom_delay', 10, 1);
```

Example use cases
-----------------

[](#example-use-cases)

The tool can be used in many different ways. For example

- Importing data
- Downloading data
- Emailing
- Database modifications

Contribute
----------

[](#contribute)

If you notice a bug or you want to propose improvements feel free to create a pull request!

License
-------

[](#license)

The plugin is licensed under GPL v2

```
Copyright (C) 2021 Darko Gjorgjijoski (https://darkog.com)

This file is part of WP Batch Processing

WP Batch Processing is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

WP Batch Processing is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with WP Batch Processing. If not, see .

```

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance19

Infrequent updates — may be unmaintained

Popularity40

Moderate usage in the ecosystem

Community21

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 84.4% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~174 days

Total

5

Last Release

1018d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/092968da21d868077ffac225d195f167f19435d61409f8ec656136c6f3d6f197?d=identicon)[gdarko](/maintainers/gdarko)

---

Top Contributors

[![gdarko](https://avatars.githubusercontent.com/u/5760249?v=4)](https://github.com/gdarko "gdarko (27 commits)")[![varunsridharan](https://avatars.githubusercontent.com/u/1884287?v=4)](https://github.com/varunsridharan "varunsridharan (2 commits)")[![d4mation](https://avatars.githubusercontent.com/u/7770631?v=4)](https://github.com/d4mation "d4mation (1 commits)")[![gmay-sbx](https://avatars.githubusercontent.com/u/253306146?v=4)](https://github.com/gmay-sbx "gmay-sbx (1 commits)")[![kknoer](https://avatars.githubusercontent.com/u/1834014?v=4)](https://github.com/kknoer "kknoer (1 commits)")

### Embed Badge

![Health badge](/badges/gdarko-wp-batch-processing/health.svg)

```
[![Health](https://phpackages.com/badges/gdarko-wp-batch-processing/health.svg)](https://phpackages.com/packages/gdarko-wp-batch-processing)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)