Feature: adding the --ignore-group CLI option

classes/WP_CLI/ActionScheduler_WPCLI_Scheduler_command.php

@@ -55,6 +55,9 @@ public function fix_schema( $args, $assoc_args ) {
 	 * [--group=<group>]
 	 * : Only run actions from the specified group. Omitting this option runs actions from all groups.
 	 *
+	 * [--ignore-group=<group>]
+	 * : Run actions by omiting the specified group. Omitting this option runs actions from all groups.
+	 *
 	 * [--free-memory-on=<count>]
 	 * : The number of actions to process between freeing memory. 0 disables freeing memory. Default 50.
 	 *
@@ -82,13 +85,29 @@ public function run( $args, $assoc_args ) {
 		$sleep   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'pause', 0 );
 		$force   = \WP_CLI\Utils\get_flag_value( $assoc_args, 'force', false );
 
+		$ignore_group = \WP_CLI\Utils\get_flag_value( $assoc_args, 'ignore-group', '' );
+
 		ActionScheduler_DataController::set_free_ticks( $free_on );
 		ActionScheduler_DataController::set_sleep_time( $sleep );
 
 		$batches_completed = 0;
 		$actions_completed = 0;
 		$unlimited         = $batches === 0;
 
+		if ( ! $group && $ignore_group ) { // there is no need to proceed with the ignore code if $group is set.
+
+			$ignore_group_array = array_map(
+				function ( $val ) {
+					return ActionScheduler_DBStore::mark_group_for_exclusion( $val );
+				},
+				explode( ',', $ignore_group )
+			);
+
+			if ( count( $ignore_group_array ) ) {
+				$group .= ',' . implode( ',', $ignore_group_array );
+			}
+		}
+
 		try {
 			// Custom queue cleaner instance.
 			$cleaner = new ActionScheduler_QueueCleaner( null, $clean );

classes/abstracts/ActionScheduler_Store.php

@@ -5,12 +5,13 @@
  * @codeCoverageIgnore
  */
 abstract class ActionScheduler_Store extends ActionScheduler_Store_Deprecated {
-	const STATUS_COMPLETE = 'complete';
-	const STATUS_PENDING  = 'pending';
-	const STATUS_RUNNING  = 'in-progress';
-	const STATUS_FAILED   = 'failed';
-	const STATUS_CANCELED = 'canceled';
-	const DEFAULT_CLASS   = 'ActionScheduler_wpPostStore';
+	const STATUS_COMPLETE       = 'complete';
+	const STATUS_PENDING        = 'pending';
+	const STATUS_RUNNING        = 'in-progress';
+	const STATUS_FAILED         = 'failed';
+	const STATUS_CANCELED       = 'canceled';
+	const DEFAULT_CLASS         = 'ActionScheduler_wpPostStore';
+	const IGNORE_GROUP_FLAG     = '--*IGNORE*--';
 
 	/** @var ActionScheduler_Store */
 	private static $store = NULL;
@@ -236,6 +237,41 @@ abstract public function get_claim_id( $action_id );
 	 */
 	abstract public function find_actions_by_claim_id( $claim_id );
 
+	/**
+	 * Check if group name is prefixed for exclussion.
+	 *
+	 * @param string $slug Group slug name.
+	 * @return boolean
+	 */
+	protected static function group_has_ignore_prefix( $slug ) {
+		return self::IGNORE_GROUP_FLAG === substr( $slug, 0, strlen( self::IGNORE_GROUP_FLAG ) );
+	}
+
+	/**
+	 * Mark group for exclusion by applying a special prefix (by default, the value of
+	 * the IGNORE_GROUP_FLAG property).
+	 *
+	 * @param string $slug Group slug name.
+	 * @return string
+	 */
+	public static function mark_group_for_exclusion( $slug ) {
+		return $slug ? self::IGNORE_GROUP_FLAG . $slug : $slug;
+	}
+
+	/**
+	 * Sanitize group name.
+	 *
+	 * @param string $slug Group slug name.
+	 * @return string
+	 */
+	public static function sanitize_group_name( $slug ) {
+		// removing the ignored group prefix from slug if present.
+		$slug = preg_replace( '/^(' . preg_quote( self::IGNORE_GROUP_FLAG, null ) . ')?(.*)/m', '$2', esc_sql( $slug ) );
+
+		// further sanitisation here with `sanitize_title` maybe?
+		return $slug;
+	}
+
 	/**
 	 * @param string $comparison_operator
 	 * @return string

classes/data-stores/ActionScheduler_DBStore.php

@@ -267,11 +267,18 @@ protected function get_group_id( $slug, $create_if_not_exists = true ) {
 	 * @param string $slug Group slug.
 	 *
 	 * @return int Group ID.
+	 * @throws \InvalidArgumentException Throws exception when the group slug starts with IGNORE_GROUP_FLAG.
 	 */
 	protected function create_group( $slug ) {
 		/** @var \wpdb $wpdb */
 		global $wpdb;
-		$wpdb->insert( $wpdb->actionscheduler_groups, array( 'slug' => $slug ) );
+
+		if ( self::group_has_ignore_prefix( $slug ) ) {
+			// translators: %s: ignored group name prefix.
+			throw new InvalidArgumentException( sprintf( esc_html__( 'Group names cannot start with %s.', 'action-scheduler' ), self::IGNORE_GROUP_FLAG ) );
+		}
+
+		$wpdb->insert( $wpdb->actionscheduler_groups, array( 'slug' => $slug ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
 
 		return (int) $wpdb->insert_id;
 	}
@@ -803,7 +810,7 @@ protected function generate_claim_id() {
 	 * @param int       $limit Number of action to include in claim.
 	 * @param \DateTime $before_date Should use UTC timezone.
 	 * @param array     $hooks Hooks to filter for.
-	 * @param string    $group Group to filter for.
+	 * @param string    $group Comma-separated list of groups to filter by. Adding IGNORE_GROUP_FLAG in front of a group will cause it to be ignored.
 	 *
 	 * @return int The number of actions that were claimed.
 	 * @throws \InvalidArgumentException Throws InvalidArgumentException if group doesn't exist.
@@ -834,18 +841,38 @@ protected function claim_actions( $claim_id, $limit, \DateTime $before_date = nu
 			$params       = array_merge( $params, array_values( $hooks ) );
 		}
 
-		if ( ! empty( $group ) ) {
+		$group_array = array_filter( explode( ',', $group ) );
+
+		$ignore_group_ids  = array();
+		$include_group_ids = array();
+
+		if ( is_array( $group_array ) && count( $group_array ) ) {
 
-			$group_id = $this->get_group_id( $group, false );
+			foreach ( $group_array as $group ) {
 
-			// throw exception if no matching group found, this matches ActionScheduler_wpPostStore's behaviour.
-			if ( empty( $group_id ) ) {
-				/* translators: %s: group name */
-				throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'action-scheduler' ), $group ) );
+				$sanitized_group_name = self::sanitize_group_name( $group );
+				$group_id             = $this->get_group_id( $sanitized_group_name, false );
+
+				// throw exception if no matching group found, this matches ActionScheduler_wpPostStore's behaviour.
+				if ( empty( $group_id ) ) {
+					/* translators: %s: group name */
+					throw new InvalidArgumentException( sprintf( __( 'The group "%s" does not exist.', 'action-scheduler' ), $sanitized_group_name ) );
+				}
+
+				if ( self::group_has_ignore_prefix( $group ) ) {
+					$ignore_group_ids[] = $group_id;
+				} else {
+					$include_group_ids[] = $group_id;
+				}
 			}
+		}
 
-			$where    .= ' AND group_id = %d';
-			$params[] = $group_id;
+		if ( count( $include_group_ids ) ) {
+			$where   .= ' AND group_id IN (%s)';
+			$params[] = implode( ',', $include_group_ids );
+		} elseif ( count( $ignore_group_ids ) ) {
+			$where   .= ' AND group_id NOT IN (%s)';
+			$params[] = implode( ',', $ignore_group_ids );
 		}
 
 		/**

docs/wp-cli.md

@@ -29,7 +29,8 @@ These are the commands available to use with Action Scheduler:
     * `--batch-size` - This is the number of actions to run in a single batch. The default is `100`.
     * `--batches` - This is the number of batches to run. Using 0 means that batches will continue running until there are no more actions to run.
     * `--hooks` - Process only actions with specific hook or hooks, like `'woocommerce_scheduled_subscription_payment'`. By default, actions with any hook will be processed. Define multiple hooks as a comma separated string (without spaces), e.g. `--hooks=woocommerce_scheduled_subscription_trial_end,woocommerce_scheduled_subscription_payment,woocommerce_scheduled_subscription_expiration`
-    * `--group` - Process only actions in a specific group, like `'woocommerce-memberships'`. By default, actions in any group (or no group) will be processed.
+    * `--group` - Process only actions in a specific group, like `'woocommerce-memberships'`. By default, actions in any group (or no group) will be processed. Accepts comma-separated list of groups to filter by. Adding --*IGNORE*-- in front of a group will cause it to be ignored.
+    * `--ignore-group` - Ignore processing actions from groups found inside the comma separated list of values.
     * `--force` - By default, Action Scheduler limits the number of concurrent batches that can be run at once to ensure the server does not get overwhelmed. Using the `--force` flag overrides this behavior to force the WP CLI queue to run.
 
 The best way to get a full list of commands and their available options is to use WP CLI itself. This can be done by running `wp action-scheduler` to list all Action Scheduler commands, or by including the `--help` flag with any of the individual commands. This will provide all relevant parameters and flags for the command.