feat: add --all flag to comment delete command

Author: shawnhooper

features/comment.feature

@@ -472,3 +472,80 @@ Feature: Manage WordPress comments
     And I run `wp comment unspam {COMMENT_ID} --url=www.example.com`
     And I run `wp comment trash {COMMENT_ID} --url=www.example.com`
     And I run `wp comment untrash {COMMENT_ID} --url=www.example.com`
+
+  Scenario: Delete all comments with --all flag
+    Given a WP install
+    And I run `wp comment create --comment_post_ID=1 --comment_content='Comment 1' --porcelain`
+    And save STDOUT as {COMMENT_ID_1}
+    And I run `wp comment create --comment_post_ID=1 --comment_content='Comment 2' --porcelain`
+    And save STDOUT as {COMMENT_ID_2}
+    And I run `wp comment create --comment_post_ID=1 --comment_content='Comment 3' --porcelain`
+    And save STDOUT as {COMMENT_ID_3}
+
+    When I run `wp comment list --format=count`
+    Then STDOUT should be:
+      """
+      4
+      """
+
+    When I run `wp comment delete --all`
+    Then STDOUT should be:
+      """
+      Success: Trashed comment 1.
+      Success: Trashed comment {COMMENT_ID_1}.
+      Success: Trashed comment {COMMENT_ID_2}.
+      Success: Trashed comment {COMMENT_ID_3}.
+      """
+
+    When I run `wp comment list --format=count`
+    Then STDOUT should be:
+      """
+      0
+      """
+
+  Scenario: Delete all comments with --all flag and --force
+    Given a WP install
+    And I run `wp comment create --comment_post_ID=1 --comment_content='Comment 1' --porcelain`
+    And save STDOUT as {COMMENT_ID_1}
+    And I run `wp comment create --comment_post_ID=1 --comment_content='Comment 2' --porcelain`
+    And save STDOUT as {COMMENT_ID_2}
+
+    When I run `wp comment list --format=count`
+    Then STDOUT should be:
+      """
+      3
+      """
+
+    When I run `wp comment delete --all --force`
+    Then STDOUT should be:
+      """
+      Success: Deleted comment 1.
+      Success: Deleted comment {COMMENT_ID_1}.
+      Success: Deleted comment {COMMENT_ID_2}.
+      """
+
+    When I run `wp comment list --format=count`
+    Then STDOUT should be:
+      """
+      0
+      """
+
+  Scenario: Delete all comments when no comments exist
+    Given a WP install
+    And I run `wp comment delete $(wp comment list --field=ID) --force`
+
+    When I run `wp comment delete --all`
+    Then STDOUT should be:
+      """
+      Success: No comments deleted.
+      """
+
+  Scenario: Error when no comment IDs and no --all flag provided
+    Given a WP install
+
+    When I try `wp comment delete`
+    Then STDERR should be:
+      """
+      Error: Please specify one or more comment IDs, or use --all.
+      """
+    And the return code should be 1

src/Comment_Command.php

@@ -16,7 +16,7 @@
  *     # Update an existing comment.
  *     $ wp comment update 123 --comment_author='That Guy'
  *     Success: Updated comment 123.
- *
+
  *     # Delete an existing comment.
  *     $ wp comment delete 1337 --force
  *     Success: Deleted comment 1337.
@@ -416,9 +416,12 @@ function ( $comment ) {
 	 *
 	 * ## OPTIONS
 	 *
-	 * <id>...
+	 * [<id>...]
 	 * : One or more IDs of comments to delete.
 	 *
+	 * [--all]
+	 * : If set, all comments will be deleted.
+	 *
 	 * [--force]
 	 * : Skip the trash bin.
 	 *
@@ -432,8 +435,22 @@ function ( $comment ) {
 	 *     $ wp comment delete 1337 2341 --force
 	 *     Success: Deleted comment 1337.
 	 *     Success: Deleted comment 2341.
+	 *
+	 *     # Delete all comments.
+	 *     $ wp comment delete --all --force
+	 *     Success: Deleted comment 1337.
+	 *     Success: Deleted comment 2341.
+	 *     Success: Deleted 2 of 2 comments.
 	 */
 	public function delete( $args, $assoc_args ) {
+		$all = Utils\get_flag_value( $assoc_args, 'all', false );
+
+		// Check if comment IDs or --all is passed.
+		$args = $this->check_optional_args_and_all( $args, $all, 'delete' );
+		if ( ! $args ) {
+			return;
+		}
+
 		parent::_delete(
 			$args,
 			$assoc_args,
@@ -734,4 +751,56 @@ public function exists( $args ) {
 			WP_CLI::success( "Comment with ID {$args[0]} exists." );
 		}
 	}
+
+	/**
+	 * If have optional args ([<id>...]) and an all option, then check have something to do.
+	 *
+	 * @param array  $args Passed-in arguments.
+	 * @param bool   $all All flag.
+	 * @param string $verb Optional. Verb to use. Defaults to 'delete'.
+	 * @param string $exclude Comma separated list of comment IDs.
+	 * @return array Same as $args if not all, otherwise all comment IDs.
+	 * @throws ExitException If neither comment ID nor --all were provided.
+	 */
+	private function check_optional_args_and_all( $args, $all, $verb = 'delete', $exclude = null ) {
+		if ( $all ) {
+			$args = $this->get_all_comment_ids();
+		}
+
+		if ( $all && $exclude ) {
+			$exclude_list = array_map( 'intval', explode( ',', trim( $exclude, ',' ) ) );
+			$args         = array_filter(
+				$args,
+				static function ( $id ) use ( $exclude_list ) {
+					return ! in_array( (int) $id, $exclude_list, true );
+				}
+			);
+		}
+
+		if ( empty( $args ) ) {
+			if ( ! $all ) {
+				WP_CLI::error( 'Please specify one or more comment IDs, or use --all.' );
+			}
+
+			$past_tense_verb = Utils\past_tense_verb( $verb );
+			WP_CLI::success( "No comments {$past_tense_verb}." );
+		}
+
+		return $args;
+	}
+
+	/**
+	 * Gets all available comment IDs.
+	 *
+	 * @return array Array of comment IDs.
+	 */
+	private function get_all_comment_ids() {
+		$query = new WP_Comment_Query();
+		$comments = $query->query( array(
+			'fields' => 'ids',
+			'number' => 0, // Get all comments
+		) );
+
+		return $comments;
+	}
 }