Skip to content

Commit b9d1d77

Browse files
committed
Update docs for plugin get command
1 parent ca887dc commit b9d1d77

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,10 +197,28 @@ wp plugin get <plugin> [--field=<field>] [--fields=<fields>] [--format=<format>]
197197
- yaml
198198
---
199199

200+
**AVAILABLE FIELDS**
201+
202+
These fields will be displayed by default for the plugin:
203+
204+
* name
205+
* title
206+
* author
207+
* version
208+
* description
209+
* status
210+
211+
These fields are optionally available:
212+
213+
* requires_wp
214+
* requires_php
215+
* requires_plugins
216+
200217
**EXAMPLES**
201218

219+
# Get plugin details.
202220
$ wp plugin get bbpress --format=json
203-
{"name":"bbpress","title":"bbPress","author":"The bbPress Contributors","version":"2.6-alpha","description":"bbPress is forum software with a twist from the creators of WordPress.","status":"active"}
221+
{"name":"bbpress","title":"bbPress","author":"The bbPress Contributors","version":"2.6.9","description":"bbPress is forum software with a twist from the creators of WordPress.","status":"active"}
204222

205223

206224

src/Plugin_Command.php

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -941,10 +941,28 @@ public function install( $args, $assoc_args ) {
941941
* - yaml
942942
* ---
943943
*
944+
* ## AVAILABLE FIELDS
945+
*
946+
* These fields will be displayed by default for the plugin:
947+
*
948+
* * name
949+
* * title
950+
* * author
951+
* * version
952+
* * description
953+
* * status
954+
*
955+
* These fields are optionally available:
956+
*
957+
* * requires_wp
958+
* * requires_php
959+
* * requires_plugins
960+
*
944961
* ## EXAMPLES
945962
*
963+
* # Get plugin details.
946964
* $ wp plugin get bbpress --format=json
947-
* {"name":"bbpress","title":"bbPress","author":"The bbPress Contributors","version":"2.6-alpha","description":"bbPress is forum software with a twist from the creators of WordPress.","status":"active"}
965+
* {"name":"bbpress","title":"bbPress","author":"The bbPress Contributors","version":"2.6.9","description":"bbPress is forum software with a twist from the creators of WordPress.","status":"active"}
948966
*/
949967
public function get( $args, $assoc_args ) {
950968
$default_fields = array(

0 commit comments

Comments
 (0)