Migration interface

[dlh01]

Description

We have used an interface like this on a few projects to moderate success:

/**
 * Describes a database alteration.
 */
interface Migration {
	/**
	 * Apply the migration.
	 *
	 * @phpstan-param array<int, string>    $args
	 * @phpstan-param array<string, string> $assoc_args
	 *
	 * @param array $args       Positional arguments.
	 * @param array $assoc_args Associative arguments.
	 */
	public function up( $args, $assoc_args = [] ): void;

	/**
	 * Reverse the migration.
	 *
	 * @phpstan-param array<int, string>    $args
	 * @phpstan-param array<string, string> $assoc_args
	 *
	 * @param array $args       Positional arguments.
	 * @param array $assoc_args Associative arguments.
	 */
	public function down( $args, $assoc_args = [] ): void;
}

However, the signatures are closely coupled to WP-CLi commands. There could perhaps be a decorator instead that adapts a migration object to a CLI command.

Use Case

Changing post meta in bulk, updating post terms in bulk, etc.