webshell

Ghost Exploiter Team Official

C:/Program Files (x86)/Plesk/Additional/modules/wp-toolkit/wp-cli/vendor/wp-cli/entity-command/

File / Folder	Size	Action
.	-
features	--	ren
src	--	ren
LICENSE	1.125KB	edt ren
README.md	135.648KB	edt ren
behat.yml	0.123KB	edt ren
composer.json	7.035KB	edt ren
entity-command.php	2.924KB	edt ren
phpcs.xml.dist	3.448KB	edt ren
wp-cli.yml	0.031KB	edt ren

wp-cli/entity-command
=====================

Manage WordPress comments, menus, options, posts, sites, terms, and users.

[![Testing](https://github.com/wp-cli/entity-command/actions/workflows/testing.yml/badge.svg)](https://github.com/wp-cli/entity-command/actions/workflows/testing.yml)

Quick links: [Using](#using) | [Installing](#installing) | [Contributing](#contributing) | [Support](#support)

## Using

This package implements the following commands:

### wp comment

Creates, updates, deletes, and moderates comments.

~~~
wp comment
~~~

**EXAMPLES**

# Create a new comment.
    $ wp comment create --comment_post_ID=15 --comment_content="hello blog" --comment_author="wp-cli"
    Success: Created comment 932.

# 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.

# Trash all spam comments.
    $ wp comment delete $(wp comment list --status=spam --format=ids)
    Success: Trashed comment 264.
    Success: Trashed comment 262.

### wp comment approve

Approves a comment.

~~~
wp comment approve <id>...
~~~

**OPTIONS**

<id>...
		The IDs of the comments to approve.

**EXAMPLES**

# Approve comment.
    $ wp comment approve 1337
    Success: Approved comment 1337.

### wp comment count

Counts comments, on whole blog or on a given post.

~~~
wp comment count [<post-id>]
~~~

**OPTIONS**

[<post-id>]
		The ID of the post to count comments in.

**EXAMPLES**

# Count comments on whole blog.
    $ wp comment count
    approved:        33
    spam:            3
    trash:           1
    post-trashed:    0
    all:             34
    moderated:       1
    total_comments:  37

# Count comments in a post.
    $ wp comment count 42
    approved:        19
    spam:            0
    trash:           0
    post-trashed:    0
    all:             19
    moderated:       0
    total_comments:  19

### wp comment create

Creates a new comment.

~~~
wp comment create [--<field>=<value>] [--porcelain]
~~~

**OPTIONS**

[--<field>=<value>]
		Associative args for the new comment. See wp_insert_comment().

[--porcelain]
		Output just the new comment id.

**EXAMPLES**

# Create comment.
    $ wp comment create --comment_post_ID=15 --comment_content="hello blog" --comment_author="wp-cli"
    Success: Created comment 932.

### wp comment delete

Deletes a comment.

~~~
wp comment delete <id>... [--force]
~~~

**OPTIONS**

<id>...
		One or more IDs of comments to delete.

[--force]
		Skip the trash bin.

**EXAMPLES**

# Delete comment.
    $ wp comment delete 1337 --force
    Success: Deleted comment 1337.

# Delete multiple comments.
    $ wp comment delete 1337 2341 --force
    Success: Deleted comment 1337.
    Success: Deleted comment 2341.

### wp comment exists

Verifies whether a comment exists.

~~~
wp comment exists <id>
~~~

Displays a success message if the comment does exist.

**OPTIONS**

<id>
		The ID of the comment to check.

**EXAMPLES**

# Check whether comment exists.
    $ wp comment exists 1337
    Success: Comment with ID 1337 exists.

### wp comment generate

Generates some number of new dummy comments.

~~~
wp comment generate [--count=<number>] [--post_id=<post-id>] [--format=<format>]
~~~

Creates a specified number of new comments with dummy data.

**OPTIONS**

[--count=<number>]
		How many comments to generate?
		---
		default: 100
		---

[--post_id=<post-id>]
		Assign comments to a specific post.

[--format=<format>]
		Render output in a particular format.
		---
		default: progress
		options:
		  - progress
		  - ids
		---

**EXAMPLES**

# Generate comments for the given post.
    $ wp comment generate --format=ids --count=3 --post_id=123
    138 139 140

# Add meta to every generated comment.
    $ wp comment generate --format=ids --count=3 | xargs -d ' ' -I % wp comment meta add % foo bar
    Success: Added custom field.
    Success: Added custom field.
    Success: Added custom field.

### wp comment get

Gets the data of a single comment.

~~~
wp comment get <id> [--field=<field>] [--fields=<fields>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The comment to get.

[--field=<field>]
		Instead of returning the whole comment, returns the value of a single field.

[--fields=<fields>]
		Limit the output to specific fields. Defaults to all fields.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - yaml
		---

**EXAMPLES**

# Get comment.
    $ wp comment get 21 --field=content
    Thanks for all the comments, everyone!

### wp comment list

Gets a list of comments.

~~~
wp comment list [--<field>=<value>] [--field=<field>] [--fields=<fields>] [--format=<format>]
~~~

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       |
    +------------+---------------------+----------------+

### wp comment meta

Adds, updates, deletes, and lists comment custom fields.

~~~
wp comment meta
~~~

**EXAMPLES**

# Set comment meta
    $ wp comment meta set 123 description "Mary is a WordPress developer."
    Success: Updated custom field 'description'.

# Get comment meta
    $ wp comment meta get 123 description
    Mary is a WordPress developer.

# Update comment meta
    $ wp comment meta update 123 description "Mary is an awesome WordPress developer."
    Success: Updated custom field 'description'.

# Delete comment meta
    $ wp comment meta delete 123 description
    Success: Deleted custom field.

### wp comment meta add

Add a meta field.

~~~
wp comment meta add <id> <key> [<value>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to create.

[<value>]
		The value of the meta field. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp comment meta delete

Delete a meta field.

~~~
wp comment meta delete <id> [<key>] [<value>] [--all]
~~~

**OPTIONS**

<id>
		The ID of the object.

[<key>]
		The name of the meta field to delete.

[<value>]
		The value to delete. If omitted, all rows with key will deleted.

[--all]
		Delete all meta for the object.

### wp comment meta get

Get meta field value.

~~~
wp comment meta get <id> <key> [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to get.

[--format=<format>]
		Get value in a particular format.
		---
		default: var_export
		options:
		  - var_export
		  - json
		  - yaml
		---

### wp comment meta list

List all metadata associated with an object.

~~~
wp comment meta list <id> [--keys=<keys>] [--fields=<fields>] [--format=<format>] [--orderby=<fields>] [--order=<order>] [--unserialize]
~~~

**OPTIONS**

<id>
		ID for the object.

[--keys=<keys>]
		Limit output to metadata of specific keys.

[--fields=<fields>]
		Limit the output to specific row fields. Defaults to id,meta_key,meta_value.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - yaml
		  - count
		---

[--orderby=<fields>]
		Set orderby which field.
		---
		default: id
		options:
		 - id
		 - meta_key
		 - meta_value
		---

[--order=<order>]
		Set ascending or descending order.
		---
		default: asc
		options:
		 - asc
		 - desc
		---

[--unserialize]
		Unserialize meta_value output.

### wp comment meta patch

Update a nested value for a meta field.

~~~
wp comment meta patch <action> <id> <key> <key-path>... [<value>] [--format=<format>]
~~~

**OPTIONS**

<action>
		Patch action to perform.
		---
		options:
		  - insert
		  - update
		  - delete
		---

<id>
		The ID of the object.

<key>
		The name of the meta field to update.

<key-path>...
		The name(s) of the keys within the value to locate the value to patch.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp comment meta pluck

Get a nested value from a meta field.

~~~
wp comment meta pluck <id> <key> <key-path>... [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to get.

<key-path>...
		The name(s) of the keys within the value to locate the value to pluck.

[--format=<format>]
		The output format of the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		  - yaml

### wp comment meta update

Update a meta field.

~~~
wp comment meta update <id> <key> [<value>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to update.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp comment recount

Recalculates the comment_count value for one or more posts.

~~~
wp comment recount <id>...
~~~

**OPTIONS**

<id>...
		IDs for one or more posts to update.

**EXAMPLES**

# Recount comment for the post.
    $ wp comment recount 123
    Updated post 123 comment count to 67.

### wp comment spam

Marks a comment as spam.

~~~
wp comment spam <id>...
~~~

**OPTIONS**

<id>...
		The IDs of the comments to mark as spam.

**EXAMPLES**

# Spam comment.
    $ wp comment spam 1337
    Success: Marked as spam comment 1337.

### wp comment status

Gets the status of a comment.

~~~
wp comment status <id>
~~~

**OPTIONS**

<id>
		The ID of the comment to check.

**EXAMPLES**

# Get status of comment.
    $ wp comment status 1337
    approved

### wp comment trash

Trashes a comment.

~~~
wp comment trash <id>...
~~~

**OPTIONS**

<id>...
		The IDs of the comments to trash.

**EXAMPLES**

# Trash comment.
    $ wp comment trash 1337
    Success: Trashed comment 1337.

### wp comment unapprove

Unapproves a comment.

~~~
wp comment unapprove <id>...
~~~

**OPTIONS**

<id>...
		The IDs of the comments to unapprove.

**EXAMPLES**

# Unapprove comment.
    $ wp comment unapprove 1337
    Success: Unapproved comment 1337.

### wp comment unspam

Unmarks a comment as spam.

~~~
wp comment unspam <id>...
~~~

**OPTIONS**

<id>...
		The IDs of the comments to unmark as spam.

**EXAMPLES**

# Unspam comment.
    $ wp comment unspam 1337
    Success: Unspammed comment 1337.

### wp comment untrash

Untrashes a comment.

~~~
wp comment untrash <id>...
~~~

**OPTIONS**

<id>...
		The IDs of the comments to untrash.

**EXAMPLES**

# Untrash comment.
    $ wp comment untrash 1337
    Success: Untrashed comment 1337.

### wp comment update

Updates one or more comments.

~~~
wp comment update <id>... --<field>=<value>
~~~

**OPTIONS**

<id>...
		One or more IDs of comments to update.

--<field>=<value>
		One or more fields to update. See wp_update_comment().

**EXAMPLES**

# Update comment.
    $ wp comment update 123 --comment_author='That Guy'
    Success: Updated comment 123.

### wp menu

Lists, creates, assigns, and deletes the active theme's navigation menus.

~~~
wp menu
~~~

See the [Navigation Menus](https://developer.wordpress.org/themes/functionality/navigation-menus/) reference in the Theme Handbook.

**EXAMPLES**

# Create a new menu
    $ wp menu create "My Menu"
    Success: Created menu 200.

# Create a new menu link item
    $ wp menu item add-custom my-menu Apple http://apple.com --porcelain
    1922

# Assign the 'my-menu' menu to the 'primary' location
    $ wp menu location assign my-menu primary
    Success: Assigned location primary to menu my-menu.

### wp menu create

Creates a new menu.

~~~
wp menu create <menu-name> [--porcelain]
~~~

**OPTIONS**

<menu-name>
		A descriptive name for the menu.

[--porcelain]
		Output just the new menu id.

**EXAMPLES**

$ wp menu create "My Menu"
    Success: Created menu 200.

### wp menu delete

Deletes one or more menus.

~~~
wp menu delete <menu>...
~~~

**OPTIONS**

<menu>...
		The name, slug, or term ID for the menu(s).

**EXAMPLES**

$ wp menu delete "My Menu"
    Deleted menu 'My Menu'.
    Success: Deleted 1 of 1 menus.

### wp menu item

List, add, and delete items associated with a menu.

~~~
wp menu item
~~~

**EXAMPLES**

# Add an existing post to an existing menu
    $ wp menu item add-post sidebar-menu 33 --title="Custom Test Post"
    Success: Menu item added.

# Create a new menu link item
    $ wp menu item add-custom sidebar-menu Apple http://apple.com
    Success: Menu item added.

# Delete menu item
    $ wp menu item delete 45
    Success: Deleted 1 of 1 menu items.

### wp menu item add-custom

Adds a custom menu item.

~~~
wp menu item add-custom <menu> <title> <link> [--description=<description>] [--attr-title=<attr-title>] [--target=<target>] [--classes=<classes>] [--position=<position>] [--parent-id=<parent-id>] [--porcelain]
~~~

**OPTIONS**

<menu>
		The name, slug, or term ID for the menu.

<title>
		Title for the link.

[--description=<description>]
		Set a custom description for the menu item.

[--attr-title=<attr-title>]
		Set a custom title attribute for the menu item.

[--target=<target>]
		Set a custom link target for the menu item.

[--classes=<classes>]
		Set a custom link classes for the menu item.

[--position=<position>]
		Specify the position of this menu item.

[--parent-id=<parent-id>]
		Make this menu item a child of another menu item.

[--porcelain]
		Output just the new menu item id.

**EXAMPLES**

$ wp menu item add-custom sidebar-menu Apple http://apple.com
    Success: Menu item added.

### wp menu item add-post

Adds a post as a menu item.

~~~
wp menu item add-post <menu> <post-id> [--title=<title>] [--link=<link>] [--description=<description>] [--attr-title=<attr-title>] [--target=<target>] [--classes=<classes>] [--position=<position>] [--parent-id=<parent-id>] [--porcelain]
~~~

**OPTIONS**

<menu>
		The name, slug, or term ID for the menu.

<post-id>
		Post ID to add to the menu.

[--title=<title>]
		Set a custom title for the menu item.

[--link=<link>]
		Set a custom url for the menu item.

[--description=<description>]
		Set a custom description for the menu item.

[--attr-title=<attr-title>]
		Set a custom title attribute for the menu item.

[--target=<target>]
		Set a custom link target for the menu item.

[--classes=<classes>]
		Set a custom link classes for the menu item.

[--position=<position>]
		Specify the position of this menu item.

[--parent-id=<parent-id>]
		Make this menu item a child of another menu item.

[--porcelain]
		Output just the new menu item id.

**EXAMPLES**

$ wp menu item add-post sidebar-menu 33 --title="Custom Test Post"
    Success: Menu item added.

### wp menu item add-term

Adds a taxonomy term as a menu item.

~~~
wp menu item add-term <menu> <taxonomy> <term-id> [--title=<title>] [--link=<link>] [--description=<description>] [--attr-title=<attr-title>] [--target=<target>] [--classes=<classes>] [--position=<position>] [--parent-id=<parent-id>] [--porcelain]
~~~

**OPTIONS**

<menu>
		The name, slug, or term ID for the menu.

<taxonomy>
		Taxonomy of the term to be added.

<term-id>
		Term ID of the term to be added.

[--title=<title>]
		Set a custom title for the menu item.

[--link=<link>]
		Set a custom url for the menu item.

[--description=<description>]
		Set a custom description for the menu item.

[--attr-title=<attr-title>]
		Set a custom title attribute for the menu item.

[--target=<target>]
		Set a custom link target for the menu item.

[--classes=<classes>]
		Set a custom link classes for the menu item.

[--position=<position>]
		Specify the position of this menu item.

[--parent-id=<parent-id>]
		Make this menu item a child of another menu item.

[--porcelain]
		Output just the new menu item id.

**EXAMPLES**

$ wp menu item add-term sidebar-menu post_tag 24
    Success: Menu item added.

### wp menu item delete

Deletes one or more items from a menu.

~~~
wp menu item delete <db-id>...
~~~

**OPTIONS**

<db-id>...
		Database ID for the menu item(s).

**EXAMPLES**

$ wp menu item delete 45
    Success: Deleted 1 of 1 menu items.

### wp menu item list

Gets a list of items associated with a menu.

~~~
wp menu item list <menu> [--fields=<fields>] [--format=<format>]
~~~

**OPTIONS**

<menu>
		The name, slug, or term ID for the menu.

[--fields=<fields>]
		Limit the output to specific object fields.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - count
		  - ids
		  - yaml
		---

**AVAILABLE FIELDS**

These fields will be displayed by default for each menu item:

* db_id
* type
* title
* link
* position

These fields are optionally available:

* menu_item_parent
* object_id
* object
* type
* type_label
* target
* attr_title
* description
* classes
* xfn

**EXAMPLES**

### wp menu item update

Updates a menu item.

~~~
wp menu item update <db-id> [--title=<title>] [--link=<link>] [--description=<description>] [--attr-title=<attr-title>] [--target=<target>] [--classes=<classes>] [--position=<position>] [--parent-id=<parent-id>]
~~~

**OPTIONS**

<db-id>
		Database ID for the menu item.

[--title=<title>]
		Set a custom title for the menu item.

[--link=<link>]
		Set a custom url for the menu item.

[--description=<description>]
		Set a custom description for the menu item.

[--attr-title=<attr-title>]
		Set a custom title attribute for the menu item.

[--target=<target>]
		Set a custom link target for the menu item.

[--classes=<classes>]
		Set a custom link classes for the menu item.

[--position=<position>]
		Specify the position of this menu item.

[--parent-id=<parent-id>]
		Make this menu item a child of another menu item.

**EXAMPLES**

$ wp menu item update 45 --title=WordPress --link='http://wordpress.org' --target=_blank --position=2
    Success: Menu item updated.

### wp menu list

Gets a list of menus.

~~~
wp menu list [--fields=<fields>] [--format=<format>]
~~~

**OPTIONS**

[--fields=<fields>]
		Limit the output to specific object fields.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - count
		  - ids
		  - yaml
		---

**AVAILABLE FIELDS**

These fields will be displayed by default for each menu:

* term_id
* name
* slug
* count

These fields are optionally available:

* term_group
* term_taxonomy_id
* taxonomy
* description
* parent
* locations

**EXAMPLES**

### wp menu location

Assigns, removes, and lists a menu's locations.

~~~
wp menu location
~~~

**EXAMPLES**

# Assign the 'primary-menu' menu to the 'primary' location
    $ wp menu location assign primary-menu primary
    Success: Assigned location primary to menu primary-menu.

# Remove the 'primary-menu' menu from the 'primary' location
    $ wp menu location remove primary-menu primary
    Success: Removed location from menu.

### wp menu location assign

Assigns a location to a menu.

~~~
wp menu location assign <menu> <location>
~~~

**OPTIONS**

<menu>
		The name, slug, or term ID for the menu.

<location>
		Location's slug.

**EXAMPLES**

$ wp menu location assign primary-menu primary
    Success: Assigned location primary to menu primary-menu.

### wp menu location list

Lists locations for the current theme.

~~~
wp menu location list [--format=<format>]
~~~

**OPTIONS**

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - count
		  - yaml
		  - ids
		---

**AVAILABLE FIELDS**

These fields will be displayed by default for each location:

* name
* description

**EXAMPLES**

### wp menu location remove

Removes a location from a menu.

~~~
wp menu location remove <menu> <location>
~~~

**OPTIONS**

<menu>
		The name, slug, or term ID for the menu.

<location>
		Location's slug.

**EXAMPLES**

$ wp menu location remove primary-menu primary
    Success: Removed location from menu.

### wp network meta

Gets, adds, updates, deletes, and lists network custom fields.

~~~
wp network meta
~~~

**EXAMPLES**

# Get a list of super-admins
    $ wp network meta get 1 site_admins
    array (
      0 => 'supervisor',
    )

### wp network meta add

Add a meta field.

~~~
wp network meta add <id> <key> [<value>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to create.

[<value>]
		The value of the meta field. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp network meta delete

Delete a meta field.

~~~
wp network meta delete <id> [<key>] [<value>] [--all]
~~~

**OPTIONS**

<id>
		The ID of the object.

[<key>]
		The name of the meta field to delete.

[<value>]
		The value to delete. If omitted, all rows with key will deleted.

[--all]
		Delete all meta for the object.

### wp network meta get

Get meta field value.

~~~
wp network meta get <id> <key> [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to get.

[--format=<format>]
		Get value in a particular format.
		---
		default: var_export
		options:
		  - var_export
		  - json
		  - yaml
		---

### wp network meta list

List all metadata associated with an object.

~~~
wp network meta list <id> [--keys=<keys>] [--fields=<fields>] [--format=<format>] [--orderby=<fields>] [--order=<order>] [--unserialize]
~~~

**OPTIONS**

<id>
		ID for the object.

[--keys=<keys>]
		Limit output to metadata of specific keys.

[--fields=<fields>]
		Limit the output to specific row fields. Defaults to id,meta_key,meta_value.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - yaml
		  - count
		---

[--orderby=<fields>]
		Set orderby which field.
		---
		default: id
		options:
		 - id
		 - meta_key
		 - meta_value
		---

[--order=<order>]
		Set ascending or descending order.
		---
		default: asc
		options:
		 - asc
		 - desc
		---

[--unserialize]
		Unserialize meta_value output.

### wp network meta patch

Update a nested value for a meta field.

~~~
wp network meta patch <action> <id> <key> <key-path>... [<value>] [--format=<format>]
~~~

**OPTIONS**

<action>
		Patch action to perform.
		---
		options:
		  - insert
		  - update
		  - delete
		---

<id>
		The ID of the object.

<key>
		The name of the meta field to update.

<key-path>...
		The name(s) of the keys within the value to locate the value to patch.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp network meta pluck

Get a nested value from a meta field.

~~~
wp network meta pluck <id> <key> <key-path>... [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to get.

<key-path>...
		The name(s) of the keys within the value to locate the value to pluck.

[--format=<format>]
		The output format of the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		  - yaml

### wp network meta update

Update a meta field.

~~~
wp network meta update <id> <key> [<value>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to update.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp option

Retrieves and sets site options, including plugin and WordPress settings.

~~~
wp option
~~~

See the [Plugin Settings API](https://developer.wordpress.org/plugins/settings/settings-api/) and the [Theme Options](https://developer.wordpress.org/themes/customize-api/) for more information on adding customized options.

**EXAMPLES**

# Get site URL.
    $ wp option get siteurl
    http://example.com

# Add option.
    $ wp option add my_option foobar
    Success: Added 'my_option' option.

# Update option.
    $ wp option update my_option '{"foo": "bar"}' --format=json
    Success: Updated 'my_option' option.

# Delete option.
    $ wp option delete my_option
    Success: Deleted 'my_option' option.

### wp option add

Adds a new option value.

~~~
wp option add <key> [<value>] [--format=<format>] [--autoload=<autoload>]
~~~

Errors if the option already exists.

**OPTIONS**

<key>
		The name of the option to add.

[<value>]
		The value of the option to add. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

[--autoload=<autoload>]
		Should this option be automatically loaded.
		---
		options:
		  - 'on'
		  - 'off'
		  - 'yes'
		  - 'no'
		---

**EXAMPLES**

# Create an option by reading a JSON file.
    $ wp option add my_option --format=json < config.json
    Success: Added 'my_option' option.

### wp option delete

Deletes an option.

~~~
wp option delete <key>...
~~~

**OPTIONS**

<key>...
		Key for the option.

**EXAMPLES**

# Delete an option.
    $ wp option delete my_option
    Success: Deleted 'my_option' option.

# Delete multiple options.
    $ wp option delete option_one option_two option_three
    Success: Deleted 'option_one' option.
    Success: Deleted 'option_two' option.
    Warning: Could not delete 'option_three' option. Does it exist?

### wp option get

Gets the value for an option.

~~~
wp option get <key> [--format=<format>]
~~~

**OPTIONS**

<key>
		Key for the option.

[--format=<format>]
		Get value in a particular format.
		---
		default: var_export
		options:
		  - var_export
		  - json
		  - yaml
		---

**EXAMPLES**

# Get option.
    $ wp option get home
    http://example.com

# Get blog description.
    $ wp option get blogdescription
    A random blog description

# Get blog name
    $ wp option get blogname
    A random blog name

# Get admin email.
    $ wp option get admin_email
    someone@example.com

# Get option in JSON format.
    $ wp option get active_plugins --format=json
    {"0":"dynamically-dynamic-sidebar\/dynamically-dynamic-sidebar.php","1":"monster-widget\/monster-widget.php","2":"show-current-template\/show-current-template.php","3":"theme-check\/theme-check.php","5":"wordpress-importer\/wordpress-importer.php"}

### wp option list

Lists options and their values.

~~~
wp option list [--search=<pattern>] [--exclude=<pattern>] [--autoload=<value>] [--transients] [--unserialize] [--field=<field>] [--fields=<fields>] [--format=<format>] [--orderby=<fields>] [--order=<order>]
~~~

**OPTIONS**

[--search=<pattern>]
		Use wildcards ( * and ? ) to match option name.

[--exclude=<pattern>]
		Pattern to exclude. Use wildcards ( * and ? ) to match option name.

[--autoload=<value>]
		Match only autoload options when value is on, and only not-autoload option when off.

[--transients]
		List only transients. Use `--no-transients` to ignore all transients.

[--unserialize]
		Unserialize option values in output.

[--field=<field>]
		Prints the value of a single field.

[--fields=<fields>]
		Limit the output to specific object fields.

[--format=<format>]
		The serialization format for the value. total_bytes displays the total size of matching options in bytes.
		---
		default: table
		options:
		  - table
		  - json
		  - csv
		  - count
		  - yaml
		  - total_bytes
		---

[--orderby=<fields>]
		Set orderby which field.
		---
		default: option_id
		options:
		 - option_id
		 - option_name
		 - option_value
		---

[--order=<order>]
		Set ascending or descending order.
		---
		default: asc
		options:
		 - asc
		 - desc
		---

**AVAILABLE FIELDS**

This field will be displayed by default for each matching option:

* option_name
* option_value

These fields are optionally available:

* autoload
* size_bytes

**EXAMPLES**

# Get the total size of all autoload options.
    $ wp option list --autoload=on --format=total_bytes
    33198

# Find biggest transients.
    $ wp option list --search="*_transient_*" --fields=option_name,size_bytes | sort -n -k 2 | tail
    option_name size_bytes
    _site_transient_timeout_theme_roots 10
    _site_transient_theme_roots 76
    _site_transient_update_themes   181
    _site_transient_update_core 808
    _site_transient_update_plugins  6645

# List all options beginning with "i2f_".
    $ wp option list --search="i2f_*"
    +-------------+--------------+
    | option_name | option_value |
    +-------------+--------------+
    | i2f_version | 0.1.0        |
    +-------------+--------------+

# Delete all options beginning with "theme_mods_".
    $ wp option list --search="theme_mods_*" --field=option_name | xargs -I % wp option delete %
    Success: Deleted 'theme_mods_twentysixteen' option.
    Success: Deleted 'theme_mods_twentyfifteen' option.
    Success: Deleted 'theme_mods_twentyfourteen' option.

### wp option patch

Updates a nested value in an option.

~~~
wp option patch <action> <key> <key-path>... [<value>] [--format=<format>]
~~~

**OPTIONS**

<action>
		Patch action to perform.
		---
		options:
		  - insert
		  - update
		  - delete
		---

<key>
		The option name.

<key-path>...
		The name(s) of the keys within the value to locate the value to patch.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

**EXAMPLES**

# Add 'bar' to the 'foo' key on an option with name 'option_name'
    $ wp option patch insert option_name foo bar
    Success: Updated 'option_name' option.

# Update the value of 'foo' key to 'new' on an option with name 'option_name'
    $ wp option patch update option_name foo new
    Success: Updated 'option_name' option.

# Set nested value of 'bar' key to value we have in the patch file on an option with name 'option_name'.
    $ wp option patch update option_name foo bar < patch
    Success: Updated 'option_name' option.

# Update the value for the key 'not-a-key' which is not exist on an option with name 'option_name'.
    $ wp option patch update option_name foo not-a-key new-value
    Error: No data exists for key "not-a-key"

# Update the value for the key 'foo' without passing value on an option with name 'option_name'.
    $ wp option patch update option_name foo
    Error: Please provide value to update.

# Delete the nested key 'bar' under 'foo' key on an option with name 'option_name'.
    $ wp option patch delete option_name foo bar
    Success: Updated 'option_name' option.

### wp option pluck

Gets a nested value from an option.

~~~
wp option pluck <key> <key-path>... [--format=<format>]
~~~

**OPTIONS**

<key>
		The option name.

<key-path>...
		The name(s) of the keys within the value to locate the value to pluck.

[--format=<format>]
		The output format of the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		  - yaml
		---

### wp option update

Updates an option value.

~~~
wp option update <key> [<value>] [--autoload=<autoload>] [--format=<format>]
~~~

**OPTIONS**

<key>
		The name of the option to update.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--autoload=<autoload>]
		Requires WP 4.2. Should this option be automatically loaded.
		---
		options:
		  - 'on'
		  - 'off'
		  - 'yes'
		  - 'no'
		---

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

**EXAMPLES**

# Update an option by reading from a file.
    $ wp option update my_option < value.txt
    Success: Updated 'my_option' option.

# Update one option on multiple sites using xargs.
    $ wp site list --field=url | xargs -n1 -I {} sh -c 'wp --url={} option update my_option my_value'
    Success: Updated 'my_option' option.
    Success: Updated 'my_option' option.

# Update site blog name.
    $ wp option update blogname "Random blog name"
    Success: Updated 'blogname' option.

# Update site blog description.
    $ wp option update blogdescription "Some random blog description"
    Success: Updated 'blogdescription' option.

# Update admin email address.
    $ wp option update admin_email someone@example.com
    Success: Updated 'admin_email' option.

# Set the default role.
    $ wp option update default_role author
    Success: Updated 'default_role' option.

# Set the timezone string.
    $ wp option update timezone_string "America/New_York"
    Success: Updated 'timezone_string' option.

### wp option set-autoload

Sets the 'autoload' value for an option.

~~~
wp option set-autoload <key> <autoload>
~~~

**OPTIONS**

<key>
		The name of the option to set 'autoload' for.

<autoload>
		Should this option be automatically loaded.
		---
		options:
		  - 'on'
		  - 'off'
		  - 'yes'
		  - 'no'
		---

**EXAMPLES**

# Set the 'autoload' value for an option.
    $ wp option set-autoload abc_options no
    Success: Updated autoload value for 'abc_options' option.

### wp option get-autoload

Gets the 'autoload' value for an option.

~~~
wp option get-autoload <key>
~~~

**OPTIONS**

<key>
		The name of the option to get 'autoload' of.

**EXAMPLES**

# Get the 'autoload' value for an option.
    $ wp option get-autoload blogname
    yes

### wp post

Manages posts, content, and meta.

~~~
wp post
~~~

**EXAMPLES**

# Create a new post.
    $ wp post create --post_type=post --post_title='A sample post'
    Success: Created post 123.

# Update an existing post.
    $ wp post update 123 --post_status=draft
    Success: Updated post 123.

# Delete an existing post.
    $ wp post delete 123
    Success: Trashed post 123.

### wp post create

Creates a new post.

~~~
wp post create [--post_author=<post_author>] [--post_date=<post_date>] [--post_date_gmt=<post_date_gmt>] [--post_content=<post_content>] [--post_content_filtered=<post_content_filtered>] [--post_title=<post_title>] [--post_excerpt=<post_excerpt>] [--post_status=<post_status>] [--post_type=<post_type>] [--comment_status=<comment_status>] [--ping_status=<ping_status>] [--post_password=<post_password>] [--post_name=<post_name>] [--from-post=<post_id>] [--to_ping=<to_ping>] [--pinged=<pinged>] [--post_modified=<post_modified>] [--post_modified_gmt=<post_modified_gmt>] [--post_parent=<post_parent>] [--menu_order=<menu_order>] [--post_mime_type=<post_mime_type>] [--guid=<guid>] [--post_category=<post_category>] [--tags_input=<tags_input>] [--tax_input=<tax_input>] [--meta_input=<meta_input>] [<file>] [--<field>=<value>] [--edit] [--porcelain]
~~~

**OPTIONS**

[--post_author=<post_author>]
		The ID of the user who added the post. Default is the current user ID.

[--post_date=<post_date>]
		The date of the post. Default is the current time.

[--post_date_gmt=<post_date_gmt>]
		The date of the post in the GMT timezone. Default is the value of $post_date.

[--post_content=<post_content>]
		The post content. Default empty.

[--post_content_filtered=<post_content_filtered>]
		The filtered post content. Default empty.

[--post_title=<post_title>]
		The post title. Default empty.

[--post_excerpt=<post_excerpt>]
		The post excerpt. Default empty.

[--post_status=<post_status>]
		The post status. Default 'draft'.

[--post_type=<post_type>]
		The post type. Default 'post'.

[--comment_status=<comment_status>]
		Whether the post can accept comments. Accepts 'open' or 'closed'. Default is the value of 'default_comment_status' option.

[--ping_status=<ping_status>]
		Whether the post can accept pings. Accepts 'open' or 'closed'. Default is the value of 'default_ping_status' option.

[--post_password=<post_password>]
		The password to access the post. Default empty.

[--post_name=<post_name>]
		The post name. Default is the sanitized post title when creating a new post.

[--from-post=<post_id>]
		Post id of a post to be duplicated.

[--to_ping=<to_ping>]
		Space or carriage return-separated list of URLs to ping. Default empty.

[--pinged=<pinged>]
		Space or carriage return-separated list of URLs that have been pinged. Default empty.

[--post_modified=<post_modified>]
		The date when the post was last modified. Default is the current time.

[--post_modified_gmt=<post_modified_gmt>]
		The date when the post was last modified in the GMT timezone. Default is the current time.

[--post_parent=<post_parent>]
		Set this for the post it belongs to, if any. Default 0.

[--menu_order=<menu_order>]
		The order the post should be displayed in. Default 0.

[--post_mime_type=<post_mime_type>]
		The mime type of the post. Default empty.

[--guid=<guid>]
		Global Unique ID for referencing the post. Default empty.

[--post_category=<post_category>]
		Array of category names, slugs, or IDs. Defaults to value of the 'default_category' option.

[--tags_input=<tags_input>]
		Array of tag names, slugs, or IDs. Default empty.

[--tax_input=<tax_input>]
		Array of taxonomy terms keyed by their taxonomy name. Default empty.

[--meta_input=<meta_input>]
		Array in JSON format of post meta values keyed by their post meta key. Default empty.

[<file>]
		Read post content from <file>. If this value is present, the
		    `--post_content` argument will be ignored.

Passing `-` as the filename will cause post content to
  be read from STDIN.

[--<field>=<value>]
		Associative args for the new post. See wp_insert_post().

[--edit]
		Immediately open system's editor to write or edit post content.

If content is read from a file, from STDIN, or from the `--post_content`
  argument, that text will be loaded into the editor.

[--porcelain]
		Output just the new post id.

**EXAMPLES**

# Create post and schedule for future
    $ wp post create --post_type=post --post_title='A future post' --post_status=future --post_date='2030-12-01 07:00:00'
    Success: Created post 1921.

# Create post with content from given file
    $ wp post create ./post-content.txt --post_category=201,345 --post_title='Post from file'
    Success: Created post 1922.

# Create a post with multiple meta values.
    $ wp post create --post_title='A post' --post_content='Just a small post.' --meta_input='{"key1":"value1","key2":"value2"}'
    Success: Created post 1923.

# Create a duplicate post from existing posts.
    $ wp post create --from-post=123 --post_title='Different Title'
    Success: Created post 2350.

### wp post delete

Deletes an existing post.

~~~
wp post delete <id>... [--force] [--defer-term-counting]
~~~

**OPTIONS**

<id>...
		One or more IDs of posts to delete.

[--force]
		Skip the trash bin.

[--defer-term-counting]
		Recalculate term count in batch, for a performance boost.

**EXAMPLES**

# Delete post skipping trash
    $ wp post delete 123 --force
    Success: Deleted post 123.

# Delete multiple posts
    $ wp post delete 123 456 789
    Success: Trashed post 123.
    Success: Trashed post 456.
    Success: Trashed post 789.

# Delete all pages
    $ wp post delete $(wp post list --post_type='page' --format=ids)
    Success: Trashed post 1164.
    Success: Trashed post 1186.

# Delete all posts in the trash
    $ wp post delete $(wp post list --post_status=trash --format=ids)
    Success: Deleted post 1268.
    Success: Deleted post 1294.

### wp post edit

Launches system editor to edit post content.

~~~
wp post edit <id>
~~~

**OPTIONS**

<id>
		The ID of the post to edit.

**EXAMPLES**

# Launch system editor to edit post
    $ wp post edit 123

### wp post exists

Verifies whether a post exists.

~~~
wp post exists <id>
~~~

Displays a success message if the post does exist.

**OPTIONS**

<id>
		The ID of the post to check.

**EXAMPLES**

# The post exists.
    $ wp post exists 1337
    Success: Post with ID 1337 exists.
    $ echo $?
    0

# The post does not exist.
    $ wp post exists 10000
    $ echo $?
    1

### wp post generate

Generates some posts.

~~~
wp post generate [--count=<number>] [--post_type=<type>] [--post_status=<status>] [--post_title=<post_title>] [--post_author=<login>] [--post_date=<yyyy-mm-dd-hh-ii-ss>] [--post_date_gmt=<yyyy-mm-dd-hh-ii-ss>] [--post_content] [--max_depth=<number>] [--format=<format>]
~~~

Creates a specified number of new posts with dummy data.

**OPTIONS**

[--count=<number>]
		How many posts to generate?
		---
		default: 100
		---

[--post_type=<type>]
		The type of the generated posts.
		---
		default: post
		---

[--post_status=<status>]
		The status of the generated posts.
		---
		default: publish
		---

[--post_title=<post_title>]
		The post title.
		---
		default:
		---

[--post_author=<login>]
		The author of the generated posts.
		---
		default:
		---

[--post_date=<yyyy-mm-dd-hh-ii-ss>]
		The date of the post. Default is the current time.

[--post_date_gmt=<yyyy-mm-dd-hh-ii-ss>]
		The date of the post in the GMT timezone. Default is the value of --post_date.

[--post_content]
		If set, the command reads the post_content from STDIN.

[--max_depth=<number>]
		For hierarchical post types, generate child posts down to a certain depth.
		---
		default: 1
		---

[--format=<format>]
		Render output in a particular format.
		---
		default: progress
		options:
		  - progress
		  - ids
		---

**EXAMPLES**

# Generate posts.
    $ wp post generate --count=10 --post_type=page --post_date=1999-01-04
    Generating posts  100% [================================================] 0:01 / 0:04

# Generate posts with fetched content.
    $ curl -N https://loripsum.net/api/5 | wp post generate --post_content --count=10
      % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                     Dload  Upload   Total   Spent    Left  Speed
    100  2509  100  2509    0     0    616      0  0:00:04  0:00:04 --:--:--   616
    Generating posts  100% [================================================] 0:01 / 0:04

# Add meta to every generated posts.
    $ wp post generate --format=ids | xargs -d ' ' -I % wp post meta add % foo bar
    Success: Added custom field.
    Success: Added custom field.
    Success: Added custom field.

### wp post get

Gets details about a post.

~~~
wp post get <id> [--field=<field>] [--fields=<fields>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the post to get.

[--field=<field>]
		Instead of returning the whole post, returns the value of a single field.

[--fields=<fields>]
		Limit the output to specific fields. Defaults to all fields.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - yaml
		---

**EXAMPLES**

# Save the post content to a file
    $ wp post get 123 --field=content > file.txt

### wp post list

Gets a list of posts.

~~~
wp post list [--<field>=<value>] [--field=<field>] [--fields=<fields>] [--format=<format>]
~~~

Display posts based on all arguments supported by [WP_Query()](https://developer.wordpress.org/reference/classes/wp_query/).
Only shows post types marked as post by default.

**OPTIONS**

[--<field>=<value>]
		One or more args to pass to WP_Query.

[--field=<field>]
		Prints the value of a single field for each post.

[--fields=<fields>]
		Limit the output to specific object fields.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - ids
		  - json
		  - count
		  - yaml
		---

**AVAILABLE FIELDS**

These fields will be displayed by default for each post:

* ID
* post_title
* post_name
* post_date
* post_status

These fields are optionally available:

* post_author
* post_date_gmt
* post_content
* post_excerpt
* comment_status
* ping_status
* post_password
* to_ping
* pinged
* post_modified
* post_modified_gmt
* post_content_filtered
* post_parent
* guid
* menu_order
* post_type
* post_mime_type
* comment_count
* filter
* url

**EXAMPLES**

# List post
    $ wp post list --field=ID
    568
    829
    1329
    1695

# List posts in JSON
    $ wp post list --post_type=post --posts_per_page=5 --format=json
    [{"ID":1,"post_title":"Hello world!","post_name":"hello-world","post_date":"2015-06-20 09:00:10","post_status":"publish"},{"ID":1178,"post_title":"Markup: HTML Tags and Formatting","post_name":"markup-html-tags-and-formatting","post_date":"2013-01-11 20:22:19","post_status":"draft"}]

# List ids of all pages and posts
    $ wp post list --post_type=page,post --format=ids
    15 25 34 37 198

### wp post meta

Adds, updates, deletes, and lists post custom fields.

~~~
wp post meta
~~~

**EXAMPLES**

# Set post meta
    $ wp post meta set 123 _wp_page_template about.php
    Success: Updated custom field '_wp_page_template'.

# Get post meta
    $ wp post meta get 123 _wp_page_template
    about.php

# Update post meta
    $ wp post meta update 123 _wp_page_template contact.php
    Success: Updated custom field '_wp_page_template'.

# Delete post meta
    $ wp post meta delete 123 _wp_page_template
    Success: Deleted custom field.

### wp post meta add

Add a meta field.

~~~
wp post meta add <id> <key> [<value>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to create.

[<value>]
		The value of the meta field. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp post meta clean-duplicates

Cleans up duplicate post meta values on a post.

~~~
wp post meta clean-duplicates <id> <key>
~~~

**OPTIONS**

<id>
		ID of the post to clean.

<key>
		Meta key to clean up.

**EXAMPLES**

# Delete duplicate post meta.
    wp post meta clean-duplicates 1234 enclosure
    Success: Cleaned up duplicate 'enclosure' meta values.

### wp post meta delete

Delete a meta field.

~~~
wp post meta delete <id> [<key>] [<value>] [--all]
~~~

**OPTIONS**

<id>
		The ID of the object.

[<key>]
		The name of the meta field to delete.

[<value>]
		The value to delete. If omitted, all rows with key will deleted.

[--all]
		Delete all meta for the object.

### wp post meta get

Get meta field value.

~~~
wp post meta get <id> <key> [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to get.

[--format=<format>]
		Get value in a particular format.
		---
		default: var_export
		options:
		  - var_export
		  - json
		  - yaml
		---

### wp post meta list

List all metadata associated with an object.

~~~
wp post meta list <id> [--keys=<keys>] [--fields=<fields>] [--format=<format>] [--orderby=<fields>] [--order=<order>] [--unserialize]
~~~

**OPTIONS**

<id>
		ID for the object.

[--keys=<keys>]
		Limit output to metadata of specific keys.

[--fields=<fields>]
		Limit the output to specific row fields. Defaults to id,meta_key,meta_value.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - yaml
		  - count
		---

[--orderby=<fields>]
		Set orderby which field.
		---
		default: id
		options:
		 - id
		 - meta_key
		 - meta_value
		---

[--order=<order>]
		Set ascending or descending order.
		---
		default: asc
		options:
		 - asc
		 - desc
		---

[--unserialize]
		Unserialize meta_value output.

### wp post meta patch

Update a nested value for a meta field.

~~~
wp post meta patch <action> <id> <key> <key-path>... [<value>] [--format=<format>]
~~~

**OPTIONS**

<action>
		Patch action to perform.
		---
		options:
		  - insert
		  - update
		  - delete
		---

<id>
		The ID of the object.

<key>
		The name of the meta field to update.

<key-path>...
		The name(s) of the keys within the value to locate the value to patch.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp post meta pluck

Get a nested value from a meta field.

~~~
wp post meta pluck <id> <key> <key-path>... [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to get.

<key-path>...
		The name(s) of the keys within the value to locate the value to pluck.

[--format=<format>]
		The output format of the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		  - yaml

### wp post meta update

Update a meta field.

~~~
wp post meta update <id> <key> [<value>] [--format=<format>]
~~~

**OPTIONS**

<id>
		The ID of the object.

<key>
		The name of the meta field to update.

[<value>]
		The new value. If omitted, the value is read from STDIN.

[--format=<format>]
		The serialization format for the value.
		---
		default: plaintext
		options:
		  - plaintext
		  - json
		---

### wp post term

Adds, updates, removes, and lists post terms.

~~~
wp post term
~~~

**EXAMPLES**

# Set category post term `test` to the post ID 123
    $ wp post term set 123 test category
    Success: Set term.

# Set category post terms `test` and `apple` to the post ID 123
    $ wp post term set 123 test apple category
    Success: Set terms.

# List category post terms for the post ID 123
    $ wp post term list 123 category --fields=term_id,slug
    +---------+-------+
    | term_id | slug  |
    +---------+-------+
    | 2       | apple |
    | 3       | test  |
    +----------+------+

# Remove category post terms `test` and `apple` for the post ID 123
    $ wp post term remove 123 category test apple
    Success: Removed terms.

### wp post term add

Add a term to an object.

~~~
wp post term add <id> <taxonomy> <term>... [--by=<field>]
~~~

Append the term to the existing set of terms on the object.

**OPTIONS**

<id>
		The ID of the object.

<taxonomy>
		The name of the taxonomy type to be added.

<term>...
		The slug of the term or terms to be added.

[--by=<field>]
		Explicitly handle the term value as a slug or id.
		---
		default: slug
		options:
		  - slug
		  - id
		---

### wp post term list

List all terms associated with an object.

~~~
wp post term list <id> <taxonomy>... [--field=<field>] [--fields=<fields>] [--format=<format>]
~~~

**OPTIONS**

<id>
		ID for the object.

<taxonomy>...
		One or more taxonomies to list.

[--field=<field>]
		Prints the value of a single field for each term.

[--fields=<fields>]
		Limit the output to specific row fields.

[--format=<format>]
		Render output in a particular format.
		---
		default: table
		options:
		  - table
		  - csv
		  - json
		  - yaml
		  - count
		  - ids
		---

**AVAILABLE FIELDS**

These fields will be displayed by default for each term:

* term_id
* name
* slug
* taxonomy

These fields are optionally available:

* term_taxonomy_id
* description
* term_group
* parent
* count

### wp post term remove

Remove a term from an object.

~~~
wp post term remove <id> <taxonomy> [<term>...] [--by=<field>] [--all]
~~~

**OPTIONS**

<id>
		The ID of the object.

<taxonomy>
		The name of the term's taxonomy.

[<term>...]
		The slug of the term or terms to be removed from the object.

[--by=<field>]
		Explicitly handle the term value as a slug or id.
		---
		default: slug
		options:
		  - slug
		  - id
		---

[--all]
		Remove all terms from the object.

### wp post term set

Set object terms.

~~~
wp post term set <id> <taxonomy> <term>... [--by=<field>]
~~~

Replaces existing terms on the object.

**OPTIONS**

<id>
		The ID of the object.

<taxonomy>
		The name of the taxonomy type to be updated.

<term>...
		The slug of the term or terms to be updated.

[--by=<field>]
		Explicitly handle the term value as a slug or id.
		---
		default: slug
		options:
		  - slug
		  - id
		---

### wp post update

Updates one or more existing posts.

~~~
wp post update <id>... [--post_author=<post_author>] [--post_date=<post_date>] [--post_date_gmt=<post_date_gmt>] [--post_content=<post_content>] [--post_content_filtered=<post_content_filtered>] [--post_title=<post_title>] [--post_excerpt=<post_excerpt>] [--post_status=<post_status>] [--post_type=<post_type>] [--comment_status=<comment_status>] [--ping_status=<ping_status>] [--post_password=<post_password>] [--post_name=<post_name>] [--to_ping=<to_ping>] [--pinged=<pinged>] [--post_modified=<post_modified>] [--post_modified_gmt=<post_modified_gmt>] [--post_parent=<post_parent>] [--menu_order=<menu_order>] [--post_mime_type=<post_mime_type>] [--guid=<guid>] [--post_category=<post_category>] [--tags_input=<tags_input>] [--tax_input=<tax_input>] [--meta_input=<meta_input>] [<file>] --<field>=<value> [--defer-term-counting]
~~~

**OPTIONS**

<id>...
		One or more IDs of posts to update.