https://github.com/reaktivstudios/locomotive

Allow developers to easily register batch processes through code, and run them through the admin UI
https://github.com/reaktivstudios/locomotive

Last synced: about 1 month ago
JSON representation

Allow developers to easily register batch processes through code, and run them through the admin UI

• Host: GitHub
• URL: https://github.com/reaktivstudios/locomotive
• Owner: reaktivstudios
• Created: 2015-09-16T20:01:02.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-12-07T18:46:19.000Z (about 4 years ago)
• Last Synced: 2024-06-27T11:36:40.921Z (6 months ago)
• Language: PHP
• Homepage:
• Size: 822 KB
• Stars: 192
• Watchers: 21
• Forks: 11
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• awesome-wp-developer-tools - Locomotive - Run custom batch processes from the WP admin. (WordPress Plugins)

README

        
Locomotive

==========

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/reaktivstudios/locomotive/badges/quality-score.png?b=master&s=86399ae1ed8459dbcaa0c4a5d5e34947d7454cf8)](https://scrutinizer-ci.com/g/reaktivstudios/locomotive/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/reaktivstudios/locomotive/badges/coverage.png?b=master&s=656ebaea7636b3882b1834f7226c53327e826bb2)](https://scrutinizer-ci.com/g/reaktivstudios/locomotive/?branch=master)

## About

![Locomotive Logo](logo.png?raw=true "Locomotive Logo")

Creating batch processes in WordPress has never been so easy. If you've ever wanted to query a large dataset and perform simple and repeatable actions, then Locomotive is for you.

Locomotive allows developers to write a single function (or set of functions) to process actions across a large data set. These registered batch processes can be run with the click of a button from the WP admin as needed. Locomotive handles the complexity of batch processing by automatically chunking up data, checking for records that have already been processed and logging errors as they come in.

## Links

* [Documentation](https://github.com/reaktivstudios/locomotive/wiki)

* [Examples](https://github.com/reaktivstudios/locomotive/wiki/Examples)

## Quick Start Example

#### Register a standard post query

``` php

function my_post_query_batch_process() {

	register_batch_process( array(

		'name'     => 'Just another batch',

		'type'     => 'post',

		'callback' => 'my_callback_function',

		'args'     => array(

			'posts_per_page' => 1,

			'post_type'      => 'post',

		),

	) );

}

add_action( 'locomotive_init', 'my_post_query_batch_process' );

```

#### Hook In Callback Function

``` php

/**

 * This is what we want to do with each individual result during a batch routine.

 *

 * @param  array $result Individual result from batch query.

 */

function my_callback_function( $result ) {

	error_log( print_r( $result->post_title, true ) );

}

```

#### Start Batch Process

![Locomotive Menu](screenshot.gif?raw=true "Locomotive Menu")

Navigate to Tools->Batches in the admin, select your batch, and click _Run_.

## Contributors

* [Josh Eaton](https://github.com/jjeaton)

* [Zach Wills](https://github.com/zachwills)

* [Andrew Norcross](https://github.com/norcross)

* [Jay Hoffmann](https://github.com/JasonHoffmann)

## Changelog

See [CHANGELOG.md](CHANGELOG.md).

#### [Pull requests](https://github.com/reaktivstudios/locomotive/pulls) are very much welcome and encouraged.