README

WP Job Scheduler

🚧 This package is still work in progress

This package is an attempt to make job dispatching and scheduling easier in WordPress.

Inspired by the syntax of Laravel and using Action Scheduler from WooCommerce, for more reliable handeling.

Installation

composer require jeffreyvanrossum/wp-job-scheduler

Usage

Setup

Within your theme or plugin, add:

WPJobScheduler::instance()
    ->projectRootPath(__DIR__)
    ->scheduler(function() {
        ExampleJob::schedule('hourly');
    })
    ->boot();

Dispatching single jobs

ExampleJob::dispatch();

You may pass a callback to do some changes on the job before it is dispatched:

ExampleJob::dispatch(function($job) {
    $job->withDelay(30);
});

You may also pass some initial constructor arguments:

ExampleJob::dispatch(function($job) {
    $job->withDelay(30);
}, ['foo' => 'bar']);

Example Job

class ExampleJob implements Jobable
{
    use IsJob, Schedulable, Dispatchable;

    public function handle()
    {
        // the actual handling of the job
    }

    public function before(): void
    {
        // before the job has been handled
    }

    public function after(): void
    {
        // after the job has been handled
    }

    public function catch(Throwable $e): void
    {
        // do something with exception
    }
}

Contributors

• Jeffrey van Rossum
• All contributors

License

MIT. Please see the License File for more information.