Download the PHP package thefrosty/wp-upgrade-task-runner without Composer
On this page you can find all versions of the php package thefrosty/wp-upgrade-task-runner. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download thefrosty/wp-upgrade-task-runner
More information about thefrosty/wp-upgrade-task-runner
Files in thefrosty/wp-upgrade-task-runner
Package wp-upgrade-task-runner
Short Description A WordPress plugin for developers to write custom migration tasks.
License MIT
Informations about the package wp-upgrade-task-runner
WordPress Upgrade Task Runner
Register custom migration tasks that can be triggered from a dashboard in the admin and run via AJAX.
Requirements
The required WordPress version will always be the most recent point release of the previous major release branch.
For both PHP and WordPress requirements, although this library may work with a version below the required versions, they will not be supported and any compatibility is entirely coincidental.
Installation
To install this library, use Composer:
Getting Started
If a new task is needed, there are only two required steps that are needed.
- A class needs to be created and this class needs to extend the
AbstractTaskRunner
class. See theExampleMigrationTask
example class. - Register the new task class via the
TaskLoader::REGISTER_TASKS_TAG
filter:
The task class
When a class is added, it needs to have a few pre-defined class values. Both the DATE and TITLE constant are required to be unique. These are what registers a one off cron task when manually running the task from the admin page.
The TaskLoader
Add the new class as a property in the TaskLoader
class and instantiate it in the register_tasks
method (just like
the ExampleMigrationTask
).
CLI
Run all registered tasks (not already run) via wp-cli: $ wp upgrade-task-runner
.
CLI OPTIONS
[--task=<class>] : The fully qualified registered task to run.
[--user=<id>] : The user ID to associate with running said task(s).
All versions of wp-upgrade-task-runner with dependencies
pimple/pimple Version ^3.5
symfony/http-foundation Version ~6.0 || ^7.0
thefrosty/wp-utilities Version ^3.3