Add examples on listing unapproved, spam and trash comments (#436)

* Add examples on listing unapproved, spam and trash comments * Update README too --------- Co-authored-by: Daniel Bachhuber <[email protected]>
wp-cli · Nov 10, 2023 · 0cd4840 · 0cd4840
1 parent cb7fe53
commit 0cd4840
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -341,6 +341,32 @@ These fields are optionally available:
     | 29         | 2013-03-14 11:56:08 | Jane Doe       |
     +------------+---------------------+----------------+
 
+    # List unapproved comments.
+    $ wp comment list --number=3 --status=hold --fields=ID,comment_date,comment_author
+    +------------+---------------------+----------------+
+    | comment_ID | comment_date        | comment_author |
+    +------------+---------------------+----------------+
+    | 8          | 2023-11-10 13:13:06 | John Doe       |
+    | 7          | 2023-11-10 13:09:55 | Mr WordPress   |
+    | 9          | 2023-11-10 11:22:31 | Jane Doe       |
+    +------------+---------------------+----------------+
+
+    # List comments marked as spam.
+    $ wp comment list --status=spam --fields=ID,comment_date,comment_author
+    +------------+---------------------+----------------+
+    | comment_ID | comment_date        | comment_author |
+    +------------+---------------------+----------------+
+    | 2          | 2023-11-10 11:22:31 | Jane Doe       |
+    +------------+---------------------+----------------+
+
+    # List comments in trash.
+    $ wp comment list --status=trash --fields=ID,comment_date,comment_author
+    +------------+---------------------+----------------+
+    | comment_ID | comment_date        | comment_author |
+    +------------+---------------------+----------------+
+    | 3          | 2023-11-10 11:22:31 | John Doe       |
+    +------------+---------------------+----------------+
+
 
 
 ### wp comment meta

diff --git a/src/Comment_Command.php b/src/Comment_Command.php
@@ -335,6 +335,32 @@ public function get( $args, $assoc_args ) {
 	 *     | 29         | 2013-03-14 11:56:08 | Jane Doe       |
 	 *     +------------+---------------------+----------------+
 	 *
+	 *     # List unapproved comments.
+	 *     $ wp comment list --number=3 --status=hold --fields=ID,comment_date,comment_author
+	 *     +------------+---------------------+----------------+
+	 *     | comment_ID | comment_date        | comment_author |
+	 *     +------------+---------------------+----------------+
+	 *     | 8          | 2023-11-10 13:13:06 | John Doe       |
+	 *     | 7          | 2023-11-10 13:09:55 | Mr WordPress   |
+	 *     | 9          | 2023-11-10 11:22:31 | Jane Doe       |
+	 *     +------------+---------------------+----------------+
+	 *
+	 *     # List comments marked as spam.
+	 *     $ wp comment list --status=spam --fields=ID,comment_date,comment_author
+	 *     +------------+---------------------+----------------+
+	 *     | comment_ID | comment_date        | comment_author |
+	 *     +------------+---------------------+----------------+
+	 *     | 2          | 2023-11-10 11:22:31 | Jane Doe       |
+	 *     +------------+---------------------+----------------+
+	 *
+	 *     # List comments in trash.
+	 *     $ wp comment list --status=trash --fields=ID,comment_date,comment_author
+	 *     +------------+---------------------+----------------+
+	 *     | comment_ID | comment_date        | comment_author |
+	 *     +------------+---------------------+----------------+
+	 *     | 3          | 2023-11-10 11:22:31 | John Doe       |
+	 *     +------------+---------------------+----------------+
+	 *
 	 * @subcommand list
 	 */
 	public function list_( $args, $assoc_args ) {