mirror of
https://gh.wpcy.net/https://github.com/wp-cli/handbook.git
synced 2026-05-04 11:39:00 +08:00
128 lines
5 KiB
Markdown
128 lines
5 KiB
Markdown
# wp comment list
|
|
|
|
Gets a list of comments.
|
|
|
|
Display comments based on all arguments supported by
|
|
[WP_Comment_Query()](https://developer.wordpress.org/reference/classes/WP_Comment_Query/__construct/).
|
|
|
|
### OPTIONS
|
|
|
|
[\--<field>=<value>]
|
|
: One or more args to pass to WP_Comment_Query.
|
|
|
|
[\--field=<field>]
|
|
: Prints the value of a single field for each comment.
|
|
|
|
[\--fields=<fields>]
|
|
: Limit the output to specific object fields.
|
|
|
|
[\--format=<format>]
|
|
: Render output in a particular format.
|
|
\---
|
|
default: table
|
|
options:
|
|
- table
|
|
- ids
|
|
- csv
|
|
- json
|
|
- count
|
|
- yaml
|
|
\---
|
|
|
|
### AVAILABLE FIELDS
|
|
|
|
These fields will be displayed by default for each comment:
|
|
|
|
* comment_ID
|
|
* comment_post_ID
|
|
* comment_date
|
|
* comment_approved
|
|
* comment_author
|
|
* comment_author_email
|
|
|
|
These fields are optionally available:
|
|
|
|
* comment_author_url
|
|
* comment_author_IP
|
|
* comment_date_gmt
|
|
* comment_content
|
|
* comment_karma
|
|
* comment_agent
|
|
* comment_type
|
|
* comment_parent
|
|
* user_id
|
|
* url
|
|
|
|
### EXAMPLES
|
|
|
|
# List comment IDs.
|
|
$ wp comment list --field=ID
|
|
22
|
|
23
|
|
24
|
|
|
|
# List comments of a post.
|
|
$ wp comment list --post_id=1 --fields=ID,comment_date,comment_author
|
|
+------------+---------------------+----------------+
|
|
| comment_ID | comment_date | comment_author |
|
|
+------------+---------------------+----------------+
|
|
| 1 | 2015-06-20 09:00:10 | Mr WordPress |
|
|
+------------+---------------------+----------------+
|
|
|
|
# List approved comments.
|
|
$ wp comment list --number=3 --status=approve --fields=ID,comment_date,comment_author
|
|
+------------+---------------------+----------------+
|
|
| comment_ID | comment_date | comment_author |
|
|
+------------+---------------------+----------------+
|
|
| 1 | 2015-06-20 09:00:10 | Mr WordPress |
|
|
| 30 | 2013-03-14 12:35:07 | John Doe |
|
|
| 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 |
|
|
+------------+---------------------+----------------+
|
|
|
|
### GLOBAL PARAMETERS
|
|
|
|
These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress.
|
|
|
|
| **Argument** | **Description** |
|
|
|:----------------|:-----------------------------|
|
|
| `--path=<path>` | Path to the WordPress files. |
|
|
| `--url=<url>` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. |
|
|
| `--ssh=[<scheme>:][<user>@]<host\|container>[:<port>][<path>]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "docker-compose-run", "vagrant"). |
|
|
| `--http=<http>` | Perform operation against a remote WordPress installation over HTTP. |
|
|
| `--user=<id\|login\|email>` | Set the WordPress user. |
|
|
| `--skip-plugins[=<plugins>]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. |
|
|
| `--skip-themes[=<themes>]` | Skip loading all themes, or a comma-separated list of themes. |
|
|
| `--skip-packages` | Skip loading all installed packages. |
|
|
| `--require=<path>` | Load PHP file before running the command (may be used more than once). |
|
|
| `--exec=<php-code>` | Execute PHP code before running the command (may be used more than once). |
|
|
| `--context=<context>` | Load WordPress in a given context. |
|
|
| `--[no-]color` | Whether to colorize the output. |
|
|
| `--debug[=<group>]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. |
|
|
| `--prompt[=<assoc>]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. |
|
|
| `--quiet` | Suppress informational messages. |
|
