Skip to content

Commit a82553a

Browse files
authored
Merge pull request #83 from hearvox/master
Improve top-level commands; add reference links
2 parents 0b4f3f6 + 73a9ecf commit a82553a

9 files changed

Lines changed: 28 additions & 16 deletions

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This package implements the following commands:
1313

1414
### wp comment
1515

16-
Manage comments.
16+
Creates, updates, deletes, and moderates comments.
1717

1818
~~~
1919
wp comment
@@ -72,7 +72,7 @@ wp comment meta
7272

7373
### wp menu
7474

75-
List, create, assign, and delete menus.
75+
Lists, creates, assigns, and deletes the active theme's navigation menus.
7676

7777
~~~
7878
wp menu
@@ -182,7 +182,7 @@ wp network meta
182182

183183
### wp option
184184

185-
Manage options.
185+
Retrieves and sets site options, including plugin and WordPress settings.
186186

187187
~~~
188188
wp option
@@ -471,7 +471,7 @@ wp option update <key> [<value>] [--autoload=<autoload>] [--format=<format>]
471471

472472
### wp post
473473

474-
Manage posts.
474+
Manages posts, content, and meta.
475475

476476
~~~
477477
wp post
@@ -543,7 +543,7 @@ wp post term
543543

544544
### wp post-type
545545

546-
Manage post types.
546+
Retrieves details on the site's registered post-types.
547547

548548
~~~
549549
wp post-type
@@ -570,7 +570,7 @@ wp post-type
570570

571571
### wp site
572572

573-
Perform site-wide operations.
573+
Performs site-wide operations on a multisite install.
574574

575575
~~~
576576
wp site
@@ -639,7 +639,7 @@ WP_CLI::add_hook( 'after_invoke:site empty', function(){
639639

640640
### wp taxonomy
641641

642-
Manage taxonomies.
642+
Retrieves information about registered taxonomies.
643643

644644
~~~
645645
wp taxonomy
@@ -665,7 +665,7 @@ wp taxonomy
665665

666666
### wp term
667667

668-
Manage terms.
668+
Manages taxonomy terms and term meta, including create, delete, and list.
669669

670670
~~~
671671
wp term
@@ -732,7 +732,7 @@ wp term meta
732732

733733
### wp user
734734

735-
Manage users.
735+
Manages users, along with their roles, capabilities, and meta.
736736

737737
~~~
738738
wp user

src/Comment_Command.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
use WP_CLI\Utils;
44

55
/**
6-
* Manage comments.
6+
* Creates, updates, deletes, and moderates comments.
77
*
88
* ## EXAMPLES
99
*

src/Menu_Command.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
/**
66
* Lists, creates, assigns, and deletes the active theme's navigation menus.
77
*
8+
* See the [Navigation Menus](https://developer.wordpress.org/themes/functionality/navigation-menus/) reference in the Theme Handbook.
9+
*
810
* ## EXAMPLES
911
*
1012
* # Create a new menu

src/Option_Command.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44
use WP_CLI\Utils;
55

66
/**
7-
* Manage options.
7+
* Retrieves and sets site options, including plugin and WordPress settings.
8+
*
9+
* 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.
810
*
911
* ## EXAMPLES
1012
*

src/Post_Type_Command.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<?php
22
/**
3-
* Retrieves details on the site's registered post-types.
3+
* Retrieves details on the site's registered post types.
4+
*
5+
* Get information on WordPress' built-in and the site's [custom post types](https://developer.wordpress.org/plugins/post-types/).
46
*
57
* ## EXAMPLES
68
*

src/Site_Command.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?php
22

33
/**
4-
* Perform site-wide operations.
4+
* Performs site-wide operations on a multisite install.
55
*
66
* ## EXAMPLES
77
*

src/Taxonomy_Command.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<?php
22
/**
3-
* Manage taxonomies.
3+
* Retrieves information about registered taxonomies.
4+
*
5+
* See references for [built-in taxonomies](https://developer.wordpress.org/themes/basics/categories-tags-custom-taxonomies/) and [custom taxonomies](https://developer.wordpress.org/plugins/taxonomies/working-with-custom-taxonomies/).
46
*
57
* ## EXAMPLES
68
*

src/Term_Command.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
use WP_CLI\Utils;
44

55
/**
6-
* Manage terms.
6+
* Manages taxonomy terms and term meta, with create, delete, and list commands.
7+
*
8+
* See reference for [taxonomies and their terms](https://codex.wordpress.org/Taxonomies).
79
*
810
* ## EXAMPLES
911
*

src/User_Command.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
use \WP_CLI\Utils;
44

55
/**
6-
* Manage users.
6+
* Manages users, along with their roles, capabilities, and meta.
7+
*
8+
* See references for [Roles and Capabilities](https://codex.wordpress.org/Roles_and_Capabilities) and [WP User class](https://codex.wordpress.org/Class_Reference/WP_User).
79
*
810
* ## EXAMPLES
911
*

0 commit comments

Comments
 (0)