diff --git a/command.php b/command.php index e5f3c270..a99bbe70 100644 --- a/command.php +++ b/command.php @@ -15,7 +15,6 @@ */ function generate() { generate_homepage(); - generate_commands(); } WP_CLI::add_command( 'website generate', 'WP_CLI_Org\generate' ); @@ -56,91 +55,6 @@ function generate_homepage() { } WP_CLI::add_command( 'website generate-homepage', '\WP_CLI_Org\generate_homepage' ); -/** - * Generate the /commands/ page. - * - * @when before_wp_load - */ -function generate_commands() { - $wp = invoke_wp_cli( 'wp --skip-packages cli cmd-dump' ); - - foreach( $wp['subcommands'] as $k => $cmd ) { - if ( in_array( $cmd['name'], array( 'website', 'api-dump' ) ) ) { - unset( $wp['subcommands'][ $k ] ); - } - } - $wp['subcommands'] = array_values( $wp['subcommands'] ); - - // generate main page - file_put_contents( '_includes/cmd-list.html', render( 'cmd-list.mustache', $wp ) ); - WP_CLI::log( 'Generated /commands/' ); - - foreach ( $wp['subcommands'] as $cmd ) { - gen_cmd_pages( $cmd ); - } - WP_CLI::success( 'Generated all command pages.' ); -} -WP_CLI::add_command( 'website generate-commands', '\WP_CLI_Org\generate_commands' ); - -function gen_cmd_pages( $cmd, $parent = array() ) { - $parent[] = $cmd['name']; - - $binding = $cmd; - $binding['synopsis'] = implode( ' ', $parent ); - $binding['path'] = implode( '/', $parent ); - $path = '/commands/'; - $binding['breadcrumbs'] = '[Commands](' . $path . ')'; - foreach( $parent as $i => $p ) { - $path .= $p . '/'; - if ( $i < ( count( $parent ) - 1 ) ) { - $binding['breadcrumbs'] .= " » [{$p}]({$path})"; - } else { - $binding['breadcrumbs'] .= " » {$p}"; - } - } - $binding['has-subcommands'] = isset( $cmd['subcommands'] ) ? array(true) : false; - - if ( $cmd['longdesc'] ) { - $docs = $cmd['longdesc']; - $docs = htmlspecialchars( $docs, ENT_COMPAT, 'UTF-8' ); - - // decrease header level - $docs = preg_replace( '/^## /m', '### ', $docs ); - - // escape `--` so that it doesn't get converted into `—` - $docs = preg_replace( '/^(\[?)--/m', '\1\--', $docs ); - $docs = preg_replace( '/^\s\s--/m', ' \1\--', $docs ); - - // hack to prevent double encoding in code blocks - $docs = preg_replace( '/ < /', ' < ', $docs ); - $docs = preg_replace( '/ > /', ' > ', $docs ); - $docs = preg_replace( '/ <</', ' <<', $docs ); - $docs = preg_replace( '/"/', '"', $docs ); - $docs = preg_replace( '/wp> /', 'wp> ', $docs ); - $docs = preg_replace( '/=>/', '=>', $docs ); - - // Strip global parameters -> added in footer - $docs = preg_replace( '/#?## GLOBAL PARAMETERS.+/s', '', $docs ); - - $binding['docs'] = $docs; - $binding['github_issues_link'] = 'https://github.com/wp-cli/wp-cli/issues?q=is%3Aopen+label%3A' . urlencode( 'command:' . str_replace( ' ', '-', $binding['synopsis'] ) ) . '+sort%3Aupdated-desc'; - } - - $path = __DIR__ . "/commands/" . $binding['path']; - if ( !is_dir( $path ) ) { - mkdir( $path ); - } - file_put_contents( "$path/index.md", render( 'subcmd-list.mustache', $binding ) ); - WP_CLI::log( 'Generated /commands/' . $binding['path'] . '/' ); - - if ( !isset( $cmd['subcommands'] ) ) - return; - - foreach ( $cmd['subcommands'] as $subcmd ) { - gen_cmd_pages( $subcmd, $parent ); - } -} - function invoke_wp_cli( $cmd ) { ob_start(); system( "WP_CLI_CONFIG_PATH=/dev/null $cmd", $return_code ); @@ -153,9 +67,3 @@ function invoke_wp_cli( $cmd ) { return json_decode( $json, true ); } - -function render( $path, $binding ) { - $m = new Mustache_Engine; - $template = file_get_contents( __DIR__ . "/_templates/$path" ); - return $m->render( $template, $binding ); -} diff --git a/commands/blog/create/index.md b/commands/blog/create/index.md deleted file mode 100644 index 6309a190..00000000 --- a/commands/blog/create/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: default -title: 'wp blog create' ---- -The `wp blog create` command has been renamed to [wp site create](/commands/site/create) in WP-CLI 0.11. diff --git a/commands/blog/delete/index.md b/commands/blog/delete/index.md deleted file mode 100644 index e0bd27f4..00000000 --- a/commands/blog/delete/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: default -title: 'wp blog delete' ---- -The `wp blog delete` command has been renamed to [wp site delete](/commands/site/delete) in WP-CLI 0.11. diff --git a/commands/blog/empty/index.md b/commands/blog/empty/index.md deleted file mode 100644 index e6219d29..00000000 --- a/commands/blog/empty/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: default -title: 'wp blog empty' ---- -The `wp blog empty` command has been renamed to [wp site empty](/commands/site/empty) in WP-CLI 0.11. diff --git a/commands/blog/index.md b/commands/blog/index.md deleted file mode 100644 index eaf889a0..00000000 --- a/commands/blog/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: default -title: 'wp blog' ---- -The `wp blog` command has been renamed to [wp site](/commands/site) in WP-CLI 0.11. diff --git a/commands/cache/add/index.md b/commands/cache/add/index.md deleted file mode 100644 index 72617b6a..00000000 --- a/commands/cache/add/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: default -title: 'wp cache add' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » add - -`wp cache add` - Add a value to the object cache. - -Quick links: Github issues - -
- -Errors if a value already exists for the key, which means the value can't -be added. - -### OPTIONS - -<key> -: Cache key. - -<value> -: Value to add to the key. - -[<group>] -: Method for grouping data within the cache which allows the same key to be used across groups. -\--- -default: default -\--- - -[<expiration>] -: Define how long to keep the value, in seconds. `0` means as long as possible. -\--- -default: 0 -\--- - -### EXAMPLES - - # Add cache. - $ wp cache add my_key my_group my_value 300 - Success: Added object 'my_key' in group 'my_value'. - - - diff --git a/commands/cache/decr/index.md b/commands/cache/decr/index.md deleted file mode 100644 index d98fe096..00000000 --- a/commands/cache/decr/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: 'wp cache decr' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » decr - -`wp cache decr` - Decrement a value in the object cache. - -Quick links: Github issues - -
- -Errors if the value can't be decremented. - -### OPTIONS - -<key> -: Cache key. - -[<offset>] -: The amount by which to decrement the item's value. -\--- -default: 1 -\--- - -[<group>] -: Method for grouping data within the cache which allows the same key to be used across groups. -\--- -default: default -\--- - -### EXAMPLES - - # Decrease cache value. - $ wp cache decr my_key 2 my_group - 48 - - - diff --git a/commands/cache/delete/index.md b/commands/cache/delete/index.md deleted file mode 100644 index 1a562f2d..00000000 --- a/commands/cache/delete/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default -title: 'wp cache delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » delete - -`wp cache delete` - Remove a value from the object cache. - -Quick links: Github issues - -
- -Errors if the value can't be deleted. - -### OPTIONS - -<key> -: Cache key. - -[<group>] -: Method for grouping data within the cache which allows the same key to be used across groups. -\--- -default: default -\--- - -### EXAMPLES - - # Delete cache. - $ wp cache delete my_key my_group - Success: Object deleted. - - - diff --git a/commands/cache/flush/index.md b/commands/cache/flush/index.md deleted file mode 100644 index 7b967ce1..00000000 --- a/commands/cache/flush/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp cache flush' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » flush - -`wp cache flush` - Flush the object cache. - -Quick links: Github issues - -
- -For WordPress multisite instances using a persistent object cache, -flushing the object cache will typically flush the cache for all sites. -Beware of the performance impact when flushing the object cache in -production. - -Errors if the object cache can't be flushed. - -### EXAMPLES - - # Flush cache. - $ wp cache flush - Success: The cache was flushed. - - - diff --git a/commands/cache/get/index.md b/commands/cache/get/index.md deleted file mode 100644 index 6512625c..00000000 --- a/commands/cache/get/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default -title: 'wp cache get' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » get - -`wp cache get` - Get a value from the object cache. - -Quick links: Github issues - -
- -Errors if the value doesn't exist. - -### OPTIONS - -<key> -: Cache key. - -[<group>] -: Method for grouping data within the cache which allows the same key to be used across groups. -\--- -default: default -___ - -### EXAMPLES - - # Get cache. - $ wp cache get my_key my_group - my_value - - - diff --git a/commands/cache/incr/index.md b/commands/cache/incr/index.md deleted file mode 100644 index 3b0c37c0..00000000 --- a/commands/cache/incr/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: 'wp cache incr' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » incr - -`wp cache incr` - Increment a value in the object cache. - -Quick links: Github issues - -
- -Errors if the value can't be incremented. - -### OPTIONS - -<key> -: Cache key. - -[<offset>] -: The amount by which to increment the item's value. -\--- -default: 1 -\--- - -[<group>] -: Method for grouping data within the cache which allows the same key to be used across groups. -\--- -default: default -\--- - -### EXAMPLES - - # Increase cache value. - $ wp cache incr my_key 2 my_group - 50 - - - diff --git a/commands/cache/index.md b/commands/cache/index.md deleted file mode 100644 index cf19501a..00000000 --- a/commands/cache/index.md +++ /dev/null @@ -1,76 +0,0 @@ ---- -layout: default -title: 'wp cache' -display_global_parameters: true ---- - -[Commands](/commands/) » cache - -`wp cache` - Manage the object cache. - -Quick links: Github issues - -
- -Use a persistent object cache drop-in to persist cache values between requests. - -### EXAMPLES - - # Set cache. - $ wp cache set my_key my_value my_group 300 - Success: Set object 'my_key' in group 'my_group'. - - # Get cache. - $ wp cache get my_key my_group - my_value - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a value to the object cache.
decrDecrement a value in the object cache.
deleteRemove a value from the object cache.
flushFlush the object cache.
getGet a value from the object cache.
incrIncrement a value in the object cache.
replaceReplace a value in the object cache, if the value already exists.
setSet a value to the object cache, regardless of whether it already exists.
typeAttempts to determine which object cache is being used.
diff --git a/commands/cache/replace/index.md b/commands/cache/replace/index.md deleted file mode 100644 index 1f4362a6..00000000 --- a/commands/cache/replace/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: 'wp cache replace' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » replace - -`wp cache replace` - Replace a value in the object cache, if the value already exists. - -Quick links: Github issues - -
- -Errors if the value can't be replaced. - -### OPTIONS - -<key> -: Cache key. - -<value> -: Value to replace. - -[<group>] -: Method for grouping data within the cache which allows the same key to be used across groups. -\--- -default: default -\--- - -[<expiration>] -: Define how long to keep the value, in seconds. `0` means as long as possible. -\--- -default: 0 -\--- - -### EXAMPLES - - # Replace cache. - $ wp cache replace my_key new_value my_group - Success: Replaced object 'my_key' in group 'my_group'. - - - diff --git a/commands/cache/set/index.md b/commands/cache/set/index.md deleted file mode 100644 index 45778f34..00000000 --- a/commands/cache/set/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: 'wp cache set' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » set - -`wp cache set` - Set a value to the object cache, regardless of whether it already exists. - -Quick links: Github issues - -
- -Errors if the value can't be set. - -### OPTIONS - -<key> -: Cache key. - -<value> -: Value to set on the key. - -[<group>] -: Method for grouping data within the cache which allows the same key to be used across groups. -\--- -default: default -\--- - -[<expiration>] -: Define how long to keep the value, in seconds. `0` means as long as possible. -\--- -default: 0 -\--- - -### EXAMPLES - - # Set cache. - $ wp cache set my_key my_value my_group 300 - Success: Set object 'my_key' in group 'my_group'. - - - diff --git a/commands/cache/type/index.md b/commands/cache/type/index.md deleted file mode 100644 index 3cec8c1d..00000000 --- a/commands/cache/type/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp cache type' -display_global_parameters: true ---- - -[Commands](/commands/) » [cache](/commands/cache/) » type - -`wp cache type` - Attempts to determine which object cache is being used. - -Quick links: Github issues - -
- -Note that the guesses made by this function are based on the -WP_Object_Cache classes that define the 3rd party object cache extension. -Changes to those classes could render problems with this function's -ability to determine which object cache is being used. - -### EXAMPLES - - # Check cache type. - $ wp cache type - Default - - - diff --git a/commands/cap/add/index.md b/commands/cap/add/index.md deleted file mode 100644 index 886ec996..00000000 --- a/commands/cap/add/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp cap add' -display_global_parameters: true ---- - -[Commands](/commands/) » [cap](/commands/cap/) » add - -`wp cap add` - Add capabilities to a given role. - -Quick links: Github issues - -
- -### OPTIONS - -<role> -: Key for the role. - -<cap>... -: One or more capabilities to add. - -### EXAMPLES - - # Add 'spectate' capability to 'author' role. - $ wp cap add author spectate - Success: Added 1 capability to 'author' role. - - - diff --git a/commands/cap/index.md b/commands/cap/index.md deleted file mode 100644 index 08f3e7bd..00000000 --- a/commands/cap/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -layout: default -title: 'wp cap' -display_global_parameters: true ---- - -[Commands](/commands/) » cap - -`wp cap` - Manage user capabilities. - -Quick links: Github issues - -
- -### EXAMPLES - - # Add 'spectate' capability to 'author' role. - $ wp cap add 'author' 'spectate' - Success: Added 1 capability to 'author' role. - - # Add all caps from 'editor' role to 'author' role. - $ wp cap list 'editor' | xargs wp cap add 'author' - Success: Added 24 capabilities to 'author' role. - - # Remove all caps from 'editor' role that also appear in 'author' role. - $ wp cap list 'author' | xargs wp cap remove 'editor' - Success: Removed 34 capabilities from 'editor' role. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd capabilities to a given role.
listList capabilities for a given role.
removeRemove capabilities from a given role.
diff --git a/commands/cap/list/index.md b/commands/cap/list/index.md deleted file mode 100644 index a3249375..00000000 --- a/commands/cap/list/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: 'wp cap list' -display_global_parameters: true ---- - -[Commands](/commands/) » [cap](/commands/cap/) » list - -`wp cap list` - List capabilities for a given role. - -Quick links: Github issues - -
- -### OPTIONS - -<role> -: Key for the role. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: list -options: - - list - - table - - csv - - json - - count - - yaml -\--- - -### EXAMPLES - - # Display alphabetical list of Contributor capabilities. - $ wp cap list 'contributor' | sort - delete_posts - edit_posts - level_0 - level_1 - read - - - diff --git a/commands/cap/remove/index.md b/commands/cap/remove/index.md deleted file mode 100644 index c076c861..00000000 --- a/commands/cap/remove/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp cap remove' -display_global_parameters: true ---- - -[Commands](/commands/) » [cap](/commands/cap/) » remove - -`wp cap remove` - Remove capabilities from a given role. - -Quick links: Github issues - -
- -### OPTIONS - -<role> -: Key for the role. - -<cap>... -: One or more capabilities to remove. - -### EXAMPLES - - # Remove 'spectate' capability from 'author' role. - $ wp cap remove author spectate - Success: Removed 1 capability from 'author' role. - - - diff --git a/commands/cli/alias/index.md b/commands/cli/alias/index.md deleted file mode 100644 index 09bec99e..00000000 --- a/commands/cli/alias/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: 'wp cli alias' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » alias - -`wp cli alias` - List available WP-CLI aliases. - -Quick links: Github issues - -
- -Aliases are shorthand references to WordPress installs. For instance, -`@dev` could refer to a development install and `@prod` could refer to -a production install. This command gives you visibility in what -registered aliases you have available. - -### OPTIONS - -[\--format=<format>] -: Render output in a particular format. -\--- -default: yaml -options: - - yaml - - json -\--- - -### EXAMPLES - - # List all available aliases. - $ wp cli alias - --- - @all: Run command against every registered alias. - @prod: - ssh: runcommand@runcommand.io~/webapps/production - @dev: - ssh: vagrant@192.168.50.10/srv/www/runcommand.dev - @both: - - @prod - - @dev - - - diff --git a/commands/cli/check-update/index.md b/commands/cli/check-update/index.md deleted file mode 100644 index 338e7721..00000000 --- a/commands/cli/check-update/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: 'wp cli check-update' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » check-update - -`wp cli check-update` - Check to see if there is a newer version of WP-CLI available. - -Quick links: Github issues - -
- -Queries the Github releases API. Returns available versions if there are -updates available, or success message if using the latest release. - -### OPTIONS - -[\--patch] -: Only list patch updates. - -[\--minor] -: Only list minor updates. - -[\--major] -: Only list major updates. - -[\--field=<field>] -: Prints the value of a single field for each update. - -[\--fields=<fields>] -: Limit the output to specific object fields. Defaults to version,update_type,package_url. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - count - - yaml -\--- - -### EXAMPLES - - # Check for update. - $ wp cli check-update - Success: WP-CLI is at the latest version. - - # Check for update and new version is available. - $ wp cli check-update - +---------+-------------+-------------------------------------------------------------------------------+ - | version | update_type | package_url | - +---------+-------------+-------------------------------------------------------------------------------+ - | 0.24.1 | patch | https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar | - +---------+-------------+-------------------------------------------------------------------------------+ - - - diff --git a/commands/cli/cmd-dump/index.md b/commands/cli/cmd-dump/index.md deleted file mode 100644 index 66492521..00000000 --- a/commands/cli/cmd-dump/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -layout: default -title: 'wp cli cmd-dump' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » cmd-dump - -`wp cli cmd-dump` - Dump the list of installed commands, as JSON. - -Quick links: Github issues - -
- -### EXAMPLES - - # Dump the list of installed commands. - $ wp cli cmd-dump - {"name":"wp","description":"Manage WordPress through the command-line.","longdesc":"\n\n - diff --git a/commands/cli/completions/index.md b/commands/cli/completions/index.md deleted file mode 100644 index cb2599e0..00000000 --- a/commands/cli/completions/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: 'wp cli completions' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » completions - -`wp cli completions` - Generate tab completion strings. - -Quick links: Github issues - -
- -### OPTIONS - -\--line=<line> -: The current command line to be executed. - -\--point=<point> -: The index to the current cursor position relative to the beginning of the command. - -### EXAMPLES - - # Generate tab completion strings. - $ wp cli completions --line='wp eva' --point=100 - eval - eval-file - - - diff --git a/commands/cli/index.md b/commands/cli/index.md deleted file mode 100644 index 7dec2e0c..00000000 --- a/commands/cli/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -layout: default -title: 'wp cli' -display_global_parameters: true ---- - -[Commands](/commands/) » cli - -`wp cli` - Manage WP-CLI itself. - -Quick links: Github issues - -
- -### EXAMPLES - - # Display the version currently installed. - $ wp cli version - WP-CLI 0.24.1 - - # Check for updates to WP-CLI. - $ wp cli check-update - Success: WP-CLI is at the latest version. - - # Update WP-CLI to the latest stable release. - $ wp cli update - You have version 0.24.0. Would you like to update to 0.24.1? [y/n] y - Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar... - New version works. Proceeding to replace. - Success: Updated WP-CLI to 0.24.1. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
aliasList available WP-CLI aliases.
check-updateCheck to see if there is a newer version of WP-CLI available.
cmd-dumpDump the list of installed commands, as JSON.
completionsGenerate tab completion strings.
infoPrint various details about the WP-CLI environment.
param-dumpDump the list of global parameters, as JSON or in var_export format.
updateUpdate WP-CLI to the latest release.
versionPrint WP-CLI version.
diff --git a/commands/cli/info/index.md b/commands/cli/info/index.md deleted file mode 100644 index 85f7bbd3..00000000 --- a/commands/cli/info/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: default -title: 'wp cli info' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » info - -`wp cli info` - Print various details about the WP-CLI environment. - -Quick links: Github issues - -
- -Helpful for diagnostic purposes, this command shares: - -* PHP binary used. -* PHP binary version. -* php.ini configuration file used (which is typically different than web). -* WP-CLI root dir: where WP-CLI is installed (if non-Phar install). -* WP-CLI global config: where the global config YAML file is located. -* WP-CLI project config: where the project config YAML file is located. -* WP-CLI version: currently installed version. - -See [config docs](https://wp-cli.org/config/) for more details on global -and project config YAML files. - -### OPTIONS - -[\--format=<format>] -: Render output in a particular format. -\--- -default: list -options: - - list - - json -\--- - -### EXAMPLES - - # Display various data about the CLI environment. - $ wp cli info - PHP binary: /usr/bin/php5 - PHP version: 5.5.9-1ubuntu4.16 - php.ini used: /etc/php5/cli/php.ini - WP-CLI root dir: phar://wp-cli.phar - WP-CLI packages dir: /home/person/.wp-cli/packages/ - WP-CLI global config: - WP-CLI project config: - WP-CLI version: 0.24.1 - - - diff --git a/commands/cli/param-dump/index.md b/commands/cli/param-dump/index.md deleted file mode 100644 index 2edec765..00000000 --- a/commands/cli/param-dump/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default -title: 'wp cli param-dump' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » param-dump - -`wp cli param-dump` - Dump the list of global parameters, as JSON or in var_export format. - -Quick links: Github issues - -
- -### OPTIONS - -[\--with-values] -: Display current values also. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: json -options: - - var_export - - json -\--- - -### EXAMPLES - - # Dump the list of global parameters. - $ wp cli param-dump --format=var_export - array ( - 'path' => - array ( - 'runtime' => '=<path>', - 'file' => '<path>', - 'synopsis' => '', - 'default' => NULL, - 'multiple' => false, - 'desc' => 'Path to the WordPress files.', - ), - 'url' => - array ( - - - diff --git a/commands/cli/update/index.md b/commands/cli/update/index.md deleted file mode 100644 index 01404897..00000000 --- a/commands/cli/update/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: default -title: 'wp cli update' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » update - -`wp cli update` - Update WP-CLI to the latest release. - -Quick links: Github issues - -
- -Default behavior is to check the releases API for the newest stable -version, and prompt if one is available. - -Use `--stable` to install or reinstall the latest stable version. - -Use `--nightly` to install the latest built version of the master branch. -While not recommended for production, nightly contains the latest and -greatest, and should be stable enough for development and staging -environments. - -Only works for the Phar installation mechanism. - -### OPTIONS - -[\--patch] -: Only perform patch updates. - -[\--minor] -: Only perform minor updates. - -[\--major] -: Only perform major updates. - -[\--stable] -: Update to the latest stable release. Skips update check. - -[\--nightly] -: Update to the latest built version of the master branch. Potentially unstable. - -[\--yes] -: Do not prompt for confirmation. - -### EXAMPLES - - # Update CLI. - $ wp cli update - You have version 0.24.0. Would you like to update to 0.24.1? [y/n] y - Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar... - New version works. Proceeding to replace. - Success: Updated WP-CLI to 0.24.1. - - - diff --git a/commands/cli/version/index.md b/commands/cli/version/index.md deleted file mode 100644 index e2182e14..00000000 --- a/commands/cli/version/index.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -layout: default -title: 'wp cli version' -display_global_parameters: true ---- - -[Commands](/commands/) » [cli](/commands/cli/) » version - -`wp cli version` - Print WP-CLI version. - -Quick links: Github issues - -
- -### EXAMPLES - - # Display CLI version. - $ wp cli version - WP-CLI 0.24.1 - - - diff --git a/commands/comment/approve/index.md b/commands/comment/approve/index.md deleted file mode 100644 index 879ae2a7..00000000 --- a/commands/comment/approve/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment approve' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » approve - -`wp comment approve` - Approve a comment. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: The IDs of the comments to approve. - -### EXAMPLES - - # Approve comment. - $ wp comment approve 1337 - Success: Approved comment 1337. - - - diff --git a/commands/comment/count/index.md b/commands/comment/count/index.md deleted file mode 100644 index 600431c2..00000000 --- a/commands/comment/count/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp comment count' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » count - -`wp comment count` - Count comments, on whole blog or on a given post. - -Quick links: Github issues - -
- -### 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 - - - diff --git a/commands/comment/create/index.md b/commands/comment/create/index.md deleted file mode 100644 index a669bdb2..00000000 --- a/commands/comment/create/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp comment create' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » create - -`wp comment create` - Create a new comment. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/comment/delete/index.md b/commands/comment/delete/index.md deleted file mode 100644 index e44e2362..00000000 --- a/commands/comment/delete/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default -title: 'wp comment delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » delete - -`wp comment delete` - Delete a comment. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/comment/exists/index.md b/commands/comment/exists/index.md deleted file mode 100644 index 01b31ac0..00000000 --- a/commands/comment/exists/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp comment exists' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » exists - -`wp comment exists` - Verify whether a comment exists. - -Quick links: Github issues - -
- -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. - - - diff --git a/commands/comment/generate/index.md b/commands/comment/generate/index.md deleted file mode 100644 index 90a6018b..00000000 --- a/commands/comment/generate/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default -title: 'wp comment generate' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » generate - -`wp comment generate` - Generate some number of new dummy comments. - -Quick links: Github issues - -
- -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. - - - diff --git a/commands/comment/get/index.md b/commands/comment/get/index.md deleted file mode 100644 index cfa28bd0..00000000 --- a/commands/comment/get/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: 'wp comment get' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » get - -`wp comment get` - Get data of a single comment. - -Quick links: Github issues - -
- -### 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! - - - diff --git a/commands/comment/index.md b/commands/comment/index.md deleted file mode 100644 index 97695ee7..00000000 --- a/commands/comment/index.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -layout: default -title: 'wp comment' -display_global_parameters: true ---- - -[Commands](/commands/) » comment - -`wp comment` - Manage comments. - -Quick links: Github issues - -
- -### 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. - - # Delete all spam comments. - $ wp comment delete $(wp comment list --status=spam --format=ids) - Success: Deleted comment 264. - Success: Deleted comment 262. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
approveApprove a comment.
countCount comments, on whole blog or on a given post.
createCreate a new comment.
deleteDelete a comment.
existsVerify whether a comment exists.
generateGenerate some number of new dummy comments.
getGet data of a single comment.
listGet a list of comments.
metaManage comment custom fields.
recountRecalculate the comment_count value for one or more posts.
spamMark a comment as spam.
statusGet status of a comment.
trashTrash a comment.
unapproveUnapprove a comment.
unspamUnmark a comment as spam.
untrashUntrash a comment.
updateUpdate one or more comments.
diff --git a/commands/comment/list/index.md b/commands/comment/list/index.md deleted file mode 100644 index e8aa1cb4..00000000 --- a/commands/comment/list/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -layout: default -title: 'wp comment list' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » list - -`wp comment list` - Get a list of comments. - -Quick links: Github issues - -
- -### 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 | - +------------+---------------------+----------------+ - - - diff --git a/commands/comment/meta/add/index.md b/commands/comment/meta/add/index.md deleted file mode 100644 index 0bc10b58..00000000 --- a/commands/comment/meta/add/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp comment meta add' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » [meta](/commands/comment/meta/) » add - -`wp comment meta add` - Add a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/comment/meta/delete/index.md b/commands/comment/meta/delete/index.md deleted file mode 100644 index afea2b7b..00000000 --- a/commands/comment/meta/delete/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp comment meta delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » [meta](/commands/comment/meta/) » delete - -`wp comment meta delete` - Delete a meta field. - -Quick links: Github issues - -
- -<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. - - - diff --git a/commands/comment/meta/get/index.md b/commands/comment/meta/get/index.md deleted file mode 100644 index f8955400..00000000 --- a/commands/comment/meta/get/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: 'wp comment meta get' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » [meta](/commands/comment/meta/) » get - -`wp comment meta get` - Get meta field value. - -Quick links: Github issues - -
- -<id> -: The ID of the object. - -<key> -: The name of the meta field to get. - -[\--format=<format>] -: Accepted values: table, json. Default: table - - - diff --git a/commands/comment/meta/index.md b/commands/comment/meta/index.md deleted file mode 100644 index 345cc2a1..00000000 --- a/commands/comment/meta/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: default -title: 'wp comment meta' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » meta - -`wp comment meta` - Manage comment custom fields. - -Quick links: Github issues - -
- -### 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. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a meta field.
deleteDelete a meta field.
getGet meta field value.
listList all metadata associated with an object.
updateUpdate a meta field.
diff --git a/commands/comment/meta/list/index.md b/commands/comment/meta/list/index.md deleted file mode 100644 index 4a8b0e2c..00000000 --- a/commands/comment/meta/list/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp comment meta list' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » [meta](/commands/comment/meta/) » list - -`wp comment meta list` - List all metadata associated with an object. - -Quick links: Github issues - -
- -<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>] -: Accepted values: table, csv, json, count. Default: table - - - diff --git a/commands/comment/meta/update/index.md b/commands/comment/meta/update/index.md deleted file mode 100644 index 4767e07c..00000000 --- a/commands/comment/meta/update/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp comment meta update' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » [meta](/commands/comment/meta/) » update - -`wp comment meta update` - Update a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/comment/recount/index.md b/commands/comment/recount/index.md deleted file mode 100644 index a46df792..00000000 --- a/commands/comment/recount/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment recount' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » recount - -`wp comment recount` - Recalculate the comment_count value for one or more posts. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/comment/spam/index.md b/commands/comment/spam/index.md deleted file mode 100644 index 18e26880..00000000 --- a/commands/comment/spam/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment spam' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » spam - -`wp comment spam` - Mark a comment as spam. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: The IDs of the comments to mark as spam. - -### EXAMPLES - - # Spam comment. - $ wp comment spam 1337 - Success: Marked as spam comment 1337. - - - diff --git a/commands/comment/status/index.md b/commands/comment/status/index.md deleted file mode 100644 index 8273029a..00000000 --- a/commands/comment/status/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment status' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » status - -`wp comment status` - Get status of a comment. - -Quick links: Github issues - -
- -### OPTIONS - -<id> -: The ID of the comment to check. - -### EXAMPLES - - # Get status of comment. - $ wp comment status 1337 - approved - - - diff --git a/commands/comment/trash/index.md b/commands/comment/trash/index.md deleted file mode 100644 index ef6a1cfb..00000000 --- a/commands/comment/trash/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment trash' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » trash - -`wp comment trash` - Trash a comment. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: The IDs of the comments to trash. - -### EXAMPLES - - # Trash comment. - $ wp comment trash 1337 - Success: Trashed comment 1337. - - - diff --git a/commands/comment/unapprove/index.md b/commands/comment/unapprove/index.md deleted file mode 100644 index 552b8481..00000000 --- a/commands/comment/unapprove/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment unapprove' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » unapprove - -`wp comment unapprove` - Unapprove a comment. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: The IDs of the comments to unapprove. - -### EXAMPLES - - # Unapprove comment. - $ wp comment unapprove 1337 - Success: Unapproved comment 1337. - - - diff --git a/commands/comment/unspam/index.md b/commands/comment/unspam/index.md deleted file mode 100644 index 4896ef0d..00000000 --- a/commands/comment/unspam/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment unspam' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » unspam - -`wp comment unspam` - Unmark a comment as spam. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: The IDs of the comments to unmark as spam. - -### EXAMPLES - - # Unspam comment. - $ wp comment unspam 1337 - Success: Unspammed comment 1337. - - - diff --git a/commands/comment/untrash/index.md b/commands/comment/untrash/index.md deleted file mode 100644 index b93e2fd6..00000000 --- a/commands/comment/untrash/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp comment untrash' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » untrash - -`wp comment untrash` - Untrash a comment. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: The IDs of the comments to untrash. - -### EXAMPLES - - # Untrash comment. - $ wp comment untrash 1337 - Success: Untrashed comment 1337. - - - diff --git a/commands/comment/update/index.md b/commands/comment/update/index.md deleted file mode 100644 index 97a191ab..00000000 --- a/commands/comment/update/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp comment update' -display_global_parameters: true ---- - -[Commands](/commands/) » [comment](/commands/comment/) » update - -`wp comment update` - Update one or more comments. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/core/check-update/index.md b/commands/core/check-update/index.md deleted file mode 100644 index 90c1ebe5..00000000 --- a/commands/core/check-update/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -layout: default -title: 'wp core check-update' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » check-update - -`wp core check-update` - Check for WordPress updates via Version Check API. - -Quick links: Github issues - -
- -Lists the most recent versions when there are updates available, -or success message when up to date. - -### OPTIONS - -[\--minor] -: Compare only the first two parts of the version number. - -[\--major] -: Compare only the first part of the version number. - -[\--field=<field>] -: Prints the value of a single field for each update. - -[\--fields=<fields>] -: Limit the output to specific object fields. Defaults to version,update_type,package_url. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - count - - json - - yaml -\--- - -### EXAMPLES - - $ wp core check-update - +---------+-------------+-------------------------------------------------------------+ - | version | update_type | package_url | - +---------+-------------+-------------------------------------------------------------+ - | 4.5.2 | major | https://downloads.wordpress.org/release/wordpress-4.5.2.zip | - +---------+-------------+-------------------------------------------------------------+ - - - diff --git a/commands/core/config/index.md b/commands/core/config/index.md deleted file mode 100644 index 910214f9..00000000 --- a/commands/core/config/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -layout: default -title: 'wp core config' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » config - -`wp core config` - Generate a wp-config.php file. - -Quick links: Github issues - -
- -Creates a new wp-config.php with database constants, and verifies that -the database constants are correct. - -### OPTIONS - -\--dbname=<dbname> -: Set the database name. - -\--dbuser=<dbuser> -: Set the database user. - -[\--dbpass=<dbpass>] -: Set the database user password. - -[\--dbhost=<dbhost>] -: Set the database host. -\--- -default: localhost -\--- - -[\--dbprefix=<dbprefix>] -: Set the database table prefix. -\--- -default: wp_ -\--- - -[\--dbcharset=<dbcharset>] -: Set the database charset. -\--- -default: utf8 -\--- - -[\--dbcollate=<dbcollate>] -: Set the database collation. -\--- -default: -\--- - -[\--locale=<locale>] -: Set the WPLANG constant. Defaults to $wp_local_package variable. - -[\--extra-php] -: If set, the command copies additional PHP code into wp-config.php from STDIN. - -[\--skip-salts] -: If set, keys and salts won't be generated, but should instead be passed via `--extra-php`. - -[\--skip-check] -: If set, the database connection is not checked. - -[\--force] -: Overwrites existing files, if present. - -### EXAMPLES - - # Standard wp-config.php file - $ wp core config --dbname=testing --dbuser=wp --dbpass=securepswd --locale=ro_RO - Success: Generated 'wp-config.php' file. - - # Enable WP_DEBUG and WP_DEBUG_LOG - $ wp core config --dbname=testing --dbuser=wp --dbpass=securepswd --extra-php <[Commands](/commands/) » [core](/commands/core/) » download - -`wp core download` - Download core WordPress files. - -Quick links: Github issues - -
- -Downloads and extracts WordPress core files to the specified path. Uses -an archive file stored in cache if WordPress has been previously -downloaded. - -### OPTIONS - -[\--path=<path>] -: Specify the path in which to install WordPress. - -[\--locale=<locale>] -: Select which language you want to download. - -[\--version=<version>] -: Select which version you want to download. Accepts a version number, 'latest' or 'nightly' - -[\--force] -: Overwrites existing files, if present. - -### EXAMPLES - - $ wp core download --locale=nl_NL - Downloading WordPress 4.5.2 (nl_NL)... - md5 hash verified: c5366d05b521831dd0b29dfc386e56a5 - Success: WordPress downloaded. - - - diff --git a/commands/core/index.md b/commands/core/index.md deleted file mode 100644 index d19041a8..00000000 --- a/commands/core/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: default -title: 'wp core' -display_global_parameters: true ---- - -[Commands](/commands/) » core - -`wp core` - Download, install, update and manage a WordPress install. - -Quick links: Github issues - -
- -### EXAMPLES - - # Download WordPress core - $ wp core download --locale=nl_NL - Downloading WordPress 4.5.2 (nl_NL)... - md5 hash verified: c5366d05b521831dd0b29dfc386e56a5 - Success: WordPress downloaded. - - # Install WordPress - $ wp core install --url=example.com --title=Example --admin_user=supervisor --admin_password=strongpassword --admin_email=info@example.com - Success: WordPress installed successfully. - - # Display the WordPress version - $ wp core version - 4.5.2 - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
check-updateCheck for WordPress updates via Version Check API.
configGenerate a wp-config.php file.
downloadDownload core WordPress files.
installRuns the standard WordPress installation process.
is-installedCheck if WordPress is installed.
languageManage core language.
multisite-convertTransform a single-site install into a WordPress multisite install.
multisite-installInstall WordPress multisite from scratch.
updateUpdate WordPress to a newer version.
update-dbRun the WordPress database update procedure.
verify-checksumsVerify WordPress files against WordPress.org's checksums.
versionDisplay the WordPress version.
diff --git a/commands/core/install-network/index.md b/commands/core/install-network/index.md deleted file mode 100644 index 14d8ec06..00000000 --- a/commands/core/install-network/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -layout: default -title: 'wp core install-network' ---- -The `wp core install-network` command has been renamed to [wp core multisite-convert](/commands/core/multisite-convert) in WP-CLI 0.11. diff --git a/commands/core/install/index.md b/commands/core/install/index.md deleted file mode 100644 index 3545d0ca..00000000 --- a/commands/core/install/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: 'wp core install' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » install - -`wp core install` - Runs the standard WordPress installation process. - -Quick links: Github issues - -
- -Creates the WordPress tables in the database using the URL, title, and -default admin user details provided. Performs the famous 5 minute install -in seconds or less. - -Note: if you've installed WordPress in a subdirectory, then you'll need -to `wp option update siteurl` after `wp core install`. For instance, if -WordPress is installed in the `/wp` directory and your domain is wp.dev, -then you'll need to run `wp option update siteurl http://wp.dev/wp` for -your WordPress install to function properly. - -Note: When using custom user tables (e.g. `CUSTOM_USER_TABLE`), the admin -email and password are ignored if the user_login already exists. If the -user_login doesn't exist, a new user will be created. - -### OPTIONS - -\--url=<url> -: The address of the new site. - -\--title=<site-title> -: The title of the new site. - -\--admin_user=<username> -: The name of the admin user. - -[\--admin_password=<password>] -: The password for the admin user. Defaults to randomly generated string. - -\--admin_email=<email> -: The email address for the admin user. - -[\--skip-email] -: Don't send an email notification to the new admin user. - -### EXAMPLES - - # Install WordPress in 5 seconds - $ wp core install --url=example.com --title=Example --admin_user=supervisor --admin_password=strongpassword --admin_email=info@example.com - Success: WordPress installed successfully. - - # Install WordPress without disclosing admin_password to bash history - $ wp core install --url=example.com --title=Example --admin_user=supervisor --admin_email=info@example.com --prompt=admin_password < admin_password.txt - - - diff --git a/commands/core/is-installed/index.md b/commands/core/is-installed/index.md deleted file mode 100644 index 89bea87a..00000000 --- a/commands/core/is-installed/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default -title: 'wp core is-installed' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » is-installed - -`wp core is-installed` - Check if WordPress is installed. - -Quick links: Github issues - -
- -Determines whether WordPress is installed by checking if the standard -database tables are installed. Doesn't produce output; uses exit codes -to communicate whether WordPress is installed. - -[\--network] -: Check if this is a multisite install. - -### EXAMPLES - - # Check whether WordPress is installed; exit status 0 if installed, otherwise 1 - $ wp core is-installed - $ echo $? - 1 - - # Bash script for checking whether WordPress is installed or not - if ! $(wp core is-installed); then - wp core install - fi - - - diff --git a/commands/core/language/activate/index.md b/commands/core/language/activate/index.md deleted file mode 100644 index fb35815a..00000000 --- a/commands/core/language/activate/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default -title: 'wp core language activate' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » [language](/commands/core/language/) » activate - -`wp core language activate` - Activate a given language. - -Quick links: Github issues - -
- -<language> -: Language code to activate. - -### EXAMPLES - - $ wp core language activate ja - Success: Language activated. - - - diff --git a/commands/core/language/index.md b/commands/core/language/index.md deleted file mode 100644 index 366a35c2..00000000 --- a/commands/core/language/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: default -title: 'wp core language' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » language - -`wp core language` - Manage core language. - -Quick links: Github issues - -
- -### EXAMPLES - - # Install language - $ wp core language install nl_NL - Success: Language installed. - - # Activate language - $ wp core language activate nl_NL - Success: Language activated. - - # Uninstall language - $ wp core language uninstall nl_NL - Success: Language uninstalled. - - # List installed languages - $ wp core language list --status=installed - +----------+--------------+-------------+-----------+-----------+---------------------+ - | language | english_name | native_name | status | update | updated | - +----------+--------------+-------------+-----------+-----------+---------------------+ - | nl_NL | Dutch | Nederlands | installed | available | 2016-05-13 08:12:50 | - +----------+--------------+-------------+-----------+-----------+---------------------+ - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
activateActivate a given language.
installInstall a given language.
listList all available languages.
uninstallUninstall a given language.
updateUpdate installed languages.
diff --git a/commands/core/language/install/index.md b/commands/core/language/install/index.md deleted file mode 100644 index f5c590e0..00000000 --- a/commands/core/language/install/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp core language install' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » [language](/commands/core/language/) » install - -`wp core language install` - Install a given language. - -Quick links: Github issues - -
- -Downloads the language pack from WordPress.org. - -<language> -: Language code to install. - -[\--activate] -: If set, the language will be activated immediately after install. - -### EXAMPLES - - # Install the Japanese language. - $ wp core language install ja - Success: Language installed. - - - diff --git a/commands/core/language/list/index.md b/commands/core/language/list/index.md deleted file mode 100644 index 7050b0db..00000000 --- a/commands/core/language/list/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: default -title: 'wp core language list' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » [language](/commands/core/language/) » list - -`wp core language list` - List all available languages. - -Quick links: Github issues - -
- -[\--field=<field>] -: Display the value of a single field - -[\--<field>=<value>] -: Filter results by key=value pairs. - -[\--fields=<fields>] -: Limit the output to specific fields. - -[\--format=<format>] -: Accepted values: table, csv, json. Default: table - -### AVAILABLE FIELDS - -These fields will be displayed by default for each translation: - -* language -* english_name -* native_name -* status -* update -* updated - -These fields are optionally available: - -* version -* package - -### EXAMPLES - - # List language,english_name,status fields of available languages. - $ wp core language list --fields=language,english_name,status - +----------------+-------------------------+-------------+ - | language | english_name | status | - +----------------+-------------------------+-------------+ - | ar | Arabic | uninstalled | - | ary | Moroccan Arabic | uninstalled | - | az | Azerbaijani | uninstalled | - - - diff --git a/commands/core/language/uninstall/index.md b/commands/core/language/uninstall/index.md deleted file mode 100644 index c44f0e59..00000000 --- a/commands/core/language/uninstall/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default -title: 'wp core language uninstall' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » [language](/commands/core/language/) » uninstall - -`wp core language uninstall` - Uninstall a given language. - -Quick links: Github issues - -
- -<language> -: Language code to uninstall. - -### EXAMPLES - - $ wp core language uninstall ja - Success: Language uninstalled. - - - diff --git a/commands/core/language/update/index.md b/commands/core/language/update/index.md deleted file mode 100644 index b3f559b7..00000000 --- a/commands/core/language/update/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default -title: 'wp core language update' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » [language](/commands/core/language/) » update - -`wp core language update` - Update installed languages. - -Quick links: Github issues - -
- -Updates installed languages for core, plugins and themes. - -[\--dry-run] -: Preview which translations would be updated. - -### EXAMPLES - - $ wp core language update - Updating 'Japanese' translation for Akismet 3.1.11... - Downloading translation from https://downloads.wordpress.org/translation/plugin/akismet/3.1.11/ja.zip... - Translation updated successfully. - Updating 'Japanese' translation for Twenty Fifteen 1.5... - Downloading translation from https://downloads.wordpress.org/translation/theme/twentyfifteen/1.5/ja.zip... - Translation updated successfully. - Success: Updated 2/2 translations. - - - diff --git a/commands/core/multisite-convert/index.md b/commands/core/multisite-convert/index.md deleted file mode 100644 index aa5a7f14..00000000 --- a/commands/core/multisite-convert/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp core multisite-convert' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » multisite-convert - -`wp core multisite-convert` - Transform a single-site install into a WordPress multisite install. - -Quick links: Github issues - -
- -Creates the multisite database tables, and adds the multisite constants -to wp-config.php. - -For those using WordPress with Apache, remember to update the `.htaccess` -file with the appropriate multisite rewrite rules. - -### OPTIONS - -[\--title=<network-title>] -: The title of the new network. - -[\--base=<url-path>] -: Base path after the domain name that each site url will start with. -\--- -default: / -\--- - -[\--subdomains] -: If passed, the network will use subdomains, instead of subdirectories. Doesn't work with 'localhost'. - -### EXAMPLES - - $ wp core multisite-convert - Set up multisite database tables. - Added multisite constants to wp-config.php. - Success: Network installed. Don't forget to set up rewrite rules. - - - diff --git a/commands/core/multisite-install/index.md b/commands/core/multisite-install/index.md deleted file mode 100644 index 1a7de1c0..00000000 --- a/commands/core/multisite-install/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: 'wp core multisite-install' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » multisite-install - -`wp core multisite-install` - Install WordPress multisite from scratch. - -Quick links: Github issues - -
- -Creates the WordPress tables in the database using the URL, title, and -default admin user details provided. Then, creates the multisite tables -in the database and adds multisite constants to the wp-config.php. - -### OPTIONS - -[\--url=<url>] -: The address of the new site. - -[\--base=<url-path>] -: Base path after the domain name that each site url in the network will start with. -\--- -default: / -\--- - -[\--subdomains] -: If passed, the network will use subdomains, instead of subdirectories. Doesn't work with 'localhost'. - -\--title=<site-title> -: The title of the new site. - -\--admin_user=<username> -: The name of the admin user. -\--- -default: admin -\--- - -[\--admin_password=<password>] -: The password for the admin user. Defaults to randomly generated string. - -\--admin_email=<email> -: The email address for the admin user. - -[\--skip-email] -: Don't send an email notification to the new admin user. - -### EXAMPLES - - $ wp core multisite-install --title="Welcome to the WordPress" \ - > --admin_user="admin" --admin_password="password" \ - > --admin_email="user@example.com" - Single site database tables already present. - Set up multisite database tables. - Added multisite constants to wp-config.php. - Success: Network installed. Don't forget to set up rewrite rules. - - - diff --git a/commands/core/update-db/index.md b/commands/core/update-db/index.md deleted file mode 100644 index 03ad4f71..00000000 --- a/commands/core/update-db/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: 'wp core update-db' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » update-db - -`wp core update-db` - Run the WordPress database update procedure. - -Quick links: Github issues - -
- -[\--network] -: Update databases for all sites on a network - -[\--dry-run] -: Compare database versions without performing the update. - -### EXAMPLES - - # Update the WordPress database - $ wp core update-db - Success: WordPress database upgraded successfully from db version 36686 to 35700. - - # Update databases for all sites on a network - $ wp core update-db --network - WordPress database upgraded successfully from db version 35700 to 29630 on example.com/ - Success: WordPress database upgraded on 123/123 sites - - - diff --git a/commands/core/update/index.md b/commands/core/update/index.md deleted file mode 100644 index 32cae750..00000000 --- a/commands/core/update/index.md +++ /dev/null @@ -1,69 +0,0 @@ ---- -layout: default -title: 'wp core update' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » update - -`wp core update` - Update WordPress to a newer version. - -Quick links: Github issues - -
- -Defaults to updating WordPress to the latest version. - -If you see "Error: Another update is currently in progress.", you may -need to run `wp option delete core_updater.lock` after verifying another -update isn't actually running. - -### OPTIONS - -[<zip>] -: Path to zip file to use, instead of downloading from wordpress.org. - -[\--minor] -: Only perform updates for minor releases (e.g. update from WP 4.3 to 4.3.3 instead of 4.4.2). - -[\--version=<version>] -: Update to a specific version, instead of to the latest version. Alternatively accepts 'nightly'. - -[\--force] -: Update even when installed WP version is greater than the requested version. - -[\--locale=<locale>] -: Select which language you want to download. - -### EXAMPLES - - # Update WordPress - $ wp core update - Updating to version 4.5.2 (en_US)... - Downloading update from https://downloads.wordpress.org/release/wordpress-4.5.2-no-content.zip... - Unpacking the update... - Cleaning up files... - No files found that need cleaned up - Success: WordPress updated successfully. - - # Update WordPress to latest version of 3.8 release - $ wp core update --version=3.8 ../latest.zip - Updating to version 3.8 ()... - Unpacking the update... - Cleaning up files... - File removed: wp-admin/js/tags-box.js - ... - File removed: wp-admin/js/updates.min. - 377 files cleaned up - Success: WordPress updated successfully. - - # Update WordPress to 3.1 forcefully - $ wp core update --version=3.1 --force - Updating to version 3.1 (en_US)... - Downloading update from https://wordpress.org/wordpress-3.1.zip... - Unpacking the update... - Warning: Failed to fetch checksums. Please cleanup files manually. - Success: WordPress updated successfully. - - - diff --git a/commands/core/verify-checksums/index.md b/commands/core/verify-checksums/index.md deleted file mode 100644 index f75575ed..00000000 --- a/commands/core/verify-checksums/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default -title: 'wp core verify-checksums' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » verify-checksums - -`wp core verify-checksums` - Verify WordPress files against WordPress.org's checksums. - -Quick links: Github issues - -
- -Downloads md5 checksums for the current version from WordPress.org, and -compares those checksums against the currently installed files. - -For security, avoids loading WordPress when verifying checksums. - -### OPTIONS - -[\--version=<version>] -: Verify checksums against a specific version of WordPress. - -[\--locale=<locale>] -: Verify checksums against a specific locale of WordPress. - -### EXAMPLES - - # Verify checksums - $ wp core verify-checksums - Success: WordPress install verifies against checksums. - - # Verify checksums for given WordPress version - $ wp core verify-checksums --version=4.0 - Success: WordPress install verifies against checksums. - - # Verify checksums for given locale - $ wp core verify-checksums --locale=en_US - Success: WordPress install verifies against checksums. - - # Verify checksums for given locale - $ wp core verify-checksums --locale=ja - Warning: File doesn't verify against checksum: wp-includes/version.php - Warning: File doesn't verify against checksum: readme.html - Warning: File doesn't verify against checksum: wp-config-sample.php - Error: WordPress install doesn't verify against checksums. - - - diff --git a/commands/core/version/index.md b/commands/core/version/index.md deleted file mode 100644 index 06020740..00000000 --- a/commands/core/version/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: 'wp core version' -display_global_parameters: true ---- - -[Commands](/commands/) » [core](/commands/core/) » version - -`wp core version` - Display the WordPress version. - -Quick links: Github issues - -
- -### OPTIONS - -[\--extra] -: Show extended version information. - -### EXAMPLES - - # Display the WordPress version - $ wp core version - 4.5.2 - - # Display WordPress version along with other information - $ wp core version --extra - WordPress version: 4.5.2 - Database revision: 36686 - TinyMCE version: 4.310 (4310-20160418) - Package language: en_US - - - diff --git a/commands/cron/event/delete/index.md b/commands/cron/event/delete/index.md deleted file mode 100644 index b50b17d7..00000000 --- a/commands/cron/event/delete/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp cron event delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » [event](/commands/cron/event/) » delete - -`wp cron event delete` - Delete the next scheduled cron event for the given hook. - -Quick links: Github issues - -
- -### OPTIONS - -<hook> -: The hook name. - -### EXAMPLES - - # Delete the next scheduled cron event - $ wp cron event delete cron_test - Success: Deleted 2 instances of the cron event 'cron_test'. - - - diff --git a/commands/cron/event/index.md b/commands/cron/event/index.md deleted file mode 100644 index 84722089..00000000 --- a/commands/cron/event/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -layout: default -title: 'wp cron event' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » event - -`wp cron event` - Manage WP-Cron events. - -Quick links: Github issues - -
- -### EXAMPLES - - # Schedule a new cron event - $ wp cron event schedule cron_test - Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:19:16 GMT. - - # Run all cron events due right now - $ wp cron event run --due-now - Success: Executed a total of 2 cron events. - - # Delete the next scheduled cron event - $ wp cron event delete cron_test - Success: Deleted 2 instances of the cron event 'cron_test'. - - # List scheduled cron events in JSON - $ wp cron event list --fields=hook,next_run --format=json - [{"hook":"wp_version_check","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_plugins","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_themes","next_run":"2016-05-31 10:15:14"}] - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
deleteDelete the next scheduled cron event for the given hook.
listList scheduled cron events.
runRun the next scheduled cron event for the given hook.
scheduleSchedule a new cron event.
diff --git a/commands/cron/event/list/index.md b/commands/cron/event/list/index.md deleted file mode 100644 index aa4c7670..00000000 --- a/commands/cron/event/list/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: default -title: 'wp cron event list' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » [event](/commands/cron/event/) » list - -`wp cron event list` - List scheduled cron events. - -Quick links: Github issues - -
- -### OPTIONS - -[\--fields=<fields>] -: Limit the output to specific object fields. - -[\--<field>=<value>] -: Filter by one or more fields. - -[\--field=<field>] -: Prints the value of a single field for each event. - -[\--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 cron event: -* hook -* next_run_gmt -* next_run_relative -* recurrence - -These fields are optionally available: -* time -* sig -* args -* schedule -* interval -* next_run - -### EXAMPLES - - # List scheduled cron events - $ wp cron event list - +-------------------+---------------------+---------------------+------------+ - | hook | next_run_gmt | next_run_relative | recurrence | - +-------------------+---------------------+---------------------+------------+ - | wp_version_check | 2016-05-31 22:15:13 | 11 hours 57 minutes | 12 hours | - | wp_update_plugins | 2016-05-31 22:15:13 | 11 hours 57 minutes | 12 hours | - | wp_update_themes | 2016-05-31 22:15:14 | 11 hours 57 minutes | 12 hours | - +-------------------+---------------------+---------------------+------------+ - - # List scheduled cron events in JSON - $ wp cron event list --fields=hook,next_run --format=json - [{"hook":"wp_version_check","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_plugins","next_run":"2016-05-31 10:15:13"},{"hook":"wp_update_themes","next_run":"2016-05-31 10:15:14"}] - - - diff --git a/commands/cron/event/run/index.md b/commands/cron/event/run/index.md deleted file mode 100644 index db612ee7..00000000 --- a/commands/cron/event/run/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: 'wp cron event run' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » [event](/commands/cron/event/) » run - -`wp cron event run` - Run the next scheduled cron event for the given hook. - -Quick links: Github issues - -
- -### OPTIONS - -[<hook>...] -: One or more hooks to run. - -[\--due-now] -: Run all hooks due right now. - -[\--all] -: Run all hooks. - -### EXAMPLES - - # Run all cron events due right now - $ wp cron event run --due-now - Success: Executed a total of 2 cron events. - - - diff --git a/commands/cron/event/schedule/index.md b/commands/cron/event/schedule/index.md deleted file mode 100644 index 040f4e8a..00000000 --- a/commands/cron/event/schedule/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: 'wp cron event schedule' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » [event](/commands/cron/event/) » schedule - -`wp cron event schedule` - Schedule a new cron event. - -Quick links: Github issues - -
- -### OPTIONS - -<hook> -: The hook name. - -[<next-run>] -: A Unix timestamp or an English textual datetime description compatible with `strtotime()`. Defaults to now. - -[<recurrence>] -: How often the event should recur. See `wp cron schedule list` for available schedule names. Defaults to no recurrence. - -[\--<field>=<value>] -: Associative args for the event. - -### EXAMPLES - - # Schedule a new cron event - $ wp cron event schedule cron_test - Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:19:16 GMT. - - # Schedule new cron event with hourly recurrence - $ wp cron event schedule cron_test now hourly - Success: Scheduled event with hook 'cron_test' for 2016-05-31 10:20:32 GMT. - - # Schedule new cron event and pass associative arguments - $ wp cron event schedule cron_test '+1 hour' --foo=1 --bar=2 - Success: Scheduled event with hook 'cron_test' for 2016-05-31 11:21:35 GMT. - - - diff --git a/commands/cron/index.md b/commands/cron/index.md deleted file mode 100644 index db7db4f5..00000000 --- a/commands/cron/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: 'wp cron' -display_global_parameters: true ---- - -[Commands](/commands/) » cron - -`wp cron` - Manage WP-Cron events and schedules. - -Quick links: Github issues - -
- -### EXAMPLES - - # Test WP Cron spawning system - $ wp cron test - Success: WP-Cron spawning is working as expected. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
eventManage WP-Cron events.
scheduleManage WP-Cron schedules.
testTest the WP Cron spawning system and report back its status.
diff --git a/commands/cron/schedule/index.md b/commands/cron/schedule/index.md deleted file mode 100644 index 0b1cf0dd..00000000 --- a/commands/cron/schedule/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: 'wp cron schedule' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » schedule - -`wp cron schedule` - Manage WP-Cron schedules. - -Quick links: Github issues - -
- -### EXAMPLES - - # List available cron schedules - $ wp cron schedule list - +------------+-------------+----------+ - | name | display | interval | - +------------+-------------+----------+ - | hourly | Once Hourly | 3600 | - | twicedaily | Twice Daily | 43200 | - | daily | Once Daily | 86400 | - +------------+-------------+----------+ - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - -
NameDescription
listList available cron schedules.
diff --git a/commands/cron/schedule/list/index.md b/commands/cron/schedule/list/index.md deleted file mode 100644 index aa555fa9..00000000 --- a/commands/cron/schedule/list/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: 'wp cron schedule list' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » [schedule](/commands/cron/schedule/) » list - -`wp cron schedule list` - List available cron schedules. - -Quick links: Github issues - -
- -### OPTIONS - -[\--fields=<fields>] -: Limit the output to specific object fields. - -[\--field=<field>] -: Prints the value of a single field for each schedule. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - ids - - json - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each cron schedule: - -* name -* display -* interval - -There are no additional fields. - -### EXAMPLES - - # List available cron schedules - $ wp cron schedule list - +------------+-------------+----------+ - | name | display | interval | - +------------+-------------+----------+ - | hourly | Once Hourly | 3600 | - | twicedaily | Twice Daily | 43200 | - | daily | Once Daily | 86400 | - +------------+-------------+----------+ - - # List id of available cron schedule - $ wp cron schedule list --fields=name --format=ids - hourly twicedaily daily - - - diff --git a/commands/cron/test/index.md b/commands/cron/test/index.md deleted file mode 100644 index cf9a552e..00000000 --- a/commands/cron/test/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp cron test' -display_global_parameters: true ---- - -[Commands](/commands/) » [cron](/commands/cron/) » test - -`wp cron test` - Test the WP Cron spawning system and report back its status. - -Quick links: Github issues - -
- -This command tests the spawning system by performing the following steps: - -* Checks to see if the `DISABLE_WP_CRON` constant is set; errors if true -because WP-Cron is disabled. -* Checks to see if the `ALTERNATE_WP_CRON` constant is set; warns if true. -* Attempts to spawn WP-Cron over HTTP; warns if non 200 response code is -returned. - -### EXAMPLES - - # Cron test runs successfully. - $ wp cron test - Success: WP-Cron spawning is working as expected. - - - diff --git a/commands/db/check/index.md b/commands/db/check/index.md deleted file mode 100644 index d8d320b8..00000000 --- a/commands/db/check/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp db check' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » check - -`wp db check` - Check the current status of the database. - -Quick links: Github issues - -
- -Runs `mysqlcheck` utility with `--check` using `DB_HOST`, -`DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials -specified in wp-config.php. - -[See docs](http://dev.mysql.com/doc/refman/5.7/en/check-table.html) -for more details on the `CHECK TABLE` statement. - -### EXAMPLES - - $ wp db check - Success: Database checked. - - - diff --git a/commands/db/cli/index.md b/commands/db/cli/index.md deleted file mode 100644 index d9d0e69b..00000000 --- a/commands/db/cli/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: 'wp db cli' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » cli - -`wp db cli` - Open a MySQL console using credentials from wp-config.php - -Quick links: Github issues - -
- -### OPTIONS - -[\--database=<database>] -: Use a specific database. Defaults to DB_NAME. - -[\--default-character-set=<character-set>] -: Use a specific character set. Defaults to DB_CHARSET when defined. - -[\--<field>=<value>] -: Extra arguments to pass to the MySQL executable. - -### EXAMPLES - - # Open MySQL console - $ wp db cli - mysql> - - - diff --git a/commands/db/create/index.md b/commands/db/create/index.md deleted file mode 100644 index 7c389423..00000000 --- a/commands/db/create/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: 'wp db create' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » create - -`wp db create` - Create a new database. - -Quick links: Github issues - -
- -Runs `CREATE_DATABASE` SQL statement using `DB_HOST`, `DB_NAME`, -`DB_USER` and `DB_PASSWORD` database credentials specified in -wp-config.php. - -### EXAMPLES - - $ wp db create - Success: Database created. - - - diff --git a/commands/db/drop/index.md b/commands/db/drop/index.md deleted file mode 100644 index 26027c2f..00000000 --- a/commands/db/drop/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp db drop' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » drop - -`wp db drop` - Delete the existing database. - -Quick links: Github issues - -
- -Runs `DROP_DATABASE` SQL statement using `DB_HOST`, `DB_NAME`, -`DB_USER` and `DB_PASSWORD` database credentials specified in -wp-config.php. - -### OPTIONS - -[\--yes] -: Answer yes to the confirmation message. - -### EXAMPLES - - $ wp db drop --yes - Success: Database dropped. - - - diff --git a/commands/db/export/index.md b/commands/db/export/index.md deleted file mode 100644 index 5badecc5..00000000 --- a/commands/db/export/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: 'wp db export' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » export - -`wp db export` - Exports the database to a file or to STDOUT. - -Quick links: Github issues - -
- -Runs `mysqldump` utility using `DB_HOST`, `DB_NAME`, `DB_USER` and -`DB_PASSWORD` database credentials specified in wp-config.php. - -### OPTIONS - -[<file>] -: The name of the SQL file to export. If '-', then outputs to STDOUT. If omitted, it will be '{dbname}.sql'. - -[\--<field>=<value>] -: Extra arguments to pass to mysqldump - -[\--tables=<tables>] -: The comma separated list of specific tables to export. Excluding this parameter will export all tables in the database. - -[\--porcelain] -: Output filename for the exported database. - -### EXAMPLES - - # Export database with drop query included - $ wp db export --add-drop-table - Success: Exported to 'wordpress_dbase.sql'. - - # Export certain tables - $ wp db export --tables=wp_options,wp_users - Success: Exported to 'wordpress_dbase.sql'. - - # Export all tables matching a wildcard - $ wp db export --tables=$(wp db tables 'wp_user*' --format=csv) - Success: Exported to 'wordpress_dbase.sql'. - - # Export all tables matching prefix - $ wp db export --tables=$(wp db tables --all-tables-with-prefix --format=csv) - Success: Exported to 'wordpress_dbase.sql'. - - - diff --git a/commands/db/import/index.md b/commands/db/import/index.md deleted file mode 100644 index b73b741d..00000000 --- a/commands/db/import/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default -title: 'wp db import' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » import - -`wp db import` - Import a database from a file or from STDIN. - -Quick links: Github issues - -
- -Runs SQL queries using `DB_HOST`, `DB_NAME`, `DB_USER` and -`DB_PASSWORD` database credentials specified in wp-config.php. This -does not create database by itself and only performs whatever tasks are -defined in the SQL. - -### OPTIONS - -[<file>] -: The name of the SQL file to import. If '-', then reads from STDIN. If omitted, it will look for '{dbname}.sql'. - -### EXAMPLES - - # Import MySQL from a file. - $ wp db import wordpress_dbase.sql - Success: Imported from 'wordpress_dbase.sql'. - - - diff --git a/commands/db/index.md b/commands/db/index.md deleted file mode 100644 index bad105ff..00000000 --- a/commands/db/index.md +++ /dev/null @@ -1,89 +0,0 @@ ---- -layout: default -title: 'wp db' -display_global_parameters: true ---- - -[Commands](/commands/) » db - -`wp db` - Perform basic database operations using credentials stored in wp-config.php - -Quick links: Github issues - -
- -### EXAMPLES - - # Create a new database. - $ wp db create - Success: Database created. - - # Drop an existing database. - $ wp db drop --yes - Success: Database dropped. - - # Reset the current database. - $ wp db reset --yes - Success: Database reset. - - # Execute a SQL query stored in a file. - $ wp db query < debug.sql - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
checkCheck the current status of the database.
cliOpen a MySQL console using credentials from wp-config.php
createCreate a new database.
dropDelete the existing database.
exportExports the database to a file or to STDOUT.
importImport a database from a file or from STDIN.
optimizeOptimize the database.
queryExecute a SQL query against the database.
repairRepair the database.
resetRemove all tables from the database.
tablesList the database tables.
diff --git a/commands/db/optimize/index.md b/commands/db/optimize/index.md deleted file mode 100644 index 3dd82952..00000000 --- a/commands/db/optimize/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp db optimize' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » optimize - -`wp db optimize` - Optimize the database. - -Quick links: Github issues - -
- -Runs `mysqlcheck` utility with `--optimize=true` using `DB_HOST`, -`DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials -specified in wp-config.php. - -[See docs](http://dev.mysql.com/doc/refman/5.7/en/optimize-table.html) -for more details on the `OPTIMIZE TABLE` statement. - -### EXAMPLES - - $ wp db optimize - Success: Database optimized. - - - diff --git a/commands/db/query/index.md b/commands/db/query/index.md deleted file mode 100644 index 0c07dea5..00000000 --- a/commands/db/query/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: default -title: 'wp db query' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » query - -`wp db query` - Execute a SQL query against the database. - -Quick links: Github issues - -
- -Executes an arbitrary SQL query using `DB_HOST`, `DB_NAME`, `DB_USER` - and `DB_PASSWORD` database credentials specified in wp-config.php. - -### OPTIONS - -[<sql>] -: A SQL query. If not passed, will try to read from STDIN. - -[\--<field>=<value>] -: Extra arguments to pass to mysql. - -### EXAMPLES - - # Execute a query stored in a file - $ wp db query < debug.sql - - # Check all tables in the database - $ wp db query "CHECK TABLE $(wp db tables | paste -s -d',');" - +---------------------------------------+-------+----------+----------+ - | Table | Op | Msg_type | Msg_text | - +---------------------------------------+-------+----------+----------+ - | wordpress_dbase.wp_users | check | status | OK | - | wordpress_dbase.wp_usermeta | check | status | OK | - | wordpress_dbase.wp_posts | check | status | OK | - | wordpress_dbase.wp_comments | check | status | OK | - | wordpress_dbase.wp_links | check | status | OK | - | wordpress_dbase.wp_options | check | status | OK | - | wordpress_dbase.wp_postmeta | check | status | OK | - | wordpress_dbase.wp_terms | check | status | OK | - | wordpress_dbase.wp_term_taxonomy | check | status | OK | - | wordpress_dbase.wp_term_relationships | check | status | OK | - | wordpress_dbase.wp_termmeta | check | status | OK | - | wordpress_dbase.wp_commentmeta | check | status | OK | - +---------------------------------------+-------+----------+----------+ - - # Pass extra arguments through to MySQL - $ wp db query 'SELECT * FROM wp_options WHERE option_name="home"' --skip-column-names - +---+------+------------------------------+-----+ - | 2 | home | http://wordpress-develop.dev | yes | - +---+------+------------------------------+-----+ - - - diff --git a/commands/db/repair/index.md b/commands/db/repair/index.md deleted file mode 100644 index ddc86677..00000000 --- a/commands/db/repair/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp db repair' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » repair - -`wp db repair` - Repair the database. - -Quick links: Github issues - -
- -Runs `mysqlcheck` utility with `--repair=true` using `DB_HOST`, -`DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials -specified in wp-config.php. - -[See docs](http://dev.mysql.com/doc/refman/5.7/en/repair-table.html) for -more details on the `REPAIR TABLE` statement. - -### EXAMPLES - - $ wp db repair - Success: Database repaired. - - - diff --git a/commands/db/reset/index.md b/commands/db/reset/index.md deleted file mode 100644 index 7c4d2399..00000000 --- a/commands/db/reset/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp db reset' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » reset - -`wp db reset` - Remove all tables from the database. - -Quick links: Github issues - -
- -Runs `DROP_DATABASE` and `CREATE_DATABASE` SQL statements using -`DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials -specified in wp-config.php. - -### OPTIONS - -[\--yes] -: Answer yes to the confirmation message. - -### EXAMPLES - - $ wp db reset --yes - Success: Database reset. - - - diff --git a/commands/db/tables/index.md b/commands/db/tables/index.md deleted file mode 100644 index a41bbd0c..00000000 --- a/commands/db/tables/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: 'wp db tables' -display_global_parameters: true ---- - -[Commands](/commands/) » [db](/commands/db/) » tables - -`wp db tables` - List the database tables. - -Quick links: Github issues - -
- -Defaults to all tables registered to the $wpdb database handler. - -### OPTIONS - -[<table>...] -: List tables based on wildcard search, e.g. 'wp_*_options' or 'wp_post?'. - -[\--scope=<scope>] -: Can be all, global, ms_global, blog, or old tables. Defaults to all. - -[\--network] -: List all the tables in a multisite install. Overrides --scope=<scope>. - -[\--all-tables-with-prefix] -: List all tables that match the table prefix even if not registered on $wpdb. Overrides --network. - -[\--all-tables] -: List all tables in the database, regardless of the prefix, and even if not registered on $wpdb. Overrides --all-tables-with-prefix. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: list -options: - - list - - csv -\--- - -### EXAMPLES - - # List tables for a single site, without shared tables like 'wp_users' - $ wp db tables --scope=blog --url=sub.example.com - wp_3_posts - wp_3_comments - wp_3_options - wp_3_postmeta - wp_3_terms - wp_3_term_taxonomy - wp_3_term_relationships - wp_3_termmeta - wp_3_commentmeta - - # Export only tables for a single site - $ wp db export --tables=$(wp db tables --url=sub.example.com --format=csv) - Success: Exported to wordpress_dbase.sql - - - diff --git a/commands/eval-file/index.md b/commands/eval-file/index.md deleted file mode 100644 index dcd65a3e..00000000 --- a/commands/eval-file/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp eval-file' -display_global_parameters: true ---- - -[Commands](/commands/) » eval-file - -`wp eval-file` - Load and execute a PHP file. - -Quick links: Github issues - -
- -### OPTIONS - -<file> -: The path to the PHP file to execute. - -[<arg>...] -: One or more arguments to pass to the file. They are placed in the $args variable. - -[\--skip-wordpress] -: Load and execute file without loading WordPress. - - - diff --git a/commands/eval/index.md b/commands/eval/index.md deleted file mode 100644 index 7511ec0e..00000000 --- a/commands/eval/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: 'wp eval' -display_global_parameters: true ---- - -[Commands](/commands/) » eval - -`wp eval` - Execute arbitrary PHP code. - -Quick links: Github issues - -
- -### OPTIONS - -<php-code> -: The code to execute, as a string. - -[\--skip-wordpress] -: Execute code without loading WordPress. - -### EXAMPLES - - # Display WordPress content directory. - $ wp eval 'echo WP_CONTENT_DIR;' - /var/www/wordpress/wp-content - - # Generate a random number. - $ wp eval 'echo rand();' --skip-wordpress - 479620423 - - - diff --git a/commands/export/index.md b/commands/export/index.md deleted file mode 100644 index 74ad5aa4..00000000 --- a/commands/export/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: default -title: 'wp export' -display_global_parameters: true ---- - -[Commands](/commands/) » export - -`wp export` - Export WordPress content to a WXR file. - -Quick links: Github issues - -
- -Generates one or more WXR files containing authors, terms, posts, -comments, and attachments. WXR files do not include site configuration -(options) or the attachment files themselves. - -### OPTIONS - -[\--dir=<dirname>] -: Full path to directory where WXR export files should be stored. Defaults -to current working directory. - -[\--skip_comments] -: Don't include comments in the WXR export file. - -[\--max_file_size=<MB>] -: A single export file should have this many megabytes. -\--- -default: 15 -\--- - -### FILTERS - -[\--start_date=<date>] -: Export only posts published after this date, in format YYYY-MM-DD. - -[\--end_date=<date>] -: Export only posts published before this date, in format YYYY-MM-DD. - -[\--post_type=<post-type>] -: Export only posts with this post_type. Separate multiple post types with a -comma. -\--- -default: any -\--- - -[\--post_type__not_in=<post-type>] -: Export all post types except those identified. Separate multiple post types -with a comma. Defaults to none. - -[\--post__in=<pid>] -: Export all posts specified as a comma- or space-separated list of IDs. - -[\--start_id=<pid>] -: Export only posts with IDs greater than or equal to this post ID. - -[\--author=<author>] -: Export only posts by this author. Can be either user login or user ID. - -[\--category=<name>] -: Export only posts in this category. - -[\--post_status=<status>] -: Export only posts with this status. - -[\--filename_format=<format>] -: Use a custom format for export filenames. Defaults to '{site}.wordpress.{date}.{n}.xml'. - -### EXAMPLES - - # Export posts published by the user between given start and end date - $ wp export --dir=/tmp/ --user=admin --post_type=post --start_date=2011-01-01 --end_date=2011-12-31 - Starting export process... - Writing to file /tmp/staging.wordpress.2016-05-24.000.xml - Success: All done with export. - - # Export posts by IDs - $ wp export --dir=/tmp/ --post__in=123,124,125 - Starting export process... - Writing to file /tmp/staging.wordpress.2016-05-24.000.xml - Success: All done with export. - - # Export a random subset of content - $ wp export --post__in="$(wp post list --post_type=post --orderby=rand --posts_per_page=8 --format=ids)" - Starting export process... - Writing to file /var/www/example.com/public_html/staging.wordpress.2016-05-24.000.xml - Success: All done with export. - - - diff --git a/commands/help/index.md b/commands/help/index.md deleted file mode 100644 index 67655a6a..00000000 --- a/commands/help/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp help' -display_global_parameters: true ---- - -[Commands](/commands/) » help - -`wp help` - Get help on WP-CLI, or on a specific command. - -Quick links: Github issues - -
- -### OPTIONS - -[<command>...] -: Get help on a specific command. - -### EXAMPLES - - # get help for `core` command - wp help core - - # get help for `core download` subcommand - wp help core download - - - diff --git a/commands/import/index.md b/commands/import/index.md deleted file mode 100644 index 89e90a47..00000000 --- a/commands/import/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: 'wp import' -display_global_parameters: true ---- - -[Commands](/commands/) » import - -`wp import` - Import content from a WXR file. - -Quick links: Github issues - -
- -Provides a command line interface to the WordPress Importer plugin, for -performing data migrations. - -### OPTIONS - -<file>... -: Path to one or more valid WXR files for importing. Directories are also accepted. - -\--authors=<authors> -: How the author mapping should be handled. Options are 'create', 'mapping.csv', or 'skip'. The first will create any non-existent users from the WXR file. The second will read author mapping associations from a CSV, or create a CSV for editing if the file path doesn't exist. The CSV requires two columns, and a header row like "old_user_login,new_user_login". The last option will skip any author mapping. - -[\--skip=<data-type>] -: Skip importing specific data. Supported options are: 'attachment' and 'image_resize' (skip time-consuming thumbnail generation). - -### EXAMPLES - - # Import content from a WXR file - $ wp import example.wordpress.2016-06-21.xml --authors=create - Starting the import process... - Processing post #1 ("Hello world!") (post_type: post) - -- 1 of 1 - -- Tue, 21 Jun 2016 05:31:12 +0000 - -- Imported post as post_id #1 - Success: Finished importing from 'example.wordpress.2016-06-21.xml' file. - - - diff --git a/commands/media/import/index.md b/commands/media/import/index.md deleted file mode 100644 index b430928e..00000000 --- a/commands/media/import/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -layout: default -title: 'wp media import' -display_global_parameters: true ---- - -[Commands](/commands/) » [media](/commands/media/) » import - -`wp media import` - Create attachments from local files or URLs. - -Quick links: Github issues - -
- -### OPTIONS - -<file>... -: Path to file or files to be imported. Supports the glob(3) capabilities of the current shell. - If file is recognized as a URL (for example, with a scheme of http or ftp), the file will be - downloaded to a temp file before being sideloaded. - -[\--post_id=<post_id>] -: ID of the post to attach the imported files to. - -[\--title=<title>] -: Attachment title (post title field). - -[\--caption=<caption>] -: Caption for attachent (post excerpt field). - -[\--alt=<alt_text>] -: Alt text for image (saved as post meta). - -[\--desc=<description>] -: "Description" field (post content) of attachment post. - -[\--featured_image] -: If set, set the imported image as the Featured Image of the post its attached to. - -[\--porcelain] -: Output just the new attachment ID. - -### EXAMPLES - - # Import all jpgs in the current user's "Pictures" directory, not attached to any post. - $ wp media import ~/Pictures/**\/*.jpg - Imported file '/home/person/Pictures/beautiful-youg-girl-in-ivy.jpg' as attachment ID 1751. - Imported file '/home/person/Pictures/fashion-girl.jpg' as attachment ID 1752. - Success: Imported 2 of 2 images. - - # Import a local image and set it to be the post thumbnail for a post. - $ wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture" --featured_image - Imported file '/home/person/Downloads/image.png' as attachment ID 1753 and attached to post 123 as featured image. - Success: Imported 1 of 1 images. - - # Import a local image, but set it as the featured image for all posts. - # 1. Import the image and get its attachment ID. - # 2. Assign the attachment ID as the featured image for all posts. - $ ATTACHMENT_ID="$(wp media import ~/Downloads/image.png --porcelain)" - $ wp post list --post_type=post --format=ids | xargs -d ' ' -I % wp post meta add % _thumbnail_id $ATTACHMENT_ID - Success: Added custom field. - Success: Added custom field. - - # Import an image from the web. - $ wp media import http://s.wordpress.org/style/images/wp-header-logo.png --title='The WordPress logo' --alt="Semantic personal publishing" - Imported file 'http://s.wordpress.org/style/images/wp-header-logo.png' as attachment ID 1755. - Success: Imported 1 of 1 images. - - - diff --git a/commands/media/index.md b/commands/media/index.md deleted file mode 100644 index 5add73fb..00000000 --- a/commands/media/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default -title: 'wp media' -display_global_parameters: true ---- - -[Commands](/commands/) » media - -`wp media` - Manage attachments. - -Quick links: Github issues - -
- -### EXAMPLES - - # Re-generate all thumbnails, without confirmation. - $ wp media regenerate --yes - Found 3 images to regenerate. - 1/3 Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760). - 2/3 Regenerated thumbnails for "Boardwalk" (ID 757). - 3/3 Regenerated thumbnails for "Sunburst Over River" (ID 756). - Success: Regenerated 3 of 3 images. - - # Import a local image and set it to be the featured image for a post. - $ wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture" --featured_image - Success: Imported file '/home/person/Downloads/image.png' as attachment ID 1753 and attached to post 123 as featured image. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - -
NameDescription
importCreate attachments from local files or URLs.
regenerateRegenerate thumbnails for one or more attachments.
diff --git a/commands/media/regenerate/index.md b/commands/media/regenerate/index.md deleted file mode 100644 index a443d695..00000000 --- a/commands/media/regenerate/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: default -title: 'wp media regenerate' -display_global_parameters: true ---- - -[Commands](/commands/) » [media](/commands/media/) » regenerate - -`wp media regenerate` - Regenerate thumbnails for one or more attachments. - -Quick links: Github issues - -
- -### OPTIONS - -[<attachment-id>...] -: One or more IDs of the attachments to regenerate. - -[\--skip-delete] -: Skip deletion of the original thumbnails. If your thumbnails are linked from sources outside your control, it's likely best to leave them around. Defaults to false. - -[\--only-missing] -: Only generate thumbnails for images missing image sizes. - -[\--yes] -: Answer yes to the confirmation message. Confirmation only shows when no IDs passed as arguments. - -### EXAMPLES - - # Regenerate thumbnails for given attachment IDs. - $ wp media regenerate 123 124 125 - Found 3 images to regenerate. - 1/3 Regenerated thumbnails for "Vertical Image" (ID 123). - 2/3 Regenerated thumbnails for "Horizontal Image" (ID 124). - 3/3 Regenerated thumbnails for "Beautiful Picture" (ID 125). - Success: Regenerated 3 of 3 images. - - # Regenerate all thumbnails, without confirmation. - $ wp media regenerate --yes - Found 3 images to regenerate. - 1/3 Regenerated thumbnails for "Sydney Harbor Bridge" (ID 760). - 2/3 Regenerated thumbnails for "Boardwalk" (ID 757). - 3/3 Regenerated thumbnails for "Sunburst Over River" (ID 756). - Success: Regenerated 3 of 3 images. - - # Re-generate all thumbnails that have IDs between 1000 and 2000. - $ seq 1000 2000 | xargs wp media regenerate - Found 4 images to regenerate. - 1/4 Regenerated thumbnails for "Vertical Featured Image" (ID 1027). - 2/4 Regenerated thumbnails for "Horizontal Featured Image" (ID 1022). - 3/4 Regenerated thumbnails for "Unicorn Wallpaper" (ID 1045). - 4/4 Regenerated thumbnails for "I Am Worth Loving Wallpaper" (ID 1023). - Success: Regenerated 4 of 4 images. - - - diff --git a/commands/menu/create/index.md b/commands/menu/create/index.md deleted file mode 100644 index e969d684..00000000 --- a/commands/menu/create/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp menu create' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » create - -`wp menu create` - Create a new menu. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/menu/delete/index.md b/commands/menu/delete/index.md deleted file mode 100644 index 8b000231..00000000 --- a/commands/menu/delete/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp menu delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » delete - -`wp menu delete` - Delete one or more menus. - -Quick links: Github issues - -
- -### OPTIONS - -<menu>... -: The name, slug, or term ID for the menu(s). - -### EXAMPLES - - $ wp menu delete "My Menu" - Success: 1 menu deleted. - - - diff --git a/commands/menu/index.md b/commands/menu/index.md deleted file mode 100644 index 822644ee..00000000 --- a/commands/menu/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: 'wp menu' -display_global_parameters: true ---- - -[Commands](/commands/) » menu - -`wp menu` - List, create, assign, and delete menus. - -Quick links: Github issues - -
- -### EXAMPLES - - # Create a new menu - $ wp menu create "My Menu" - Success: Created menu 200. - - # List existing menus - $ wp menu list - +---------+----------+----------+-----------+-------+ - | term_id | name | slug | locations | count | - +---------+----------+----------+-----------+-------+ - | 200 | My Menu | my-menu | | 0 | - | 177 | Top Menu | top-menu | primary | 7 | - +---------+----------+----------+-----------+-------+ - - # 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 to menu. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
createCreate a new menu.
deleteDelete one or more menus.
itemList, add, and delete items associated with a menu.
listGet a list of menus.
locationManage a menu's assignment to locations.
diff --git a/commands/menu/item/add-custom/index.md b/commands/menu/item/add-custom/index.md deleted file mode 100644 index e0024f90..00000000 --- a/commands/menu/item/add-custom/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: default -title: 'wp menu item add-custom' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [item](/commands/menu/item/) » add-custom - -`wp menu item add-custom` - Add a custom menu item. - -Quick links: Github issues - -
- -### OPTIONS - -<menu> -: The name, slug, or term ID for the menu. - -<title> -: Title for the link. - -<link> -: Target URL 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. - - - diff --git a/commands/menu/item/add-post/index.md b/commands/menu/item/add-post/index.md deleted file mode 100644 index b29908f5..00000000 --- a/commands/menu/item/add-post/index.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: default -title: 'wp menu item add-post' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [item](/commands/menu/item/) » add-post - -`wp menu item add-post` - Add a post as a menu item. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/menu/item/add-term/index.md b/commands/menu/item/add-term/index.md deleted file mode 100644 index 8c307ee8..00000000 --- a/commands/menu/item/add-term/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: 'wp menu item add-term' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [item](/commands/menu/item/) » add-term - -`wp menu item add-term` - Add a taxonomy term as a menu item. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/menu/item/delete/index.md b/commands/menu/item/delete/index.md deleted file mode 100644 index 7b0e1048..00000000 --- a/commands/menu/item/delete/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp menu item delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [item](/commands/menu/item/) » delete - -`wp menu item delete` - Delete one or more items from a menu. - -Quick links: Github issues - -
- -### OPTIONS - -<db-id>... -: Database ID for the menu item(s). - -### EXAMPLES - - $ wp menu item delete 45 - Success: 1 menu item deleted. - - - diff --git a/commands/menu/item/index.md b/commands/menu/item/index.md deleted file mode 100644 index f34caffe..00000000 --- a/commands/menu/item/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: default -title: 'wp menu item' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » item - -`wp menu item` - List, add, and delete items associated with a menu. - -Quick links: Github issues - -
- -### 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: 1 menu item deleted. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
add-customAdd a custom menu item.
add-postAdd a post as a menu item.
add-termAdd a taxonomy term as a menu item.
deleteDelete one or more items from a menu.
listGet a list of items associated with a menu.
updateUpdate a menu item.
diff --git a/commands/menu/item/list/index.md b/commands/menu/item/list/index.md deleted file mode 100644 index d39ec53c..00000000 --- a/commands/menu/item/list/index.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -layout: default -title: 'wp menu item list' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [item](/commands/menu/item/) » list - -`wp menu item list` - Get a list of items associated with a menu. - -Quick links: Github issues - -
- -### 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 list main-menu - +-------+-----------+-------------+---------------------------------+----------+ - | db_id | type | title | link | position | - +-------+-----------+-------------+---------------------------------+----------+ - | 5 | custom | Home | http://example.com | 1 | - | 6 | post_type | Sample Page | http://example.com/sample-page/ | 2 | - +-------+-----------+-------------+---------------------------------+----------+ - - - diff --git a/commands/menu/item/update/index.md b/commands/menu/item/update/index.md deleted file mode 100644 index 3972cee0..00000000 --- a/commands/menu/item/update/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default -title: 'wp menu item update' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [item](/commands/menu/item/) » update - -`wp menu item update` - Update a menu item. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/menu/list/index.md b/commands/menu/list/index.md deleted file mode 100644 index 75dd1c28..00000000 --- a/commands/menu/list/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -layout: default -title: 'wp menu list' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » list - -`wp menu list` - Get a list of menus. - -Quick links: Github issues - -
- -### 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 list - +---------+----------+----------+-----------+-------+ - | term_id | name | slug | locations | count | - +---------+----------+----------+-----------+-------+ - | 200 | My Menu | my-menu | | 0 | - | 177 | Top Menu | top-menu | primary | 7 | - +---------+----------+----------+-----------+-------+ - - - diff --git a/commands/menu/location/assign/index.md b/commands/menu/location/assign/index.md deleted file mode 100644 index 68000690..00000000 --- a/commands/menu/location/assign/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp menu location assign' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [location](/commands/menu/location/) » assign - -`wp menu location assign` - Assign a location to a menu. - -Quick links: Github issues - -
- -### 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 to menu. - - - diff --git a/commands/menu/location/index.md b/commands/menu/location/index.md deleted file mode 100644 index c261b752..00000000 --- a/commands/menu/location/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -layout: default -title: 'wp menu location' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » location - -`wp menu location` - Manage a menu's assignment to locations. - -Quick links: Github issues - -
- -### EXAMPLES - - # List available menu locations - $ wp menu location list - +----------+-------------------+ - | location | description | - +----------+-------------------+ - | primary | Primary Menu | - | social | Social Links Menu | - +----------+-------------------+ - - # Assign the 'primary-menu' menu to the 'primary' location - $ wp menu location assign primary-menu primary - Success: Assigned location to menu. - - # Remove the 'primary-menu' menu from the 'primary' location - $ wp menu location remove primary-menu primary - Success: Removed location from menu. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
assignAssign a location to a menu.
listList locations for the current theme.
removeRemove a location from a menu.
diff --git a/commands/menu/location/list/index.md b/commands/menu/location/list/index.md deleted file mode 100644 index ffe112c3..00000000 --- a/commands/menu/location/list/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: default -title: 'wp menu location list' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [location](/commands/menu/location/) » list - -`wp menu location list` - List locations for the current theme. - -Quick links: Github issues - -
- -### 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 list - +----------+-------------------+ - | location | description | - +----------+-------------------+ - | primary | Primary Menu | - | social | Social Links Menu | - +----------+-------------------+ - - - diff --git a/commands/menu/location/remove/index.md b/commands/menu/location/remove/index.md deleted file mode 100644 index 3f547937..00000000 --- a/commands/menu/location/remove/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp menu location remove' -display_global_parameters: true ---- - -[Commands](/commands/) » [menu](/commands/menu/) » [location](/commands/menu/location/) » remove - -`wp menu location remove` - Remove a location from a menu. - -Quick links: Github issues - -
- -### 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. - - - diff --git a/commands/network/index.md b/commands/network/index.md deleted file mode 100644 index 13a77cdc..00000000 --- a/commands/network/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: 'wp network' -display_global_parameters: true ---- - -[Commands](/commands/) » network - -`wp network` - - -Quick links: Github issues - -
- - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - -
NameDescription
metaManage network custom fields.
diff --git a/commands/network/meta/add/index.md b/commands/network/meta/add/index.md deleted file mode 100644 index 5f2c2aa0..00000000 --- a/commands/network/meta/add/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp network meta add' -display_global_parameters: true ---- - -[Commands](/commands/) » [network](/commands/network/) » [meta](/commands/network/meta/) » add - -`wp network meta add` - Add a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/network/meta/delete/index.md b/commands/network/meta/delete/index.md deleted file mode 100644 index 5c17e072..00000000 --- a/commands/network/meta/delete/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp network meta delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [network](/commands/network/) » [meta](/commands/network/meta/) » delete - -`wp network meta delete` - Delete a meta field. - -Quick links: Github issues - -
- -<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. - - - diff --git a/commands/network/meta/get/index.md b/commands/network/meta/get/index.md deleted file mode 100644 index 253a5c02..00000000 --- a/commands/network/meta/get/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: 'wp network meta get' -display_global_parameters: true ---- - -[Commands](/commands/) » [network](/commands/network/) » [meta](/commands/network/meta/) » get - -`wp network meta get` - Get meta field value. - -Quick links: Github issues - -
- -<id> -: The ID of the object. - -<key> -: The name of the meta field to get. - -[\--format=<format>] -: Accepted values: table, json. Default: table - - - diff --git a/commands/network/meta/index.md b/commands/network/meta/index.md deleted file mode 100644 index 1f455b7b..00000000 --- a/commands/network/meta/index.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default -title: 'wp network meta' -display_global_parameters: true ---- - -[Commands](/commands/) » [network](/commands/network/) » meta - -`wp network meta` - Manage network custom fields. - -Quick links: Github issues - -
- -### EXAMPLES - - # Get a list of super-admins - $ wp network meta get 1 site_admins - array ( - 0 => 'supervisor', - ) - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a meta field.
deleteDelete a meta field.
getGet meta field value.
listList all metadata associated with an object.
updateUpdate a meta field.
diff --git a/commands/network/meta/list/index.md b/commands/network/meta/list/index.md deleted file mode 100644 index 58a3c681..00000000 --- a/commands/network/meta/list/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp network meta list' -display_global_parameters: true ---- - -[Commands](/commands/) » [network](/commands/network/) » [meta](/commands/network/meta/) » list - -`wp network meta list` - List all metadata associated with an object. - -Quick links: Github issues - -
- -<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>] -: Accepted values: table, csv, json, count. Default: table - - - diff --git a/commands/network/meta/update/index.md b/commands/network/meta/update/index.md deleted file mode 100644 index 51178f56..00000000 --- a/commands/network/meta/update/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp network meta update' -display_global_parameters: true ---- - -[Commands](/commands/) » [network](/commands/network/) » [meta](/commands/network/meta/) » update - -`wp network meta update` - Update a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/option/add/index.md b/commands/option/add/index.md deleted file mode 100644 index 788141dd..00000000 --- a/commands/option/add/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: 'wp option add' -display_global_parameters: true ---- - -[Commands](/commands/) » [option](/commands/option/) » add - -`wp option add` - Add a new option value. - -Quick links: Github issues - -
- -Errors if the option already exists. - -### OPTIONS - -<key> -: The name of the option to add. - -[<value>] -: The value of the option to add. If ommited, 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: - - '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. - - - diff --git a/commands/option/delete/index.md b/commands/option/delete/index.md deleted file mode 100644 index 818503d7..00000000 --- a/commands/option/delete/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp option delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [option](/commands/option/) » delete - -`wp option delete` - Delete an option. - -Quick links: Github issues - -
- -### OPTIONS - -<key> -: Key for the option. - -### EXAMPLES - - # Delete an option. - $ wp option delete my_option - Success: Deleted 'my_option' option. - - - diff --git a/commands/option/get/index.md b/commands/option/get/index.md deleted file mode 100644 index ba068fd5..00000000 --- a/commands/option/get/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: 'wp option get' -display_global_parameters: true ---- - -[Commands](/commands/) » [option](/commands/option/) » get - -`wp option get` - Get the value for an option. - -Quick links: Github issues - -
- -### 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 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"} - - - diff --git a/commands/option/index.md b/commands/option/index.md deleted file mode 100644 index de99888f..00000000 --- a/commands/option/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: default -title: 'wp option' -display_global_parameters: true ---- - -[Commands](/commands/) » option - -`wp option` - Manage options. - -Quick links: Github issues - -
- -### 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. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a new option value.
deleteDelete an option.
getGet the value for an option.
listList options and their values.
updateUpdate an option value.
diff --git a/commands/option/list/index.md b/commands/option/list/index.md deleted file mode 100644 index 80720569..00000000 --- a/commands/option/list/index.md +++ /dev/null @@ -1,90 +0,0 @@ ---- -layout: default -title: 'wp option list' -display_global_parameters: true ---- - -[Commands](/commands/) » [option](/commands/option/) » list - -`wp option list` - List options and their values. - -Quick links: Github issues - -
- -### 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. - -[\--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 -\--- - -### 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 begining with "i2f_". - $ wp option list --search="i2f_*" - +-------------+--------------+ - | option_name | option_value | - +-------------+--------------+ - | i2f_version | 0.1.0 | - +-------------+--------------+ - - # Delete all options begining 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. - - - diff --git a/commands/option/update/index.md b/commands/option/update/index.md deleted file mode 100644 index 14eeac24..00000000 --- a/commands/option/update/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: default -title: 'wp option update' -display_global_parameters: true ---- - -[Commands](/commands/) » [option](/commands/option/) » update - -`wp option update` - Update an option value. - -Quick links: Github issues - -
- -### OPTIONS - -<key> -: The name of the option to update. - -[<value>] -: The new value. If ommited, the value is read from STDIN. - -[\--autoload=<autoload>] -: Requires WP 4.2. Should this option be automatically loaded. -\--- -options: - - '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. - - - diff --git a/commands/package/browse/index.md b/commands/package/browse/index.md deleted file mode 100644 index 7a5b41c3..00000000 --- a/commands/package/browse/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: default -title: 'wp package browse' -display_global_parameters: true ---- - -[Commands](/commands/) » [package](/commands/package/) » browse - -`wp package browse` - Browse WP-CLI packages available for installation. - -Quick links: Github issues - -
- -Lists packages available for installation from the [Package Index](http://wp-cli.org/package-index/). - -### OPTIONS - -[\--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 - - ids - - json - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each package: - -* name -* description -* authors -* version - -There are no optionally available fields. - -### EXAMPLES - - $ wp package browse --format=yaml - --- - 10up/mu-migration: - name: 10up/mu-migration - description: A set of WP-CLI commands to support the migration of single WordPress instances to multisite - authors: Nícholas André - version: dev-master, dev-develop - aaemnnosttv/wp-cli-dotenv-command: - name: aaemnnosttv/wp-cli-dotenv-command - description: Dotenv commands for WP-CLI - authors: Evan Mattson - version: v0.1, v0.1-beta.1, v0.2, dev-master, dev-dev, dev-develop, dev-tests/behat - aaemnnosttv/wp-cli-http-command: - name: aaemnnosttv/wp-cli-http-command - description: WP-CLI command for using the WordPress HTTP API - authors: Evan Mattson - version: dev-master - - - diff --git a/commands/package/index.md b/commands/package/index.md deleted file mode 100644 index 2b3515a5..00000000 --- a/commands/package/index.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -layout: default -title: 'wp package' -display_global_parameters: true ---- - -[Commands](/commands/) » package - -`wp package` - Manage WP-CLI packages. - -Quick links: Github issues - -
- -WP-CLI packages are community-maintained projects built on WP-CLI. They can -contain WP-CLI commands, but they can also just extend WP-CLI in some way. - -Installable packages are listed in the -[Package Index](http://wp-cli.org/package-index/). - -Learn how to create your own command from the -[Commands Cookbook](http://wp-cli.org/docs/commands-cookbook/) - -### EXAMPLES - - # List installed packages - $ wp package list - +-----------------------+------------------------------------------+---------+------------+ - | name | description | authors | version | - +-----------------------+------------------------------------------+---------+------------+ - | wp-cli/server-command | Start a development server for WordPress | | dev-master | - +-----------------------+------------------------------------------+---------+------------+ - - # Install the latest development version of the package - $ wp package install wp-cli/server-command - Installing package wp-cli/server-command (dev-master) - Updating /home/person/.wp-cli/packages/composer.json to require the package... - Using Composer to install the package... - --- - Loading composer repositories with package information - Updating dependencies - Resolving dependencies through SAT - Dependency resolution completed in 0.005 seconds - Analyzed 732 packages to resolve dependencies - Analyzed 1034 rules to resolve dependencies - - Installing package - Writing lock file - Generating autoload files - --- - Success: Package installed. - - # Uninstall package - $ wp package uninstall wp-cli/server-command - Removing require statement from /home/person/.wp-cli/packages/composer.json - Deleting package directory /home/person/.wp-cli/packages/vendor/wp-cli/server-command - Regenerating Composer autoload. - Success: Uninstalled package. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
browseBrowse WP-CLI packages available for installation.
installInstall a WP-CLI package.
listList installed WP-CLI packages.
pathGet the path to an installed WP-CLI package, or the package directory.
uninstallUninstall a WP-CLI package.
updateUpdate all installed WP-CLI packages to their latest version.
diff --git a/commands/package/install/index.md b/commands/package/install/index.md deleted file mode 100644 index c0a141e7..00000000 --- a/commands/package/install/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -layout: default -title: 'wp package install' -display_global_parameters: true ---- - -[Commands](/commands/) » [package](/commands/package/) » install - -`wp package install` - Install a WP-CLI package. - -Quick links: Github issues - -
- -Packages are required to be a valid Composer package, and can be -specified as: - -* Package name from WP-CLI's package index. -* Git URL accessible by the current shell user. -* Path to a directory on the local machine. -* Local or remote .zip file. - -When installing a local directory, WP-CLI simply registers a -reference to the directory. If you move or delete the directory, WP-CLI's -reference breaks. - -When installing a .zip file, WP-CLI extracts the package to -`~/.wp-cli/packages/local/<package-name>`. - -### OPTIONS - -<name|git|path|zip> -: Name, git URL, directory path, or .zip file for the package to install. -Names can optionally include a version constraint -(e.g. wp-cli/server-command:@stable). - -### EXAMPLES - - # Install the latest development version from the package index. - $ wp package install wp-cli/server-command - Installing package wp-cli/server-command (dev-master) - Updating /home/person/.wp-cli/packages/composer.json to require the package... - Using Composer to install the package... - --- - Loading composer repositories with package information - Updating dependencies - Resolving dependencies through SAT - Dependency resolution completed in 0.005 seconds - Analyzed 732 packages to resolve dependencies - Analyzed 1034 rules to resolve dependencies - - Installing package - Writing lock file - Generating autoload files - --- - Success: Package installed. - - # Install the latest stable version. - $ wp package install wp-cli/server-command:@stable - - # Install a package hosted at a git URL. - $ wp package install git@github.com:runcommand/hook.git - - # Install a package in a .zip file. - $ wp package install google-sitemap-generator-cli.zip - - - diff --git a/commands/package/list/index.md b/commands/package/list/index.md deleted file mode 100644 index 439e6d34..00000000 --- a/commands/package/list/index.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: default -title: 'wp package list' -display_global_parameters: true ---- - -[Commands](/commands/) » [package](/commands/package/) » list - -`wp package list` - List installed WP-CLI packages. - -Quick links: Github issues - -
- -### OPTIONS - -[\--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 - - ids - - json - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each package: - -* name -* authors -* version -* update -* update_version - -These fields are optionally available: - -* description - -### EXAMPLES - - $ wp package list - +-----------------------+------------------------------------------+---------+------------+ - | name | description | authors | version | - +-----------------------+------------------------------------------+---------+------------+ - | wp-cli/server-command | Start a development server for WordPress | | dev-master | - +-----------------------+------------------------------------------+---------+------------+ - - - diff --git a/commands/package/path/index.md b/commands/package/path/index.md deleted file mode 100644 index 3de7cd68..00000000 --- a/commands/package/path/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: 'wp package path' -display_global_parameters: true ---- - -[Commands](/commands/) » [package](/commands/package/) » path - -`wp package path` - Get the path to an installed WP-CLI package, or the package directory. - -Quick links: Github issues - -
- -If you want to contribute to a package, this is a great way to jump to it. - -### OPTIONS - -[<name>] -: Name of the package to get the directory for. - -### EXAMPLES - - # Get package path - $ wp package path - /home/person/.wp-cli/packages/ - - # Change directory to package path - $ cd $(wp package path) && pwd - /home/vagrant/.wp-cli/packages - - - diff --git a/commands/package/uninstall/index.md b/commands/package/uninstall/index.md deleted file mode 100644 index 1ee0ce50..00000000 --- a/commands/package/uninstall/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp package uninstall' -display_global_parameters: true ---- - -[Commands](/commands/) » [package](/commands/package/) » uninstall - -`wp package uninstall` - Uninstall a WP-CLI package. - -Quick links: Github issues - -
- -### OPTIONS - -<name> -: Name of the package to uninstall. - -### EXAMPLES - - $ wp package uninstall wp-cli/server-command - Removing require statement from /home/person/.wp-cli/packages/composer.json - Deleting package directory /home/person/.wp-cli/packages/vendor/wp-cli/server-command - Regenerating Composer autoload. - Success: Uninstalled package. - - - diff --git a/commands/package/update/index.md b/commands/package/update/index.md deleted file mode 100644 index f4e4545f..00000000 --- a/commands/package/update/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: default -title: 'wp package update' -display_global_parameters: true ---- - -[Commands](/commands/) » [package](/commands/package/) » update - -`wp package update` - Update all installed WP-CLI packages to their latest version. - -Quick links: Github issues - -
- -### EXAMPLES - - $ wp package update - Using Composer to update packages... - --- - Loading composer repositories with package information - Updating dependencies - Resolving dependencies through SAT - Dependency resolution completed in 0.074 seconds - Analyzed 1062 packages to resolve dependencies - Analyzed 22383 rules to resolve dependencies - Writing lock file - Generating autoload files - --- - Success: Packages updated. - - - diff --git a/commands/plugin/activate/index.md b/commands/plugin/activate/index.md deleted file mode 100644 index 0d3e77ae..00000000 --- a/commands/plugin/activate/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: 'wp plugin activate' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » activate - -`wp plugin activate` - Activate a plugin. - -Quick links: Github issues - -
- -### OPTIONS - -[<plugin>...] -: One or more plugins to activate. - -[\--all] -: If set, all plugins will be activated. - -[\--network] -: If set, the plugin will be activated for the entire multisite network. - -### EXAMPLES - - # Activate plugin - $ wp plugin activate hello - Plugin 'hello' activated. - Success: Activated 1 of 1 plugins. - - # Activate plugin in entire multisite network - $ wp plugin activate hello --network - Plugin 'hello' network activated. - Success: Network activated 1 of 1 plugins. - - - diff --git a/commands/plugin/deactivate/index.md b/commands/plugin/deactivate/index.md deleted file mode 100644 index c5f45189..00000000 --- a/commands/plugin/deactivate/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default -title: 'wp plugin deactivate' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » deactivate - -`wp plugin deactivate` - Deactivate a plugin. - -Quick links: Github issues - -
- -### OPTIONS - -[<plugin>...] -: One or more plugins to deactivate. - -[\--uninstall] -: Uninstall the plugin after deactivation. - -[\--all] -: If set, all plugins will be deactivated. - -[\--network] -: If set, the plugin will be deactivated for the entire multisite network. - -### EXAMPLES - - # Deactivate plugin - $ wp plugin deactivate hello - Plugin 'hello' deactivated. - Success: Deactivated 1 of 1 plugins. - - - diff --git a/commands/plugin/delete/index.md b/commands/plugin/delete/index.md deleted file mode 100644 index 988e04da..00000000 --- a/commands/plugin/delete/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: 'wp plugin delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » delete - -`wp plugin delete` - Delete plugin files without deactivating or uninstalling. - -Quick links: Github issues - -
- -### OPTIONS - -<plugin>... -: One or more plugins to delete. - -### EXAMPLES - - # Delete plugin - $ wp plugin delete hello - Deleted 'hello' plugin. - Success: Deleted 1 of 1 plugins. - - # Delete inactive plugins - $ wp plugin delete $(wp plugin list --status=inactive --field=name) - Deleted 'tinymce-templates' plugin. - Success: Deleted 1 of 1 plugins. - - - diff --git a/commands/plugin/get/index.md b/commands/plugin/get/index.md deleted file mode 100644 index 68c9ec65..00000000 --- a/commands/plugin/get/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp plugin get' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » get - -`wp plugin get` - Get details about an installed plugin. - -Quick links: Github issues - -
- -### OPTIONS - -<plugin> -: The plugin to get. - -[\--field=<field>] -: Instead of returning the whole plugin, 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 - - $ wp plugin get bbpress --format=json - {"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"} - - - diff --git a/commands/plugin/index.md b/commands/plugin/index.md deleted file mode 100644 index eccd4882..00000000 --- a/commands/plugin/index.md +++ /dev/null @@ -1,109 +0,0 @@ ---- -layout: default -title: 'wp plugin' -display_global_parameters: true ---- - -[Commands](/commands/) » plugin - -`wp plugin` - Manage plugins. - -Quick links: Github issues - -
- -### EXAMPLES - - # Activate plugin - $ wp plugin activate hello - Plugin 'hello' activated. - Success: Activated 1 of 1 plugins. - - # Deactivate plugin - $ wp plugin deactivate hello - Plugin 'hello' deactivated. - Success: Deactivated 1 of 1 plugins. - - # Delete plugin - $ wp plugin delete hello - Deleted 'hello' plugin. - Success: Deleted 1 of 1 plugins. - - # Install the latest version from wordpress.org and activate - $ wp plugin install bbpress --activate - Installing bbPress (2.5.9) - Downloading install package from https://downloads.wordpress.org/plugin/bbpress.2.5.9.zip... - Using cached file '/home/vagrant/.wp-cli/cache/plugin/bbpress-2.5.9.zip'... - Unpacking the package... - Installing the plugin... - Plugin installed successfully. - Activating 'bbpress'... - Plugin 'bbpress' activated. - Success: Installed 1 of 1 plugins. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
activateActivate a plugin.
deactivateDeactivate a plugin.
deleteDelete plugin files without deactivating or uninstalling.
getGet details about an installed plugin.
installInstall a plugin.
is-installedCheck if the plugin is installed.
listGet a list of plugins.
pathGet the path to a plugin or to the plugin directory.
searchSearch the WordPress.org plugin directory.
statusSee the status of one or all plugins.
toggleToggle a plugin's activation state.
uninstallUninstall a plugin.
updateUpdate one or more plugins.
diff --git a/commands/plugin/install/index.md b/commands/plugin/install/index.md deleted file mode 100644 index 0289351c..00000000 --- a/commands/plugin/install/index.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -layout: default -title: 'wp plugin install' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » install - -`wp plugin install` - Install a plugin. - -Quick links: Github issues - -
- -### OPTIONS - -<plugin|zip|url>... -: A plugin slug, the path to a local zip file, or URL to a remote zip file. - -[\--version=<version>] -: If set, get that particular version from wordpress.org, instead of the -stable version. - -[\--force] -: If set, the command will overwrite any installed version of the plugin, without prompting -for confirmation. - -[\--activate] -: If set, the plugin will be activated immediately after install. - -[\--activate-network] -: If set, the plugin will be network activated immediately after install - -### EXAMPLES - - # Install the latest version from wordpress.org and activate - $ wp plugin install bbpress --activate - Installing bbPress (2.5.9) - Downloading install package from https://downloads.wordpress.org/plugin/bbpress.2.5.9.zip... - Using cached file '/home/vagrant/.wp-cli/cache/plugin/bbpress-2.5.9.zip'... - Unpacking the package... - Installing the plugin... - Plugin installed successfully. - Activating 'bbpress'... - Plugin 'bbpress' activated. - Success: Installed 1 of 1 plugins. - - # Install the development version from wordpress.org - $ wp plugin install bbpress --version=dev - Installing bbPress (Development Version) - Downloading install package from https://downloads.wordpress.org/plugin/bbpress.zip... - Unpacking the package... - Installing the plugin... - Plugin installed successfully. - Success: Installed 1 of 1 plugins. - - # Install from a local zip file - $ wp plugin install ../my-plugin.zip - Unpacking the package... - Installing the plugin... - Plugin installed successfully. - Success: Installed 1 of 1 plugins. - - # Install from a remote zip file - $ wp plugin install http://s3.amazonaws.com/bucketname/my-plugin.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef - Downloading install package from http://s3.amazonaws.com/bucketname/my-plugin.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef - Unpacking the package... - Installing the plugin... - Plugin installed successfully. - Success: Installed 1 of 1 plugins. - - # Update from a remote zip file - $ wp plugin install https://github.com/envato/wp-envato-market/archive/master.zip --force - Downloading install package from https://github.com/envato/wp-envato-market/archive/master.zip - Unpacking the package... - Installing the plugin... - Renamed Github-based project from 'wp-envato-market-master' to 'wp-envato-market'. - Plugin updated successfully - Success: Installed 1 of 1 plugins. - - # Forcefully re-install all installed plugins - $ wp plugin install $(wp plugin list --field=name) --force - Installing Akismet (3.1.11) - Downloading install package from https://downloads.wordpress.org/plugin/akismet.3.1.11.zip... - Unpacking the package... - Installing the plugin... - Removing the old version of the plugin... - Plugin updated successfully - Success: Installed 1 of 1 plugins. - - - diff --git a/commands/plugin/is-installed/index.md b/commands/plugin/is-installed/index.md deleted file mode 100644 index 54080aed..00000000 --- a/commands/plugin/is-installed/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp plugin is-installed' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » is-installed - -`wp plugin is-installed` - Check if the plugin is installed. - -Quick links: Github issues - -
- -Returns exit code 0 when installed, 1 when uninstalled. - -### OPTIONS - -<plugin> -: The plugin to check. - -### EXAMPLES - - # Check whether plugin is installed; exit status 0 if installed, otherwise 1 - $ wp plugin is-installed hello - $ echo $? - 1 - - - diff --git a/commands/plugin/list/index.md b/commands/plugin/list/index.md deleted file mode 100644 index 7c871891..00000000 --- a/commands/plugin/list/index.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -layout: default -title: 'wp plugin list' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » list - -`wp plugin list` - Get a list of plugins. - -Quick links: Github issues - -
- -### OPTIONS - -[\--<field>=<value>] -: Filter results based on the value of a field. - -[\--field=<field>] -: Prints the value of a single field for each plugin. - -[\--fields=<fields>] -: Limit the output to specific object fields. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - count - - json - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each plugin: - -* name -* status -* update -* version - -These fields are optionally available: - -* update_version -* update_package -* update_id -* title -* description - -### EXAMPLES - - # List active plugins on the site. - $ wp plugin list --status=active --format=json - [{"name":"dynamic-hostname","status":"active","update":"none","version":"0.4.2"},{"name":"tinymce-templates","status":"active","update":"none","version":"4.4.3"},{"name":"wp-multibyte-patch","status":"active","update":"none","version":"2.4"},{"name":"wp-total-hacks","status":"active","update":"none","version":"2.0.1"}] - - # List plugins on each site in a network. - $ wp site list --field=url | xargs -I % wp plugin list --url=% - +---------+----------------+--------+---------+ - | name | status | update | version | - +---------+----------------+--------+---------+ - | akismet | active-network | none | 3.1.11 | - | hello | inactive | none | 1.6 | - +---------+----------------+--------+---------+ - +---------+----------------+--------+---------+ - | name | status | update | version | - +---------+----------------+--------+---------+ - | akismet | active-network | none | 3.1.11 | - | hello | inactive | none | 1.6 | - +---------+----------------+--------+---------+ - - - diff --git a/commands/plugin/path/index.md b/commands/plugin/path/index.md deleted file mode 100644 index 7e450b8d..00000000 --- a/commands/plugin/path/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: 'wp plugin path' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » path - -`wp plugin path` - Get the path to a plugin or to the plugin directory. - -Quick links: Github issues - -
- -### OPTIONS - -[<plugin>] -: The plugin to get the path to. If not set, will return the path to the -plugins directory. - -[\--dir] -: If set, get the path to the closest parent directory, instead of the -plugin file. - -### EXAMPLES - - $ cd $(wp plugin path) && pwd - /var/www/wordpress/wp-content/plugins - - - diff --git a/commands/plugin/search/index.md b/commands/plugin/search/index.md deleted file mode 100644 index 5ec28ead..00000000 --- a/commands/plugin/search/index.md +++ /dev/null @@ -1,85 +0,0 @@ ---- -layout: default -title: 'wp plugin search' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » search - -`wp plugin search` - Search the WordPress.org plugin directory. - -Quick links: Github issues - -
- -Displays plugins in the WordPress.org plugin directory matching a given -search query. - -### OPTIONS - -<search> -: The string to search for. - -[\--page=<page>] -: Optional page to display. -\--- -default: 1 -\--- - -[\--per-page=<per-page>] -: Optional number of results to display. -\--- -default: 10 -\--- - -[\--field=<field>] -: Prints the value of a single field for each plugin. - -[\--fields=<fields>] -: Ask for specific fields from the API. Defaults to name,slug,author_profile,rating. Acceptable values: - - **name**: Plugin Name - **slug**: Plugin Slug - **version**: Current Version Number - **author**: Plugin Author - **author_profile**: Plugin Author Profile - **contributors**: Plugin Contributors - **requires**: Plugin Minimum Requirements - **tested**: Plugin Tested Up To - **compatibility**: Plugin Compatible With - **rating**: Plugin Rating - **num_ratings**: Number of Plugin Ratings - **homepage**: Plugin Author's Homepage - **description**: Plugin's Description - **short_description**: Plugin's Short Description - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - count - - json - - yaml -\--- - -### EXAMPLES - - $ wp plugin search dsgnwrks --per-page=20 --format=json - Success: Showing 3 of 3 plugins. - [{"name":"DsgnWrks Instagram Importer Debug","slug":"dsgnwrks-instagram-importer-debug","rating":0},{"name":"DsgnWrks Instagram Importer","slug":"dsgnwrks-instagram-importer","rating":84},{"name":"DsgnWrks Twitter Importer","slug":"dsgnwrks-twitter-importer","rating":80}] - - $ wp plugin search dsgnwrks --fields=name,version,slug,rating,num_ratings - Success: Showing 3 of 3 plugins. - +-----------------------------------+---------+-----------------------------------+--------+-------------+ - | name | version | slug | rating | num_ratings | - +-----------------------------------+---------+-----------------------------------+--------+-------------+ - | DsgnWrks Instagram Importer Debug | 0.1.6 | dsgnwrks-instagram-importer-debug | 0 | 0 | - | DsgnWrks Instagram Importer | 1.3.7 | dsgnwrks-instagram-importer | 84 | 23 | - | DsgnWrks Twitter Importer | 1.1.1 | dsgnwrks-twitter-importer | 80 | 1 | - +-----------------------------------+---------+-----------------------------------+--------+-------------+ - - - diff --git a/commands/plugin/status/index.md b/commands/plugin/status/index.md deleted file mode 100644 index b362844e..00000000 --- a/commands/plugin/status/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -layout: default -title: 'wp plugin status' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » status - -`wp plugin status` - See the status of one or all plugins. - -Quick links: Github issues - -
- -### OPTIONS - -[<plugin>] -: A particular plugin to show the status for. - -### EXAMPLES - - # Displays status of all plugins - $ wp plugin status - 5 installed plugins: - I akismet 3.1.11 - I easy-digital-downloads 2.5.16 - A theme-check 20160523.1 - I wen-logo-slider 2.0.3 - M ns-pack 1.0.0 - Legend: I = Inactive, A = Active, M = Must Use - - # Displays status of a plugin - $ wp plugin status theme-check - Plugin theme-check details: - Name: Theme Check - Status: Active - Version: 20160523.1 - Author: Otto42, pross - Description: A simple and easy way to test your theme for all the latest WordPress standards and practices. A great theme development tool! - - - diff --git a/commands/plugin/toggle/index.md b/commands/plugin/toggle/index.md deleted file mode 100644 index 720eda9d..00000000 --- a/commands/plugin/toggle/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: 'wp plugin toggle' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » toggle - -`wp plugin toggle` - Toggle a plugin's activation state. - -Quick links: Github issues - -
- -If the plugin is active, then it will be deactivated. If the plugin is -inactive, then it will be activated. - -### OPTIONS - -<plugin>... -: One or more plugins to toggle. - -[\--network] -: If set, the plugin will be toggled for the entire multisite network. - -### EXAMPLES - - # Akismet is currently activated - $ wp plugin toggle akismet - Plugin 'akismet' deactivated. - Success: Toggled 1 of 1 plugins. - - # Akismet is currently deactivated - $ wp plugin toggle akismet - Plugin 'akismet' activated. - Success: Toggled 1 of 1 plugins. - - - diff --git a/commands/plugin/uninstall/index.md b/commands/plugin/uninstall/index.md deleted file mode 100644 index c990c02a..00000000 --- a/commands/plugin/uninstall/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: 'wp plugin uninstall' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » uninstall - -`wp plugin uninstall` - Uninstall a plugin. - -Quick links: Github issues - -
- -### OPTIONS - -<plugin>... -: One or more plugins to uninstall. - -[\--deactivate] -: Deactivate the plugin before uninstalling. Default behavior is to warn and skip if the plugin is active. - -[\--skip-delete] -: If set, the plugin files will not be deleted. Only the uninstall procedure -will be run. - -### EXAMPLES - - $ wp plugin uninstall hello - Uninstalled and deleted 'hello' plugin. - Success: Installed 1 of 1 plugins. - - - diff --git a/commands/plugin/update-all/index.md b/commands/plugin/update-all/index.md deleted file mode 100644 index 49c6f8a4..00000000 --- a/commands/plugin/update-all/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: default -title: 'wp plugin update-all' ---- - -`wp plugin update-all` is an alias for [wp plugin update --all](/commands/plugin/update/). diff --git a/commands/plugin/update/index.md b/commands/plugin/update/index.md deleted file mode 100644 index bba5c96a..00000000 --- a/commands/plugin/update/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: default -title: 'wp plugin update' -display_global_parameters: true ---- - -[Commands](/commands/) » [plugin](/commands/plugin/) » update - -`wp plugin update` - Update one or more plugins. - -Quick links: Github issues - -
- -### OPTIONS - -[<plugin>...] -: One or more plugins to update. - -[\--all] -: If set, all plugins that have updates will be updated. - -[\--format=<format>] -: Output summary as table or summary. Defaults to table. - -[\--version=<version>] -: If set, the plugin will be updated to the specified version. - -[\--dry-run] -: Preview which plugins would be updated. - -### EXAMPLES - - $ wp plugin update bbpress --version=dev - Installing bbPress (Development Version) - Downloading install package from https://downloads.wordpress.org/plugin/bbpress.zip... - Unpacking the package... - Installing the plugin... - Removing the old version of the plugin... - Plugin updated successfully. - Success: Updated 1 of 2 plugins. - - $ wp plugin update --all - Enabling Maintenance mode... - Downloading update from https://downloads.wordpress.org/plugin/akismet.3.1.11.zip... - Unpacking the update... - Installing the latest version... - Removing the old version of the plugin... - Plugin updated successfully. - Downloading update from https://downloads.wordpress.org/plugin/nginx-champuru.3.2.0.zip... - Unpacking the update... - Installing the latest version... - Removing the old version of the plugin... - Plugin updated successfully. - Disabling Maintenance mode... - +------------------------+-------------+-------------+---------+ - | name | old_version | new_version | status | - +------------------------+-------------+-------------+---------+ - | akismet | 3.1.3 | 3.1.11 | Updated | - | nginx-cache-controller | 3.1.1 | 3.2.0 | Updated | - +------------------------+-------------+-------------+---------+ - Success: Updated 2 of 2 plugins. - - - diff --git a/commands/post-type/get/index.md b/commands/post-type/get/index.md deleted file mode 100644 index 19b7796e..00000000 --- a/commands/post-type/get/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: 'wp post-type get' -display_global_parameters: true ---- - -[Commands](/commands/) » [post-type](/commands/post-type/) » get - -`wp post-type get` - Get details about a registered post type. - -Quick links: Github issues - -
- -### OPTIONS - -<post-type> -: Post type slug - -[\--field=<field>] -: Instead of returning the whole taxonomy, 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 details about the 'page' post type. - $ wp post-type get page --fields=name,label,hierarchical --format=json - {"name":"page","label":"Pages","hierarchical":true} - - - diff --git a/commands/post-type/index.md b/commands/post-type/index.md deleted file mode 100644 index e1e3ce15..00000000 --- a/commands/post-type/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: default -title: 'wp post-type' -display_global_parameters: true ---- - -[Commands](/commands/) » post-type - -`wp post-type` - Manage post types. - -Quick links: Github issues - -
- -### EXAMPLES - - # Get details about a post type - $ wp post-type get page --fields=name,label,hierarchical --format=json - {"name":"page","label":"Pages","hierarchical":true} - - # List post types with 'post' capability type - $ wp post-type list --capability_type=post --fields=name,public - +---------------+--------+ - | name | public | - +---------------+--------+ - | post | 1 | - | attachment | 1 | - | revision | | - | nav_menu_item | | - +---------------+--------+ - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - -
NameDescription
getGet details about a registered post type.
listList registered post types.
diff --git a/commands/post-type/list/index.md b/commands/post-type/list/index.md deleted file mode 100644 index 9ca65487..00000000 --- a/commands/post-type/list/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -layout: default -title: 'wp post-type list' -display_global_parameters: true ---- - -[Commands](/commands/) » [post-type](/commands/post-type/) » list - -`wp post-type list` - List registered post types. - -Quick links: Github issues - -
- -### OPTIONS - -[\--<field>=<value>] -: Filter by one or more fields (see get_post_types() first parameter for a list of available fields). - -[\--field=<field>] -: Prints the value of a single field for each post type. - -[\--fields=<fields>] -: Limit the output to specific post type fields. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - count - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each term: - -* name -* label -* description -* hierarchical -* public -* capability_type - -There are no optionally available fields. - -### EXAMPLES - - # List registered post types - $ wp post-type list --format=csv - name,label,description,hierarchical,public,capability_type - post,Posts,,,1,post - page,Pages,,1,1,page - attachment,Media,,,1,post - revision,Revisions,,,,post - nav_menu_item,"Navigation Menu Items",,,,post - - # List post types with 'post' capability type - $ wp post-type list --capability_type=post --fields=name,public - +---------------+--------+ - | name | public | - +---------------+--------+ - | post | 1 | - | attachment | 1 | - | revision | | - | nav_menu_item | | - +---------------+--------+ - - - diff --git a/commands/post/create/index.md b/commands/post/create/index.md deleted file mode 100644 index 6d552548..00000000 --- a/commands/post/create/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default -title: 'wp post create' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » create - -`wp post create` - Create a new post. - -Quick links: Github issues - -
- -### OPTIONS - -[<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=page --post_title='A future post' --post_status=future --post_date='2020-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. - - - diff --git a/commands/post/delete/index.md b/commands/post/delete/index.md deleted file mode 100644 index f911cc07..00000000 --- a/commands/post/delete/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp post delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » delete - -`wp post delete` - Delete an existing post. - -Quick links: Github issues - -
- -### 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 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: Trashed post 1268. - Success: Trashed post 1294. - - - diff --git a/commands/post/edit/index.md b/commands/post/edit/index.md deleted file mode 100644 index b896367e..00000000 --- a/commands/post/edit/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp post edit' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » edit - -`wp post edit` - Launch system editor to edit post content. - -Quick links: Github issues - -
- -### OPTIONS - -<id> -: The ID of the post to edit. - -### EXAMPLES - - # Launch system editor to edit post - $ wp post edit 123 - - - diff --git a/commands/post/generate/index.md b/commands/post/generate/index.md deleted file mode 100644 index b9448be6..00000000 --- a/commands/post/generate/index.md +++ /dev/null @@ -1,84 +0,0 @@ ---- -layout: default -title: 'wp post generate' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » generate - -`wp post generate` - Generate some posts. - -Quick links: Github issues - -
- -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_author=<login>] -: The author of the generated posts. -\--- -default: -\--- - -[\--post_date=<yyyy-mm-dd>] -: The date of the generated posts. Default: current 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 http://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. - - - diff --git a/commands/post/get/index.md b/commands/post/get/index.md deleted file mode 100644 index 392c84c4..00000000 --- a/commands/post/get/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp post get' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » get - -`wp post get` - Get details about a post. - -Quick links: Github issues - -
- -### 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 - - - diff --git a/commands/post/index.md b/commands/post/index.md deleted file mode 100644 index 9a24580b..00000000 --- a/commands/post/index.md +++ /dev/null @@ -1,78 +0,0 @@ ---- -layout: default -title: 'wp post' -display_global_parameters: true ---- - -[Commands](/commands/) » post - -`wp post` - Manage posts. - -Quick links: Github issues - -
- -### 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. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
createCreate a new post.
deleteDelete an existing post.
editLaunch system editor to edit post content.
generateGenerate some posts.
getGet details about a post.
listGet a list of posts.
metaManage post custom fields.
termManage post terms.
updateUpdate one or more existing posts.
diff --git a/commands/post/list/index.md b/commands/post/list/index.md deleted file mode 100644 index 0e1c38a4..00000000 --- a/commands/post/list/index.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -layout: default -title: 'wp post list' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » list - -`wp post list` - Get a list of posts. - -Quick links: Github issues - -
- -### 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 all pages - $ wp post list --post_type=page --fields=post_title,post_status - +-------------+-------------+ - | post_title | post_status | - +-------------+-------------+ - | Sample Page | publish | - +-------------+-------------+ - - # List ids of all pages and posts - $ wp post list --post_type=page,post --format=ids - 15 25 34 37 198 - - # List given posts - $ wp post list --post__in=1,3 - +----+--------------+-------------+---------------------+-------------+ - | ID | post_title | post_name | post_date | post_status | - +----+--------------+-------------+---------------------+-------------+ - | 3 | Lorem Ipsum | lorem-ipsum | 2016-06-01 14:34:36 | publish | - | 1 | Hello world! | hello-world | 2016-06-01 14:31:12 | publish | - +----+--------------+-------------+---------------------+-------------+ - - - diff --git a/commands/post/meta/add/index.md b/commands/post/meta/add/index.md deleted file mode 100644 index fbcfd1e4..00000000 --- a/commands/post/meta/add/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp post meta add' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [meta](/commands/post/meta/) » add - -`wp post meta add` - Add a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/post/meta/delete/index.md b/commands/post/meta/delete/index.md deleted file mode 100644 index 079d58bf..00000000 --- a/commands/post/meta/delete/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp post meta delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [meta](/commands/post/meta/) » delete - -`wp post meta delete` - Delete a meta field. - -Quick links: Github issues - -
- -<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. - - - diff --git a/commands/post/meta/get/index.md b/commands/post/meta/get/index.md deleted file mode 100644 index cca1cf18..00000000 --- a/commands/post/meta/get/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: 'wp post meta get' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [meta](/commands/post/meta/) » get - -`wp post meta get` - Get meta field value. - -Quick links: Github issues - -
- -<id> -: The ID of the object. - -<key> -: The name of the meta field to get. - -[\--format=<format>] -: Accepted values: table, json. Default: table - - - diff --git a/commands/post/meta/index.md b/commands/post/meta/index.md deleted file mode 100644 index cb0ef06a..00000000 --- a/commands/post/meta/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: default -title: 'wp post meta' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » meta - -`wp post meta` - Manage post custom fields. - -Quick links: Github issues - -
- -### 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. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a meta field.
deleteDelete a meta field.
getGet meta field value.
listList all metadata associated with an object.
updateUpdate a meta field.
diff --git a/commands/post/meta/list/index.md b/commands/post/meta/list/index.md deleted file mode 100644 index e73d1295..00000000 --- a/commands/post/meta/list/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp post meta list' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [meta](/commands/post/meta/) » list - -`wp post meta list` - List all metadata associated with an object. - -Quick links: Github issues - -
- -<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>] -: Accepted values: table, csv, json, count. Default: table - - - diff --git a/commands/post/meta/update/index.md b/commands/post/meta/update/index.md deleted file mode 100644 index baafb16b..00000000 --- a/commands/post/meta/update/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp post meta update' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [meta](/commands/post/meta/) » update - -`wp post meta update` - Update a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/post/term/add/index.md b/commands/post/term/add/index.md deleted file mode 100644 index 5d6c9333..00000000 --- a/commands/post/term/add/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp post term add' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [term](/commands/post/term/) » add - -`wp post term add` - Add a term to an object. - -Quick links: Github issues - -
- -Append the term to the existing set of terms on the object. - -<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. - - - diff --git a/commands/post/term/index.md b/commands/post/term/index.md deleted file mode 100644 index 39c2c1f4..00000000 --- a/commands/post/term/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: default -title: 'wp post term' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » term - -`wp post term` - Manage post terms. - -Quick links: Github issues - -
- -### EXAMPLES - - # Set post terms - $ wp post term set 123 test category - Success: Set terms. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a term to an object.
listList all terms associated with an object.
removeRemove a term from an object.
setSet object terms.
diff --git a/commands/post/term/list/index.md b/commands/post/term/list/index.md deleted file mode 100644 index 7486ec48..00000000 --- a/commands/post/term/list/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: default -title: 'wp post term list' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [term](/commands/post/term/) » list - -`wp post term list` - List all terms associated with an object. - -Quick links: Github issues - -
- -<id> -: ID for the object. - -<taxonomy>... -: One or more taxonomies to list. - -[\--fields=<fields>] -: Limit the output to specific row fields. - -[\--format=<format>] -: Accepted values: table, csv, json, count, ids. Default: table - -### 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 - - - diff --git a/commands/post/term/remove/index.md b/commands/post/term/remove/index.md deleted file mode 100644 index e1908f3c..00000000 --- a/commands/post/term/remove/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: 'wp post term remove' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [term](/commands/post/term/) » remove - -`wp post term remove` - Remove a term from an object. - -Quick links: Github issues - -
- -<id> -: The ID of the object. - -<taxonomy> -: The name of the term's taxonomy. - -<term>... -: The name of the term or terms to be removed from the object. - - - diff --git a/commands/post/term/set/index.md b/commands/post/term/set/index.md deleted file mode 100644 index f59c66dd..00000000 --- a/commands/post/term/set/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp post term set' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » [term](/commands/post/term/) » set - -`wp post term set` - Set object terms. - -Quick links: Github issues - -
- -Replaces existing terms on the object. - -<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. - - - diff --git a/commands/post/update/index.md b/commands/post/update/index.md deleted file mode 100644 index b33488a7..00000000 --- a/commands/post/update/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: 'wp post update' -display_global_parameters: true ---- - -[Commands](/commands/) » [post](/commands/post/) » update - -`wp post update` - Update one or more existing posts. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: One or more IDs of posts to update. - -[<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> -: One or more fields to update. See wp_update_post(). - -[\--defer-term-counting] -: Recalculate term count in batch, for a performance boost. - -### EXAMPLES - - $ wp post update 123 --post_name=something --post_status=draft - Success: Updated post 123. - - - diff --git a/commands/rewrite/flush/index.md b/commands/rewrite/flush/index.md deleted file mode 100644 index d84d2479..00000000 --- a/commands/rewrite/flush/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp rewrite flush' -display_global_parameters: true ---- - -[Commands](/commands/) » [rewrite](/commands/rewrite/) » flush - -`wp rewrite flush` - Flush rewrite rules. - -Quick links: Github issues - -
- -Resets WordPress' rewrite rules based on registered post types, etc. - -To regenerate a .htaccess file with WP-CLI, you'll need to add the mod_rewrite module -to your wp-cli.yml or config.yml. For example: - -``` -apache_modules: - - mod_rewrite -``` - -### OPTIONS - -[\--hard] -: Perform a hard flush - update `.htaccess` rules as well as rewrite rules in database. Works only on single site installs. - -### EXAMPLES - - $ wp rewrite flush - Success: Rewrite rules flushed. - - - diff --git a/commands/rewrite/index.md b/commands/rewrite/index.md deleted file mode 100644 index 7d7847d4..00000000 --- a/commands/rewrite/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: 'wp rewrite' -display_global_parameters: true ---- - -[Commands](/commands/) » rewrite - -`wp rewrite` - Manage rewrite rules. - -Quick links: Github issues - -
- -### EXAMPLES - - # Flush rewrite rules - $ wp rewrite flush - Success: Rewrite rules flushed. - - # Update permalink structure - $ wp rewrite structure '/%year%/%monthnum%/%postname%' - Success: Rewrite structure set. - - # List rewrite rules - $ wp rewrite list --format=csv - match,query,source - ^wp-json/?$,index.php?rest_route=/,other - ^wp-json/(.*)?,index.php?rest_route=/$matches[1],other - category/(.+?)/feed/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category - category/(.+?)/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category - category/(.+?)/embed/?$,index.php?category_name=$matches[1]&embed=true,category - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
flushFlush rewrite rules.
listGet a list of the current rewrite rules.
structureUpdate the permalink structure.
diff --git a/commands/rewrite/list/index.md b/commands/rewrite/list/index.md deleted file mode 100644 index 3ca8daf4..00000000 --- a/commands/rewrite/list/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: 'wp rewrite list' -display_global_parameters: true ---- - -[Commands](/commands/) » [rewrite](/commands/rewrite/) » list - -`wp rewrite list` - Get a list of the current rewrite rules. - -Quick links: Github issues - -
- -### OPTIONS - -[\--match=<url>] -: Show rewrite rules matching a particular URL. - -[\--source=<source>] -: Show rewrite rules from a particular source. - -[\--fields=<fields>] -: Limit the output to specific fields. Defaults to match,query,source. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - count - - yaml -\--- - -### EXAMPLES - - $ wp rewrite list --format=csv - match,query,source - ^wp-json/?$,index.php?rest_route=/,other - ^wp-json/(.*)?,index.php?rest_route=/$matches[1],other - category/(.+?)/feed/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category - category/(.+?)/(feed|rdf|rss|rss2|atom)/?$,index.php?category_name=$matches[1]&feed=$matches[2],category - category/(.+?)/embed/?$,index.php?category_name=$matches[1]&embed=true,category - - - diff --git a/commands/rewrite/structure/index.md b/commands/rewrite/structure/index.md deleted file mode 100644 index d7a420e9..00000000 --- a/commands/rewrite/structure/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: 'wp rewrite structure' -display_global_parameters: true ---- - -[Commands](/commands/) » [rewrite](/commands/rewrite/) » structure - -`wp rewrite structure` - Update the permalink structure. - -Quick links: Github issues - -
- -Sets the post permalink structure to the specified pattern. - -To regenerate a .htaccess file with WP-CLI, you'll need to add -the mod_rewrite module to your [WP-CLI config](http://wp-cli.org/config/). -For example: - -``` -apache_modules: - - mod_rewrite -``` - -### OPTIONS - -<permastruct> -: The new permalink structure to apply. - -[\--category-base=<base>] -: Set the base for category permalinks, i.e. '/category/'. - -[\--tag-base=<base>] -: Set the base for tag permalinks, i.e. '/tag/'. - -[\--hard] -: Perform a hard flush - update `.htaccess` rules as well as rewrite rules in database. - -### EXAMPLES - - $ wp rewrite structure '/%year%/%monthnum%/%postname%' - Success: Rewrite structure set. - - - diff --git a/commands/role/create/index.md b/commands/role/create/index.md deleted file mode 100644 index f29b87ce..00000000 --- a/commands/role/create/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default -title: 'wp role create' -display_global_parameters: true ---- - -[Commands](/commands/) » [role](/commands/role/) » create - -`wp role create` - Create a new role. - -Quick links: Github issues - -
- -### OPTIONS - -<role-key> -: The internal name of the role. - -<role-name> -: The publicly visible name of the role. - -[\--clone=<role>] -: Clone capabilities from an existing role. - -### EXAMPLES - - # Create role for Approver. - $ wp role create approver Approver - Success: Role with key 'approver' created. - - # Create role for Product Administrator. - $ wp role create productadmin "Product Administrator" - Success: Role with key 'productadmin' created. - - - diff --git a/commands/role/delete/index.md b/commands/role/delete/index.md deleted file mode 100644 index 6b6a24a7..00000000 --- a/commands/role/delete/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: default -title: 'wp role delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [role](/commands/role/) » delete - -`wp role delete` - Delete an existing role. - -Quick links: Github issues - -
- -### OPTIONS - -<role-key> -: The internal name of the role. - -### EXAMPLES - - # Delete approver role. - $ wp role delete approver - Success: Role with key 'approver' deleted. - - # Delete productadmin role. - wp role delete productadmin - Success: Role with key 'productadmin' deleted. - - - diff --git a/commands/role/exists/index.md b/commands/role/exists/index.md deleted file mode 100644 index e171f4cb..00000000 --- a/commands/role/exists/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp role exists' -display_global_parameters: true ---- - -[Commands](/commands/) » [role](/commands/role/) » exists - -`wp role exists` - Check if a role exists. - -Quick links: Github issues - -
- -Exits with return code 0 if the role exists, 1 if it does not. - -### OPTIONS - -<role-key> -: The internal name of the role. - -### EXAMPLES - - # Check if a role exists. - $ wp role exists editor - Success: Role with ID 'editor' exists. - - - diff --git a/commands/role/index.md b/commands/role/index.md deleted file mode 100644 index 0faeab94..00000000 --- a/commands/role/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -layout: default -title: 'wp role' -display_global_parameters: true ---- - -[Commands](/commands/) » role - -`wp role` - Manage user roles. - -Quick links: Github issues - -
- -### EXAMPLES - - # List roles. - $ wp role list --fields=role --format=csv - role - administrator - editor - author - contributor - subscriber - - # Check to see if a role exists. - $ wp role exists editor - Success: Role with ID 'editor' exists. - - # Create a new role. - $ wp role create approver Approver - Success: Role with key 'approver' created. - - # Delete an existing role. - $ wp role delete approver - Success: Role with key 'approver' deleted. - - # Reset existing roles to their default capabilities. - $ wp role reset administrator author contributor - Success: Reset 3/3 roles. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
createCreate a new role.
deleteDelete an existing role.
existsCheck if a role exists.
listList all roles.
resetReset any default role to default capabilities.
diff --git a/commands/role/list/index.md b/commands/role/list/index.md deleted file mode 100644 index 019fb259..00000000 --- a/commands/role/list/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: default -title: 'wp role list' -display_global_parameters: true ---- - -[Commands](/commands/) » [role](/commands/role/) » list - -`wp role list` - List all roles. - -Quick links: Github issues - -
- -### 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 - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each role: - -* name -* role - -There are no optional fields. - -### EXAMPLES - - # List roles. - $ wp role list --fields=role --format=csv - role - administrator - editor - author - contributor - subscriber - - - diff --git a/commands/role/reset/index.md b/commands/role/reset/index.md deleted file mode 100644 index 926b1440..00000000 --- a/commands/role/reset/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: 'wp role reset' -display_global_parameters: true ---- - -[Commands](/commands/) » [role](/commands/role/) » reset - -`wp role reset` - Reset any default role to default capabilities. - -Quick links: Github issues - -
- -### OPTIONS - -[<role-key>...] -: The internal name of one or more roles to reset. - -[\--all] -: If set, all default roles will be reset. - -### EXAMPLES - - # Reset role. - $ wp role reset administrator author contributor - Success: Reset 1/3 roles. - - # Reset all default roles. - $ wp role reset --all - Success: All default roles reset. - - - diff --git a/commands/scaffold/_s/index.md b/commands/scaffold/_s/index.md deleted file mode 100644 index 9bad9e85..00000000 --- a/commands/scaffold/_s/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default -title: 'wp scaffold _s' -display_global_parameters: true ---- - -[Commands](/commands/) » [scaffold](/commands/scaffold/) » _s - -`wp scaffold _s` - Generate starter code for a theme based on _s. - -Quick links: Github issues - -
- -See the [Underscores website](http://underscores.me/) for more details. - -### OPTIONS - -<slug> -: The slug for the new theme, used for prefixing functions. - -[\--activate] -: Activate the newly downloaded theme. - -[\--enable-network] -: Enable the newly downloaded theme for the entire network. - -[\--theme_name=<title>] -: What to put in the 'Theme Name:' header in 'style.css'. - -[\--author=<full-name>] -: What to put in the 'Author:' header in 'style.css'. - -[\--author_uri=<uri>] -: What to put in the 'Author URI:' header in 'style.css'. - -[\--sassify] -: Include stylesheets as SASS. - -[\--force] -: Overwrite files that already exist. - -### EXAMPLES - - # Generate a theme with name "Sample Theme" and author "John Doe" - $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe" - Success: Created theme 'Sample Theme'. - - - diff --git a/commands/scaffold/child-theme/index.md b/commands/scaffold/child-theme/index.md deleted file mode 100644 index d2447d47..00000000 --- a/commands/scaffold/child-theme/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -layout: default -title: 'wp scaffold child-theme' -display_global_parameters: true ---- - -[Commands](/commands/) » [scaffold](/commands/scaffold/) » child-theme - -`wp scaffold child-theme` - Generate child theme based on an existing theme. - -Quick links: Github issues - -
- -Creates a child theme folder with `functions.php` and `style.css` files. - -### OPTIONS - -<slug> -: The slug for the new child theme. - -\--parent_theme=<slug> -: What to put in the 'Template:' header in 'style.css'. - -[\--theme_name=<title>] -: What to put in the 'Theme Name:' header in 'style.css'. - -[\--author=<full-name>] -: What to put in the 'Author:' header in 'style.css'. - -[\--author_uri=<uri>] -: What to put in the 'Author URI:' header in 'style.css'. - -[\--theme_uri=<uri>] -: What to put in the 'Theme URI:' header in 'style.css'. - -[\--activate] -: Activate the newly created child theme. - -[\--enable-network] -: Enable the newly created child theme for the entire network. - -[\--force] -: Overwrite files that already exist. - -### EXAMPLES - - # Generate a 'sample-theme' child theme based on TwentySixteen - $ wp scaffold child-theme sample-theme --parent_theme=twentysixteen - Success: Created '/var/www/example.com/public_html/wp-content/themes/sample-theme'. - - - diff --git a/commands/scaffold/index.md b/commands/scaffold/index.md deleted file mode 100644 index 6ecba3be..00000000 --- a/commands/scaffold/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: 'wp scaffold' -display_global_parameters: true ---- - -[Commands](/commands/) » scaffold - -`wp scaffold` - Generate code for post types, taxonomies, plugins, child themes. etc. - -Quick links: Github issues - -
- -### EXAMPLES - - # Generate a new plugin with unit tests - $ wp scaffold plugin sample-plugin - Success: Created plugin files. - Success: Created test files. - - # Generate theme based on _s - $ wp scaffold _s sample-theme --theme_name="Sample Theme" --author="John Doe" - Success: Created theme 'Sample Theme'. - - # Generate code for post type registration in given theme - $ wp scaffold post-type movie --label=Movie --theme=simple-life - Success: Created /var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
_sGenerate starter code for a theme based on _s.
child-themeGenerate child theme based on an existing theme.
pluginGenerate starter code for a plugin.
plugin-testsGenerate files needed for running PHPUnit tests in a plugin.
post-typeGenerate PHP code for registering a custom post type.
taxonomyGenerate PHP code for registering a custom taxonomy.
theme-testsGenerate files needed for running PHPUnit tests in a theme.
diff --git a/commands/scaffold/plugin-tests/index.md b/commands/scaffold/plugin-tests/index.md deleted file mode 100644 index 16e23e89..00000000 --- a/commands/scaffold/plugin-tests/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: 'wp scaffold plugin-tests' -display_global_parameters: true ---- - -[Commands](/commands/) » [scaffold](/commands/scaffold/) » plugin-tests - -`wp scaffold plugin-tests` - Generate files needed for running PHPUnit tests in a plugin. - -Quick links: Github issues - -
- -The following files are generated by default: - -* `phpunit.xml.dist` is the configuration file for PHPUnit. -* `.travis.yml` is the configuration file for Travis CI. Use `--ci=<provider>` to select a different service. -* `bin/install-wp-tests.sh` configures the WordPress test suite and a test database. -* `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite. -* `tests/test-sample.php` is a sample file containing the actual tests. -* `phpcs.ruleset.xml` is a collenction of PHP_CodeSniffer rules. - -Learn more from the [plugin unit tests documentation](http://wp-cli.org/docs/plugin-unit-tests/). - -### ENVIRONMENT - -The `tests/bootstrap.php` file looks for the WP_TESTS_DIR environment -variable. - -### OPTIONS - -[<plugin>] -: The name of the plugin to generate test files for. - -[\--dir=<dirname>] -: Generate test files for a non-standard plugin path. If no plugin slug is specified, the directory name is used. - -[\--ci=<provider>] -: Choose a configuration file for a continuous integration provider. -\--- -default: travis -options: - - travis - - circle - - gitlab -\--- - -[\--force] -: Overwrite files that already exist. - -### EXAMPLES - - # Generate unit test files for plugin 'sample-plugin'. - $ wp scaffold plugin-tests sample-plugin - Success: Created test files. - - - diff --git a/commands/scaffold/plugin/index.md b/commands/scaffold/plugin/index.md deleted file mode 100644 index 50396fbf..00000000 --- a/commands/scaffold/plugin/index.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -layout: default -title: 'wp scaffold plugin' -display_global_parameters: true ---- - -[Commands](/commands/) » [scaffold](/commands/scaffold/) » plugin - -`wp scaffold plugin` - Generate starter code for a plugin. - -Quick links: Github issues - -
- -The following files are always generated: - -* `plugin-slug.php` is the main PHP plugin file. -* `readme.txt` is the readme file for the plugin. -* `package.json` needed by NPM holds various metadata relevant to the project. Packages: `grunt`, `grunt-wp-i18n` and `grunt-wp-readme-to-markdown`. -* `Gruntfile.js` is the JS file containing Grunt tasks. Tasks: `i18n` containing `addtextdomain` and `makepot`, `readme` containing `wp_readme_to_markdown`. -* `.editorconfig` is the configuration file for Editor. -* `.gitignore` tells which files (or patterns) git should ignore. -* `.distignore` tells which files and folders should be ignored in distribution. - -The following files are also included unless the `--skip-tests` is used: - -* `phpunit.xml.dist` is the configuration file for PHPUnit. -* `.travis.yml` is the configuration file for Travis CI. Use `--ci=<provider>` to select a different service. -* `bin/install-wp-tests.sh` configures the WordPress test suite and a test database. -* `tests/bootstrap.php` is the file that makes the current plugin active when running the test suite. -* `tests/test-sample.php` is a sample file containing test cases. -* `phpcs.ruleset.xml` is a collenction of PHP_CodeSniffer rules. - -### OPTIONS - -<slug> -: The internal name of the plugin. - -[\--dir=<dirname>] -: Put the new plugin in some arbitrary directory path. Plugin directory will be path plus supplied slug. - -[\--plugin_name=<title>] -: What to put in the 'Plugin Name:' header. - -[\--plugin_description=<description>] -: What to put in the 'Description:' header. - -[\--plugin_author=<author>] -: What to put in the 'Author:' header. - -[\--plugin_author_uri=<url>] -: What to put in the 'Author URI:' header. - -[\--plugin_uri=<url>] -: What to put in the 'Plugin URI:' header. - -[\--skip-tests] -: Don't generate files for unit testing. - -[\--ci=<provider>] -: Choose a configuration file for a continuous integration provider. -\--- -default: travis -options: - - travis - - circle - - gitlab -\--- - -[\--activate] -: Activate the newly generated plugin. - -[\--activate-network] -: Network activate the newly generated plugin. - -[\--force] -: Overwrite files that already exist. - -### EXAMPLES - - $ wp scaffold plugin sample-plugin - Success: Created plugin files. - Success: Created test files. - - - diff --git a/commands/scaffold/post-type/index.md b/commands/scaffold/post-type/index.md deleted file mode 100644 index 5c3432cc..00000000 --- a/commands/scaffold/post-type/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: 'wp scaffold post-type' -display_global_parameters: true ---- - -[Commands](/commands/) » [scaffold](/commands/scaffold/) » post-type - -`wp scaffold post-type` - Generate PHP code for registering a custom post type. - -Quick links: Github issues - -
- -### OPTIONS - -<slug> -: The internal name of the post type. - -[\--label=<label>] -: The text used to translate the update messages. - -[\--textdomain=<textdomain>] -: The textdomain to use for the labels. - -[\--dashicon=<dashicon>] -: The dashicon to use in the menu. - -[\--theme] -: Create a file in the active theme directory, instead of sending to -STDOUT. Specify a theme with `--theme=<theme>` to have the file placed in that theme. - -[\--plugin=<plugin>] -: Create a file in the given plugin's directory, instead of sending to STDOUT. - -[\--raw] -: Just generate the `register_post_type()` call and nothing else. - -[\--force] -: Overwrite files that already exist. - -### EXAMPLES - - # Generate a 'movie' post type for the 'simple-life' theme - $ wp scaffold post-type movie --label=Movie --theme=simple-life - Success: Created '/var/www/example.com/public_html/wp-content/themes/simple-life/post-types/movie.php'. - - - diff --git a/commands/scaffold/taxonomy/index.md b/commands/scaffold/taxonomy/index.md deleted file mode 100644 index d427b4d1..00000000 --- a/commands/scaffold/taxonomy/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: default -title: 'wp scaffold taxonomy' -display_global_parameters: true ---- - -[Commands](/commands/) » [scaffold](/commands/scaffold/) » taxonomy - -`wp scaffold taxonomy` - Generate PHP code for registering a custom taxonomy. - -Quick links: Github issues - -
- -### OPTIONS - -<slug> -: The internal name of the taxonomy. - -[\--post_types=<post-types>] -: Post types to register for use with the taxonomy. - -[\--label=<label>] -: The text used to translate the update messages. - -[\--textdomain=<textdomain>] -: The textdomain to use for the labels. - -[\--theme] -: Create a file in the active theme directory, instead of sending to -STDOUT. Specify a theme with `--theme=<theme>` to have the file placed in that theme. - -[\--plugin=<plugin>] -: Create a file in the given plugin's directory, instead of sending to STDOUT. - -[\--raw] -: Just generate the `register_taxonomy()` call and nothing else. - -[\--force] -: Overwrite files that already exist. - -### EXAMPLES - - # Generate PHP code for registering a custom taxonomy and save in a file - $ wp scaffold taxonomy venue --post_types=event,presentation > taxonomy.php - - - diff --git a/commands/scaffold/theme-tests/index.md b/commands/scaffold/theme-tests/index.md deleted file mode 100644 index ddbaf69e..00000000 --- a/commands/scaffold/theme-tests/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: 'wp scaffold theme-tests' -display_global_parameters: true ---- - -[Commands](/commands/) » [scaffold](/commands/scaffold/) » theme-tests - -`wp scaffold theme-tests` - Generate files needed for running PHPUnit tests in a theme. - -Quick links: Github issues - -
- -The following files are generated by default: - -* `phpunit.xml.dist` is the configuration file for PHPUnit. -* `.travis.yml` is the configuration file for Travis CI. Use `--ci=<provider>` to select a different service. -* `bin/install-wp-tests.sh` configures the WordPress test suite and a test database. -* `tests/bootstrap.php` is the file that makes the current theme active when running the test suite. -* `tests/test-sample.php` is a sample file containing the actual tests. -* `phpcs.ruleset.xml` is a collenction of PHP_CodeSniffer rules. - -Learn more from the [plugin unit tests documentation](http://wp-cli.org/docs/plugin-unit-tests/). - -### ENVIRONMENT - -The `tests/bootstrap.php` file looks for the WP_TESTS_DIR environment -variable. - -### OPTIONS - -[<theme>] -: The name of the theme to generate test files for. - -[\--dir=<dirname>] -: Generate test files for a non-standard theme path. If no theme slug is specified, the directory name is used. - -[\--ci=<provider>] -: Choose a configuration file for a continuous integration provider. -\--- -default: travis -options: - - travis - - circle - - gitlab -\--- - -[\--force] -: Overwrite files that already exist. - -### EXAMPLES - - # Generate unit test files for theme 'twentysixteenchild'. - $ wp scaffold theme-tests twentysixteenchild - Success: Created test files. - - - diff --git a/commands/search-replace/index.md b/commands/search-replace/index.md deleted file mode 100644 index bbd922ef..00000000 --- a/commands/search-replace/index.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -layout: default -title: 'wp search-replace' -display_global_parameters: true ---- - -[Commands](/commands/) » search-replace - -`wp search-replace` - Search/replace strings in the database. - -Quick links: Github issues - -
- -Searches through all rows in a selection of tables and replaces -appearances of the first string with the second string. - -By default, the command uses tables registered to the $wpdb object. On -multisite, this will just be the tables for the current site unless -\--network is specified. - -Search/replace intelligently handles PHP serialized data, and does not -change primary key values. - -### OPTIONS - -<old> -: A string to search for within the database. - -<new> -: Replace instances of the first string with this new string. - -[<table>...] -: List of database tables to restrict the replacement to. Wildcards are -supported, e.g. `'wp_*options'` or `'wp_post*'`. - -[\--dry-run] -: Run the entire search/replace operation and show report, but don't save -changes to the database. - -[\--network] -: Search/replace through all the tables registered to $wpdb in a -multisite install. - -[\--all-tables-with-prefix] -: Enable replacement on any tables that match the table prefix even if -not registered on $wpdb. - -[\--all-tables] -: Enable replacement on ALL tables in the database, regardless of the -prefix, and even if not registered on $wpdb. Overrides --network -and --all-tables-with-prefix. - -[\--export[=<file>]] -: Write transformed data as SQL file instead of saving replacements to -the database. If <file> is not supplied, will output to STDOUT. - -[\--export_insert_size=<rows>] -: Define number of rows in single INSERT statement when doing SQL export. -You might want to change this depending on your database configuration -(e.g. if you need to do fewer queries). Default: 50 - -[\--skip-columns=<columns>] -: Do not perform the replacement on specific columns. Use commas to -specify multiple columns. - -[\--include-columns=<columns>] -: Perform the replacement on specific columns. Use commas to -specify multiple columns. - -[\--precise] -: Force the use of PHP (instead of SQL) which is more thorough, -but slower. - -[\--recurse-objects] -: Enable recursing into objects to replace strings. Defaults to true; -pass --no-recurse-objects to disable. - -[\--verbose] -: Prints rows to the console as they're updated. - -[\--regex] -: Runs the search using a regular expression (without delimiters). -Warning: search-replace will take about 15-20x longer when using --regex. - -[\--regex-flags=<regex-flags>] -: Pass PCRE modifiers to regex search-replace (e.g. 'i' for case-insensitivity). - -### EXAMPLES - - # Search and replace but skip one column - $ wp search-replace 'http://example.dev' 'http://example.com' --skip-columns=guid - - # Run search/replace operation but dont save in database - $ wp search-replace 'foo' 'bar' wp_posts wp_postmeta wp_terms --dry-run - - # Run case-insensitive regex search/replace operation (slow) - $ wp search-replace '\[foo id="([0-9]+)"' '[bar id="\1"' --regex --regex-flags='i' - - # Turn your production multisite database into a local dev database - $ wp search-replace --url=example.com example.com example.dev 'wp_*options' wp_blogs - - # Search/replace to a SQL file without transforming the database - $ wp search-replace foo bar --export=database.sql - - # Bash script: Search/replace production to development url (multisite compatible) - #!/bin/bash - if $(wp --url=http://example.com core is-installed --network); then - wp search-replace --url=http://example.com 'http://example.com' 'http://example.dev' --recurse-objects --network --skip-columns=guid - else - wp search-replace 'http://example.com' 'http://example.dev' --recurse-objects --skip-columns=guid - fi - - - diff --git a/commands/server/index.md b/commands/server/index.md deleted file mode 100644 index 7044be3f..00000000 --- a/commands/server/index.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: default -title: 'wp server' -display_global_parameters: true ---- - -[Commands](/commands/) » server - -`wp server` - Launch PHP's built-in web server for this specific WordPress installation. - -Quick links: Github issues - -
- -Uses `php -S` to launch a web server serving the WordPress webroot. -<http://php.net/manual/en/features.commandline.webserver.php> - -### OPTIONS - -[\--host=<host>] -: The hostname to bind the server to. -\--- -default: localhost -\--- - -[\--port=<port>] -: The port number to bind the server to. -\--- -default: 8080 -\--- - -[\--docroot=<path>] -: The path to use as the document root. If the path global parameter is -set, the default value is it. - -[\--config=<file>] -: Configure the server with a specific .ini file. - -### EXAMPLES - - # Make the instance available on any address (with port 8080) - $ wp server --host=0.0.0.0 - PHP 5.6.9 Development Server started at Tue May 24 01:27:11 2016 - Listening on http://0.0.0.0:8080 - Document root is / - Press Ctrl-C to quit. - - # Run on port 80 (for multisite) - $ sudo wp server --host=localhost.localdomain --port=80 - PHP 5.6.9 Development Server started at Tue May 24 01:30:06 2016 - Listening on http://localhost1.localdomain1:8080 - Document root is / - Press Ctrl-C to quit. - - # Configure the server with a specific .ini file - $ wp server --config=development.ini - PHP 7.0.9 Development Server started at Mon Aug 22 12:09:04 2016 - Listening on http://localhost:8080 - Document root is / - Press Ctrl-C to quit. - - - diff --git a/commands/shell/index.md b/commands/shell/index.md deleted file mode 100644 index 54bd890c..00000000 --- a/commands/shell/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: 'wp shell' -display_global_parameters: true ---- - -[Commands](/commands/) » shell - -`wp shell` - Interactive PHP console. - -Quick links: Github issues - -
- -`wp shell` allows you to evaluate PHP statements and expressions -interactively, from within a WordPress environment. Type a bit of code, -hit enter, and see the code execute right before you. Because WordPress -is loaded, you have access to all the functions, classes and globals -that you can use within a WordPress plugin, for example. - -### OPTIONS - -[\--basic] -: Start in fail-safe mode, even if Boris is available. - -### EXAMPLES - - # Call get_bloginfo() to get the name of the site. - $ wp shell - wp> get_bloginfo( 'name' ); - => string(6) "WP-CLI" - - - diff --git a/commands/sidebar/index.md b/commands/sidebar/index.md deleted file mode 100644 index a0b5cded..00000000 --- a/commands/sidebar/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: default -title: 'wp sidebar' -display_global_parameters: true ---- - -[Commands](/commands/) » sidebar - -`wp sidebar` - Manage sidebars. - -Quick links: Github issues - -
- -### EXAMPLES - - # List sidebars - $ wp sidebar list --fields=name,id --format=csv - name,id - "Widget Area",sidebar-1 - "Inactive Widgets",wp_inactive_widgets - - - -### SUBCOMMANDS - - - - - - - - - - - - - - -
NameDescription
listList registered sidebars.
diff --git a/commands/sidebar/list/index.md b/commands/sidebar/list/index.md deleted file mode 100644 index 26c7a394..00000000 --- a/commands/sidebar/list/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -layout: default -title: 'wp sidebar list' -display_global_parameters: true ---- - -[Commands](/commands/) » [sidebar](/commands/sidebar/) » list - -`wp sidebar list` - List registered sidebars. - -Quick links: Github issues - -
- -### OPTIONS - -[\--fields=<fields>] -: Limit the output to specific object fields. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - ids - - count - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each sidebar: - -* name -* id -* description - -These fields are optionally available: - -* class -* before_widget -* after_widget -* before_title -* after_title - -### EXAMPLES - - $ wp sidebar list --fields=name,id --format=csv - name,id - "Widget Area",sidebar-1 - "Inactive Widgets",wp_inactive_widgets - - - diff --git a/commands/site/activate/index.md b/commands/site/activate/index.md deleted file mode 100644 index c60bd10d..00000000 --- a/commands/site/activate/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp site activate' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » activate - -`wp site activate` - Activate one or more sites. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: One or more IDs of sites to activate. - -### EXAMPLES - - $ wp site activate 123 - Success: Site 123 activated. - - - diff --git a/commands/site/archive/index.md b/commands/site/archive/index.md deleted file mode 100644 index e632793c..00000000 --- a/commands/site/archive/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp site archive' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » archive - -`wp site archive` - Archive one or more sites. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: One or more IDs of sites to archive. - -### EXAMPLES - - $ wp site archive 123 - Success: Site 123 archived. - - - diff --git a/commands/site/create/index.md b/commands/site/create/index.md deleted file mode 100644 index 5032b4cd..00000000 --- a/commands/site/create/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: 'wp site create' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » create - -`wp site create` - Create a site in a multisite install. - -Quick links: Github issues - -
- -### OPTIONS - -\--slug=<slug> -: Path for the new site. Subdomain on subdomain installs, directory on subdirectory installs. - -[\--title=<title>] -: Title of the new site. Default: prettified slug. - -[\--email=<email>] -: Email for Admin user. User will be created if none exists. Assignement to Super Admin if not included. - -[\--network_id=<network-id>] -: Network to associate new site with. Defaults to current network (typically 1). - -[\--private] -: If set, the new site will be non-public (not indexed) - -[\--porcelain] -: If set, only the site id will be output on success. - -### EXAMPLES - - $ wp site create --slug=example - Success: Site 3 created: http://www.example.com/example/ - - - diff --git a/commands/site/deactivate/index.md b/commands/site/deactivate/index.md deleted file mode 100644 index 45fb78b3..00000000 --- a/commands/site/deactivate/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp site deactivate' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » deactivate - -`wp site deactivate` - Deactivate one or more sites. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: One or more IDs of sites to deactivate. - -### EXAMPLES - - $ wp site deactivate 123 - Success: Site 123 deactivated. - - - diff --git a/commands/site/delete/index.md b/commands/site/delete/index.md deleted file mode 100644 index 54081263..00000000 --- a/commands/site/delete/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp site delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » delete - -`wp site delete` - Delete a site in a multisite install. - -Quick links: Github issues - -
- -### OPTIONS - -[<site-id>] -: The id of the site to delete. If not provided, you must set the --slug parameter. - -[\--slug=<slug>] -: Path of the blog to be deleted. Subdomain on subdomain installs, directory on subdirectory installs. - -[\--yes] -: Answer yes to the confirmation message. - -[\--keep-tables] -: Delete the blog from the list, but don't drop it's tables. - -### EXAMPLES - - $ wp site delete 123 - Are you sure you want to delete the http://www.example.com/example site? [y/n] y - Success: The site at 'http://www.example.com/example' was deleted. - - - diff --git a/commands/site/empty/index.md b/commands/site/empty/index.md deleted file mode 100644 index 537673b8..00000000 --- a/commands/site/empty/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: 'wp site empty' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » empty - -`wp site empty` - Empty a site of its content (posts, comments, terms, and meta). - -Quick links: Github issues - -
- -Truncates posts, comments, and terms tables to empty a site of its -content. Doesn't affect site configuration (options) or users. - -If running a persistent object cache, make sure to flush the cache -after emptying the site, as the cache values will be invalid otherwise. - -To also empty custom database tables, you'll need to hook into command -execution: - -``` -WP_CLI::add_hook( 'after_invoke:site empty', function(){ - global $wpdb; - foreach( array( 'p2p', 'p2pmeta' ) as $table ) { - $table = $wpdb->$table; - $wpdb->query( "TRUNCATE $table" ); - } -}); -``` - -### OPTIONS - -[\--uploads] -: Also delete *all* files in the site's in the uploads directory. - -[\--yes] -: Proceed to empty the site without a confirmation prompt. - -### EXAMPLES - - $ wp site empty - Are you sure you want to empty the site at http://www.example.com of all posts, comments, and terms? [y/n] y - Success: The site at 'http://www.example.com' was emptied. - - - diff --git a/commands/site/index.md b/commands/site/index.md deleted file mode 100644 index f96bd6a5..00000000 --- a/commands/site/index.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -layout: default -title: 'wp site' -display_global_parameters: true ---- - -[Commands](/commands/) » site - -`wp site` - Perform site-wide operations. - -Quick links: Github issues - -
- -### EXAMPLES - - # Create site - $ wp site create --slug=example - Success: Site 3 created: www.example.com/example/ - - # Output a simple list of site URLs - $ wp site list --field=url - http://www.example.com/ - http://www.example.com/subdir/ - - # Delete site - $ wp site delete 123 - Are you sure you want to delete the 'http://www.example.com/example' site? [y/n] y - Success: The site at 'http://www.example.com/example' was deleted. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
activateActivate one or more sites.
archiveArchive one or more sites.
createCreate a site in a multisite install.
deactivateDeactivate one or more sites.
deleteDelete a site in a multisite install.
emptyEmpty a site of its content (posts, comments, terms, and meta).
listList all sites in a multisite install.
optionManage site options in a multisite install.
spamMark one or more sites as spam.
unarchiveUnarchive one or more sites.
unspamRemove one or more sites from spam.
diff --git a/commands/site/list/index.md b/commands/site/list/index.md deleted file mode 100644 index 043a8f1c..00000000 --- a/commands/site/list/index.md +++ /dev/null @@ -1,75 +0,0 @@ ---- -layout: default -title: 'wp site list' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » list - -`wp site list` - List all sites in a multisite install. - -Quick links: Github issues - -
- -### OPTIONS - -[\--network=<id>] -: The network to which the sites belong. - -[\--<field>=<value>] -: Filter by one or more fields (see "Available Fields" section). However, -'url' isn't an available filter, because it's created from domain + path. - -[\--site__in=<value>] -: Only list the sites with these blog_id values (comma-separated). - -[\--field=<field>] -: Prints the value of a single field for each site. - -[\--fields=<fields>] -: Comma-separated list of fields to show. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - count - - ids - - json - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each site: - -* blog_id -* url -* last_updated -* registered - -These fields are optionally available: - -* site_id -* domain -* path -* public -* archived -* mature -* spam -* deleted -* lang_id - -### EXAMPLES - - # Output a simple list of site URLs - $ wp site list --field=url - http://www.example.com/ - http://www.example.com/subdir/ - - - diff --git a/commands/site/option/add/index.md b/commands/site/option/add/index.md deleted file mode 100644 index db2c458c..00000000 --- a/commands/site/option/add/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: 'wp site option add' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » add - -`wp site option add` - Add a site option. - -Quick links: Github issues - -
- -### OPTIONS - -<key> -: The name of the site option to add. - -[<value>] -: The value of the site option to add. If ommited, the value is read from STDIN. - -[\--format=<format>] -: The serialization format for the value. -\--- -default: plaintext -options: - - plaintext - - json -\--- - -### EXAMPLES - - # Create a site option by reading a JSON file - $ wp site option add my_option --format=json < config.json - Success: Added 'my_option' site option. - - - diff --git a/commands/site/option/delete/index.md b/commands/site/option/delete/index.md deleted file mode 100644 index 8998de05..00000000 --- a/commands/site/option/delete/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp site option delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » delete - -`wp site option delete` - Delete a site option. - -Quick links: Github issues - -
- -### OPTIONS - -<key> -: Key for the site option. - -### EXAMPLES - - $ wp site option delete my_option - Success: Deleted 'my_option' site option. - - - diff --git a/commands/site/option/get/index.md b/commands/site/option/get/index.md deleted file mode 100644 index 0bb9a888..00000000 --- a/commands/site/option/get/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default -title: 'wp site option get' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » get - -`wp site option get` - Get a site option. - -Quick links: Github issues - -
- -### OPTIONS - -<key> -: Key for the site option. - -[\--format=<format>] -: Get value in a particular format. -\--- -default: var_export -options: - - var_export - - json - - yaml -\--- - -### EXAMPLES - - # Get site upload filetypes - $ wp site option get upload_filetypes - jpg jpeg png gif mov avi mpg - - - diff --git a/commands/site/option/index.md b/commands/site/option/index.md deleted file mode 100644 index c70aa539..00000000 --- a/commands/site/option/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: default -title: 'wp site option' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » option - -`wp site option` - Manage site options in a multisite install. - -Quick links: Github issues - -
- -### EXAMPLES - - # Get site registration - $ wp site option get registration - none - - # Add site option - $ wp site option add my_option foobar - Success: Added 'my_option' site option. - - # Update site option - $ wp site option update my_option '{"foo": "bar"}' --format=json - Success: Updated 'my_option' site option. - - # Delete site option - $ wp site option delete my_option - Success: Deleted 'my_option' site option. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a site option.
deleteDelete a site option.
getGet a site option.
listList site options.
updateUpdate a site option.
diff --git a/commands/site/option/list/index.md b/commands/site/option/list/index.md deleted file mode 100644 index 128f38ff..00000000 --- a/commands/site/option/list/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: default -title: 'wp site option list' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » list - -`wp site option list` - List site options. - -Quick links: Github issues - -
- -### OPTIONS - -[\--search=<pattern>] -: Use wildcards ( * and ? ) to match option name. - -[\--site_id=<id>] -: Limit options to those of a particular site id. - -[\--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 -\--- - -### AVAILABLE FIELDS - -This field will be displayed by default for each matching option: - -* meta_key -* meta_value - -These fields are optionally available: - -* meta_id -* site_id -* size_bytes - -### EXAMPLES - - # List all site options begining with "i2f_" - $ wp site option list --search="i2f_*" - +-------------+--------------+ - | meta_key | meta_value | - +-------------+--------------+ - | i2f_version | 0.1.0 | - +-------------+--------------+ - - - diff --git a/commands/site/option/update/index.md b/commands/site/option/update/index.md deleted file mode 100644 index 532f21f4..00000000 --- a/commands/site/option/update/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: 'wp site option update' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » [option](/commands/site/option/) » update - -`wp site option update` - Update a site option. - -Quick links: Github issues - -
- -### OPTIONS - -<key> -: The name of the site option to update. - -[<value>] -: The new value. If ommited, the value is read from STDIN. - -[\--format=<format>] -: The serialization format for the value. -\--- -default: plaintext -options: - - plaintext - - json -\--- - -### EXAMPLES - - # Update a site option by reading from a file - $ wp site option update my_option < value.txt - Success: Updated 'my_option' site option. - - - diff --git a/commands/site/spam/index.md b/commands/site/spam/index.md deleted file mode 100644 index 4fd2d180..00000000 --- a/commands/site/spam/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp site spam' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » spam - -`wp site spam` - Mark one or more sites as spam. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: One or more IDs of sites to be marked as spam. - -### EXAMPLES - - $ wp site spam 123 - Success: Site 123 marked as spam. - - - diff --git a/commands/site/unarchive/index.md b/commands/site/unarchive/index.md deleted file mode 100644 index cee3893e..00000000 --- a/commands/site/unarchive/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp site unarchive' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » unarchive - -`wp site unarchive` - Unarchive one or more sites. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: One or more IDs of sites to unarchive. - -### EXAMPLES - - $ wp site unarchive 123 - Success: Site 123 unarchived. - - - diff --git a/commands/site/unspam/index.md b/commands/site/unspam/index.md deleted file mode 100644 index df7c084f..00000000 --- a/commands/site/unspam/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp site unspam' -display_global_parameters: true ---- - -[Commands](/commands/) » [site](/commands/site/) » unspam - -`wp site unspam` - Remove one or more sites from spam. - -Quick links: Github issues - -
- -### OPTIONS - -<id>... -: One or more IDs of sites to remove from spam. - -### EXAMPLES - - $ wp site unspam 123 - Success: Site 123 removed from spam. - - - diff --git a/commands/super-admin/add/index.md b/commands/super-admin/add/index.md deleted file mode 100644 index 86e5e842..00000000 --- a/commands/super-admin/add/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp super-admin add' -display_global_parameters: true ---- - -[Commands](/commands/) » [super-admin](/commands/super-admin/) » add - -`wp super-admin add` - Grant super admin privileges to one or more users. - -Quick links: Github issues - -
- -### OPTIONS - -<user>... -: One or more user IDs, user emails, or user logins. - -### EXAMPLES - - $ wp super-admin add superadmin2 - Success: Granted super-admin capabilities. - - - diff --git a/commands/super-admin/index.md b/commands/super-admin/index.md deleted file mode 100644 index 11dab856..00000000 --- a/commands/super-admin/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: default -title: 'wp super-admin' -display_global_parameters: true ---- - -[Commands](/commands/) » super-admin - -`wp super-admin` - Manage super admins on WordPress multisite. - -Quick links: Github issues - -
- -### EXAMPLES - - # List user with super-admin capabilities - $ wp super-admin list - supervisor - administrator - - # Grant super-admin privileges to the user. - $ wp super-admin add superadmin2 - Success: Granted super-admin capabilities. - - # Revoke super-admin privileges to the user. - $ wp super-admin remove superadmin2 - Success: Revoked super-admin capabilities. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addGrant super admin privileges to one or more users.
listList users with super admin capabilities.
removeRemove super admin privileges from one or more users.
diff --git a/commands/super-admin/list/index.md b/commands/super-admin/list/index.md deleted file mode 100644 index 35ca60e5..00000000 --- a/commands/super-admin/list/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default -title: 'wp super-admin list' -display_global_parameters: true ---- - -[Commands](/commands/) » [super-admin](/commands/super-admin/) » list - -`wp super-admin list` - List users with super admin capabilities. - -Quick links: Github issues - -
- -### OPTIONS - -[\--format=<format>] -: Render output in a particular format. -\--- -default: list -options: - - list - - table - - csv - - json - - count - - yaml -\--- - -### EXAMPLES - - # List user with super-admin capabilities - $ wp super-admin list - supervisor - administrator - - - diff --git a/commands/super-admin/remove/index.md b/commands/super-admin/remove/index.md deleted file mode 100644 index db133ef6..00000000 --- a/commands/super-admin/remove/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp super-admin remove' -display_global_parameters: true ---- - -[Commands](/commands/) » [super-admin](/commands/super-admin/) » remove - -`wp super-admin remove` - Remove super admin privileges from one or more users. - -Quick links: Github issues - -
- -### OPTIONS - -<user>... -: One or more user IDs, user emails, or user logins. - -### EXAMPLES - - $ wp super-admin remove superadmin2 - Success: Revoked super-admin capabilities. - - - diff --git a/commands/taxonomy/get/index.md b/commands/taxonomy/get/index.md deleted file mode 100644 index d2166247..00000000 --- a/commands/taxonomy/get/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -layout: default -title: 'wp taxonomy get' -display_global_parameters: true ---- - -[Commands](/commands/) » [taxonomy](/commands/taxonomy/) » get - -`wp taxonomy get` - Get details about a registered taxonomy. - -Quick links: Github issues - -
- -### OPTIONS - -<taxonomy> -: Taxonomy slug. - -[\--field=<field>] -: Instead of returning the whole taxonomy, 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 details of `category` taxonomy. - $ wp taxonomy get category --fields=name,label,object_type - +-------------+------------+ - | Field | Value | - +-------------+------------+ - | name | category | - | label | Categories | - | object_type | ["post"] | - +-------------+------------+ - - # Get capabilities of 'post_tag' taxonomy. - $ wp taxonomy get post_tag --field=cap - {"manage_terms":"manage_categories","edit_terms":"manage_categories","delete_terms":"manage_categories","assign_terms":"edit_posts"} - - - diff --git a/commands/taxonomy/index.md b/commands/taxonomy/index.md deleted file mode 100644 index 71ca03e2..00000000 --- a/commands/taxonomy/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: default -title: 'wp taxonomy' -display_global_parameters: true ---- - -[Commands](/commands/) » taxonomy - -`wp taxonomy` - Manage taxonomies. - -Quick links: Github issues - -
- -### EXAMPLES - - # List all taxonomies with 'post' object type. - $ wp taxonomy list --object_type=post --fields=name,public - +-------------+--------+ - | name | public | - +-------------+--------+ - | category | 1 | - | post_tag | 1 | - | post_format | 1 | - +-------------+--------+ - - # Get capabilities of 'post_tag' taxonomy. - $ wp taxonomy get post_tag --field=cap - {"manage_terms":"manage_categories","edit_terms":"manage_categories","delete_terms":"manage_categories","assign_terms":"edit_posts"} - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - -
NameDescription
getGet details about a registered taxonomy.
listList registered taxonomies.
diff --git a/commands/taxonomy/list/index.md b/commands/taxonomy/list/index.md deleted file mode 100644 index 69f52dbc..00000000 --- a/commands/taxonomy/list/index.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: default -title: 'wp taxonomy list' -display_global_parameters: true ---- - -[Commands](/commands/) » [taxonomy](/commands/taxonomy/) » list - -`wp taxonomy list` - List registered taxonomies. - -Quick links: Github issues - -
- -### OPTIONS - -[\--<field>=<value>] -: Filter by one or more fields (see get_taxonomies() first parameter for a list of available fields). - -[\--field=<field>] -: Prints the value of a single field for each taxonomy. - -[\--fields=<fields>] -: Limit the output to specific taxonomy fields. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - count - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each term: - -* name -* label -* description -* public -* hierarchical - -There are no optionally available fields. - -### EXAMPLES - - # List all taxonomies. - $ wp taxonomy list --format=csv - name,label,description,object_type,show_tagcloud,hierarchical,public - category,Categories,,post,1,1,1 - post_tag,Tags,,post,1,,1 - nav_menu,"Navigation Menus",,nav_menu_item,,, - link_category,"Link Categories",,link,1,, - post_format,Format,,post,,,1 - - # List all taxonomies with 'post' object type. - $ wp taxonomy list --object_type=post --fields=name,public - +-------------+--------+ - | name | public | - +-------------+--------+ - | category | 1 | - | post_tag | 1 | - | post_format | 1 | - +-------------+--------+ - - - diff --git a/commands/term/create/index.md b/commands/term/create/index.md deleted file mode 100644 index 7960b293..00000000 --- a/commands/term/create/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -layout: default -title: 'wp term create' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » create - -`wp term create` - Create a new term. - -Quick links: Github issues - -
- -### OPTIONS - -<taxonomy> -: Taxonomy for the new term. - -<term> -: A name for the new term. - -[\--slug=<slug>] -: A unique slug for the new term. Defaults to sanitized version of name. - -[\--description=<description>] -: A description for the new term. - -[\--parent=<term-id>] -: A parent for the new term. - -[\--porcelain] -: Output just the new term id. - -### EXAMPLES - - # Create a new category "Apple" with a description. - $ wp term create category Apple --description="A type of fruit" - Success: Created category 199. - - - diff --git a/commands/term/delete/index.md b/commands/term/delete/index.md deleted file mode 100644 index cf0aaa71..00000000 --- a/commands/term/delete/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: default -title: 'wp term delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » delete - -`wp term delete` - Delete an existing term. - -Quick links: Github issues - -
- -Errors if the term doesn't exist, or there was a problem in deleting it. - -### OPTIONS - -<taxonomy> -: Taxonomy of the term to delete. - -<term-id>... -: One or more IDs of terms to delete. - -### EXAMPLES - - # Delete post category - $ wp term delete category 15 - Deleted category 15. - Success: Deleted 1 of 1 terms. - - # Delete all post tags - $ wp term list post_tag --field=term_id | xargs wp term delete post_tag - Deleted post_tag 159. - Deleted post_tag 160. - Deleted post_tag 161. - Success: Deleted 3 of 3 terms. - - - diff --git a/commands/term/generate/index.md b/commands/term/generate/index.md deleted file mode 100644 index 8833e08e..00000000 --- a/commands/term/generate/index.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: default -title: 'wp term generate' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » generate - -`wp term generate` - Generate some terms. - -Quick links: Github issues - -
- -Creates a specified number of new terms with dummy data. - -### OPTIONS - -<taxonomy> -: The taxonomy for the generated terms. - -[\--count=<number>] -: How many terms to generate? -\--- -default: 100 -\--- - -[\--max_depth=<number>] -: Generate child terms down to a certain depth. -\--- -default: 1 -\--- - -[\--format=<format>] -: Render output in a particular format. -\--- -default: progress -options: - - progress - - ids -\--- - -### EXAMPLES - - # Generate post categories. - $ wp term generate category --count=10 - Generating terms 100% [=========] 0:02 / 0:02 - - # Add meta to every generated term. - $ wp term generate category --format=ids --count=3 | xargs -d ' ' -I % wp term meta add % foo bar - Success: Added custom field. - Success: Added custom field. - Success: Added custom field. - - - diff --git a/commands/term/get/index.md b/commands/term/get/index.md deleted file mode 100644 index 1019a6a0..00000000 --- a/commands/term/get/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default -title: 'wp term get' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » get - -`wp term get` - Get details about a term. - -Quick links: Github issues - -
- -### OPTIONS - -<taxonomy> -: Taxonomy of the term to get - -<term-id> -: ID of the term to get - -[\--field=<field>] -: Instead of returning the whole term, 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 details about a category with id 199. - $ wp term get category 199 --format=json - {"term_id":199,"name":"Apple","slug":"apple","term_group":0,"term_taxonomy_id":199,"taxonomy":"category","description":"A type of fruit","parent":0,"count":0,"filter":"raw"} - - - diff --git a/commands/term/index.md b/commands/term/index.md deleted file mode 100644 index 07b948c0..00000000 --- a/commands/term/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -layout: default -title: 'wp term' -display_global_parameters: true ---- - -[Commands](/commands/) » term - -`wp term` - Manage terms. - -Quick links: Github issues - -
- -### EXAMPLES - - # Create a new term. - $ wp term create category Apple --description="A type of fruit" - Success: Created category 199. - - # Get details about a term. - $ wp term get category 199 --format=json --fields=term_id,name,slug,count - {"term_id":199,"name":"Apple","slug":"apple","count":1} - - # Update an existing term. - $ wp term update category 15 --name=Apple - Success: Term updated. - - # Get the term's URL. - $ wp term list post_tag --include=123 --field=url - http://example.com/tag/tips-and-tricks - - # Delete post category - $ wp term delete category 15 - Success: Deleted category 15. - - # Recount posts assigned to each categories and tags - $ wp term recount category post_tag - Success: Updated category term count - Success: Updated post_tag term count - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
createCreate a new term.
deleteDelete an existing term.
generateGenerate some terms.
getGet details about a term.
listList terms in a taxonomy.
metaManage term custom fields.
recountRecalculate number of posts assigned to each term.
updateUpdate an existing term.
diff --git a/commands/term/list/index.md b/commands/term/list/index.md deleted file mode 100644 index 414c2031..00000000 --- a/commands/term/list/index.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -layout: default -title: 'wp term list' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » list - -`wp term list` - List terms in a taxonomy. - -Quick links: Github issues - -
- -### OPTIONS - -<taxonomy>... -: List terms of one or more taxonomies - -[\--<field>=<value>] -: Filter by one or more fields (see get_terms() $args parameter for a list of fields). - -[\--field=<field>] -: Prints the value of a single field for each term. - -[\--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 term: - -* term_id -* term_taxonomy_id -* name -* slug -* description -* parent -* count - -These fields are optionally available: - -* url - -### EXAMPLES - - # List post categories - $ wp term list category --format=csv - term_id,term_taxonomy_id,name,slug,description,parent,count - 2,2,aciform,aciform,,0,1 - 3,3,antiquarianism,antiquarianism,,0,1 - 4,4,arrangement,arrangement,,0,1 - 5,5,asmodeus,asmodeus,,0,1 - - # List post tags - $ wp term list post_tag --fields=name,slug - +-----------+-------------+ - | name | slug | - +-----------+-------------+ - | 8BIT | 8bit | - | alignment | alignment-2 | - | Articles | articles | - | aside | aside | - +-----------+-------------+ - - - diff --git a/commands/term/meta/add/index.md b/commands/term/meta/add/index.md deleted file mode 100644 index 61723710..00000000 --- a/commands/term/meta/add/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp term meta add' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » [meta](/commands/term/meta/) » add - -`wp term meta add` - Add a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/term/meta/delete/index.md b/commands/term/meta/delete/index.md deleted file mode 100644 index 80065cbd..00000000 --- a/commands/term/meta/delete/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp term meta delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » [meta](/commands/term/meta/) » delete - -`wp term meta delete` - Delete a meta field. - -Quick links: Github issues - -
- -<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. - - - diff --git a/commands/term/meta/get/index.md b/commands/term/meta/get/index.md deleted file mode 100644 index 7c630506..00000000 --- a/commands/term/meta/get/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: 'wp term meta get' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » [meta](/commands/term/meta/) » get - -`wp term meta get` - Get meta field value. - -Quick links: Github issues - -
- -<id> -: The ID of the object. - -<key> -: The name of the meta field to get. - -[\--format=<format>] -: Accepted values: table, json. Default: table - - - diff --git a/commands/term/meta/index.md b/commands/term/meta/index.md deleted file mode 100644 index ac207dc0..00000000 --- a/commands/term/meta/index.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -layout: default -title: 'wp term meta' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » meta - -`wp term meta` - Manage term custom fields. - -Quick links: Github issues - -
- -### EXAMPLES - - # Set term meta - $ wp term meta set 123 bio "Mary is a WordPress developer." - Success: Updated custom field 'bio'. - - # Get term meta - $ wp term meta get 123 bio - Mary is a WordPress developer. - - # Update term meta - $ wp term meta update 123 bio "Mary is an awesome WordPress developer." - Success: Updated custom field 'bio'. - - # Delete term meta - $ wp term meta delete 123 bio - Success: Deleted custom field. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a meta field.
deleteDelete a meta field.
getGet meta field value.
listList all metadata associated with an object.
updateUpdate a meta field.
diff --git a/commands/term/meta/list/index.md b/commands/term/meta/list/index.md deleted file mode 100644 index 09a5cbe1..00000000 --- a/commands/term/meta/list/index.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: default -title: 'wp term meta list' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » [meta](/commands/term/meta/) » list - -`wp term meta list` - List all metadata associated with an object. - -Quick links: Github issues - -
- -<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>] -: Accepted values: table, csv, json, count. Default: table - - - diff --git a/commands/term/meta/update/index.md b/commands/term/meta/update/index.md deleted file mode 100644 index ceac1360..00000000 --- a/commands/term/meta/update/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp term meta update' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » [meta](/commands/term/meta/) » update - -`wp term meta update` - Update a meta field. - -Quick links: Github issues - -
- -### 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 -\--- - - - diff --git a/commands/term/recount/index.md b/commands/term/recount/index.md deleted file mode 100644 index 85aba19d..00000000 --- a/commands/term/recount/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp term recount' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » recount - -`wp term recount` - Recalculate number of posts assigned to each term. - -Quick links: Github issues - -
- -In instances where manual updates are made to the terms assigned to -posts in the database, the number of posts associated with a term -can become out-of-sync with the actual number of posts. - -This command runs wp_update_term_count() on the taxonomy's terms -to bring the count back to the correct value. - -### OPTIONS - -<taxonomy>... -: One or more taxonomies to recalculate. - -### EXAMPLES - - # Recount posts assigned to each categories and tags - $ wp term recount category post_tag - Success: Updated category term count. - Success: Updated post_tag term count. - - # Recount all listed taxonomies - $ wp taxonomy list --field=name | xargs wp term recount - Success: Updated category term count. - Success: Updated post_tag term count. - Success: Updated nav_menu term count. - Success: Updated link_category term count. - Success: Updated post_format term count. - - - diff --git a/commands/term/update/index.md b/commands/term/update/index.md deleted file mode 100644 index 588b2c02..00000000 --- a/commands/term/update/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -layout: default -title: 'wp term update' -display_global_parameters: true ---- - -[Commands](/commands/) » [term](/commands/term/) » update - -`wp term update` - Update an existing term. - -Quick links: Github issues - -
- -### OPTIONS - -<taxonomy> -: Taxonomy of the term to update. - -<term-id> -: ID for the term to update. - -[\--name=<name>] -: A new name for the term. - -[\--slug=<slug>] -: A new slug for the term. - -[\--description=<description>] -: A new description for the term. - -[\--parent=<term-id>] -: A new parent for the term. - -### EXAMPLES - - # Change category with id 15 to use the name "Apple" - $ wp term update category 15 --name=Apple - Success: Term updated. - - - diff --git a/commands/theme/activate/index.md b/commands/theme/activate/index.md deleted file mode 100644 index 12cad5bb..00000000 --- a/commands/theme/activate/index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -layout: default -title: 'wp theme activate' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » activate - -`wp theme activate` - Activate a theme. - -Quick links: Github issues - -
- -### OPTIONS - -<theme> -: The theme to activate. - -### EXAMPLES - - $ wp theme activate twentysixteen - Success: Switched to 'Twenty Sixteen' theme. - - - diff --git a/commands/theme/delete/index.md b/commands/theme/delete/index.md deleted file mode 100644 index ae6ed667..00000000 --- a/commands/theme/delete/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp theme delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » delete - -`wp theme delete` - Delete a theme. - -Quick links: Github issues - -
- -Removes the theme from the filesystem. - -### OPTIONS - -<theme>... -: One or more themes to delete. - -### EXAMPLES - - $ wp theme delete twentytwelve - Deleted 'twentytwelve' theme. - Success: Deleted 1 of 1 themes. - - - diff --git a/commands/theme/disable/index.md b/commands/theme/disable/index.md deleted file mode 100644 index e6c3088b..00000000 --- a/commands/theme/disable/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: 'wp theme disable' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » disable - -`wp theme disable` - Disable a theme on a WordPress multisite install. - -Quick links: Github issues - -
- -Removes ability for a theme to be activated from the dashboard of a site -on a WordPress multisite install. - -### OPTIONS - -<theme> -: The theme to disable. - -[\--network] -: If set, the theme is disabled on the network level. Note that -individual sites may still have this theme enabled if it was -enabled for them independently. - -### EXAMPLES - - # Disable theme - $ wp theme disable twentysixteen - Success: Disabled the 'Twenty Sixteen' theme. - - # Disable theme in network level - $ wp theme disable twentysixteen --network - Success: Network disabled the 'Twenty Sixteen' theme. - - - diff --git a/commands/theme/enable/index.md b/commands/theme/enable/index.md deleted file mode 100644 index 3341ed6e..00000000 --- a/commands/theme/enable/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: 'wp theme enable' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » enable - -`wp theme enable` - Enable a theme on a WordPress multisite install. - -Quick links: Github issues - -
- -Permits theme to be activated from the dashboard of a site on a WordPress -multisite install. - -### OPTIONS - -<theme> -: The theme to enable. - -[\--network] -: If set, the theme is enabled for the entire network - -[\--activate] -: If set, the theme is activated for the current site. Note that -the "network" flag has no influence on this. - -### EXAMPLES - - # Enable theme - $ wp theme enable twentysixteen - Success: Enabled the 'Twenty Sixteen' theme. - - # Network enable theme - $ wp theme enable twentysixteen --network - Success: Network enabled the 'Twenty Sixteen' theme. - - # Network enable and activate theme for current site - $ wp theme enable twentysixteen --activate - Success: Enabled the 'Twenty Sixteen' theme. - Success: Switched to 'Twenty Sixteen' theme. - - - diff --git a/commands/theme/get/index.md b/commands/theme/get/index.md deleted file mode 100644 index d8ab746a..00000000 --- a/commands/theme/get/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: 'wp theme get' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » get - -`wp theme get` - Get details about a theme. - -Quick links: Github issues - -
- -### OPTIONS - -<theme> -: The theme to get. - -[\--field=<field>] -: Instead of returning the whole theme, 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 - - $ wp theme get twentysixteen --fields=name,title,version - +---------+----------------+ - | Field | Value | - +---------+----------------+ - | name | Twenty Sixteen | - | title | Twenty Sixteen | - | version | 1.2 | - +---------+----------------+ - - - diff --git a/commands/theme/index.md b/commands/theme/index.md deleted file mode 100644 index 5ba2fd82..00000000 --- a/commands/theme/index.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -layout: default -title: 'wp theme' -display_global_parameters: true ---- - -[Commands](/commands/) » theme - -`wp theme` - Manage themes. - -Quick links: Github issues - -
- -### EXAMPLES - - # Install the latest version of a theme from wordpress.org and activate - $ wp theme install twentysixteen --activate - Installing Twenty Sixteen (1.2) - Downloading install package from http://downloads.wordpress.org/theme/twentysixteen.1.2.zip... - Unpacking the package... - Installing the theme... - Theme installed successfully. - Activating 'twentysixteen'... - Success: Switched to 'Twenty Sixteen' theme. - - # Get details of an installed theme - $ wp theme get twentysixteen --fields=name,title,version - +---------+----------------+ - | Field | Value | - +---------+----------------+ - | name | Twenty Sixteen | - | title | Twenty Sixteen | - | version | 1.2 | - +---------+----------------+ - - # Get status of theme - $ wp theme status twentysixteen - Theme twentysixteen details: - Name: Twenty Sixteen - Status: Active - Version: 1.2 - Author: the WordPress team - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
activateActivate a theme.
deleteDelete a theme.
disableDisable a theme on a WordPress multisite install.
enableEnable a theme on a WordPress multisite install.
getGet details about a theme.
installInstall a theme.
is-installedCheck if the theme is installed.
listGet a list of themes.
modManage theme mods.
pathGet the path to a theme or to the theme directory.
searchSearch the WordPress.org theme directory.
statusSee the status of one or all themes.
updateUpdate one or more themes.
diff --git a/commands/theme/install/index.md b/commands/theme/install/index.md deleted file mode 100644 index 03bbed5f..00000000 --- a/commands/theme/install/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -layout: default -title: 'wp theme install' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » install - -`wp theme install` - Install a theme. - -Quick links: Github issues - -
- -### OPTIONS - -<theme|zip|url>... -: A theme slug, the path to a local zip file, or URL to a remote zip file. - -[\--version=<version>] -: If set, get that particular version from wordpress.org, instead of the -stable version. - -[\--force] -: If set, the command will overwrite any installed version of the theme, without prompting -for confirmation. - -[\--activate] -: If set, the theme will be activated immediately after install. - -### EXAMPLES - - # Install the latest version from wordpress.org and activate - $ wp theme install twentysixteen --activate - Installing Twenty Sixteen (1.2) - Downloading install package from http://downloads.wordpress.org/theme/twentysixteen.1.2.zip... - Unpacking the package... - Installing the theme... - Theme installed successfully. - Activating 'twentysixteen'... - Success: Switched to 'Twenty Sixteen' theme. - - # Install from a local zip file - $ wp theme install ../my-theme.zip - - # Install from a remote zip file - $ wp theme install http://s3.amazonaws.com/bucketname/my-theme.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef - - - diff --git a/commands/theme/is-installed/index.md b/commands/theme/is-installed/index.md deleted file mode 100644 index 41babbd0..00000000 --- a/commands/theme/is-installed/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp theme is-installed' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » is-installed - -`wp theme is-installed` - Check if the theme is installed. - -Quick links: Github issues - -
- -Returns exit code 0 when installed, 1 when uninstalled. - -### OPTIONS - -<theme> -: The theme to check. - -### EXAMPLES - - # Check whether theme is installed; exit status 0 if installed, otherwise 1 - $ wp theme is-installed hello - $ echo $? - 1 - - - diff --git a/commands/theme/list/index.md b/commands/theme/list/index.md deleted file mode 100644 index 5da161de..00000000 --- a/commands/theme/list/index.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -layout: default -title: 'wp theme list' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » list - -`wp theme list` - Get a list of themes. - -Quick links: Github issues - -
- -### OPTIONS - -[\--<field>=<value>] -: Filter results based on the value of a field. - -[\--field=<field>] -: Prints the value of a single field for each theme. - -[\--fields=<fields>] -: Limit the output to specific object fields. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - count - - yaml -\--- - -### AVAILABLE FIELDS - -These fields will be displayed by default for each theme: - -* name -* status -* update -* version - -These fields are optionally available: - -* update_version -* update_package -* update_id -* title -* description - -### EXAMPLES - - # List themes - $ wp theme list --status=inactive --format=csv - name,status,update,version - twentyfourteen,inactive,none,1.7 - twentysixteen,inactive,available,1.1 - - - diff --git a/commands/theme/mod/get/index.md b/commands/theme/mod/get/index.md deleted file mode 100644 index ff5af07b..00000000 --- a/commands/theme/mod/get/index.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -layout: default -title: 'wp theme mod get' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » [mod](/commands/theme/mod/) » get - -`wp theme mod get` - Get one or more theme mods. - -Quick links: Github issues - -
- -### OPTIONS - -[<mod>...] -: One or more mods to get. - -[\--field=<field>] -: Returns the value of a single field. - -[\--all] -: List all theme mods - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - json - - csv - - yaml -\--- - -### EXAMPLES - - # Get all theme mods. - $ wp theme mod get --all - +------------------+---------+ - | key | value | - +------------------+---------+ - | background_color | dd3333 | - | link_color | #dd9933 | - | main_text_color | #8224e3 | - +------------------+---------+ - - # Get single theme mod in JSON format. - $ wp theme mod get background_color --format=json - [{"key":"background_color","value":"dd3333"}] - - # Get value of a single theme mod. - $ wp theme mod get background_color --field=value - dd3333 - - # Get multiple theme mods. - $ wp theme mod get background_color header_textcolor - +------------------+--------+ - | key | value | - +------------------+--------+ - | background_color | dd3333 | - | header_textcolor | | - +------------------+--------+ - - - diff --git a/commands/theme/mod/index.md b/commands/theme/mod/index.md deleted file mode 100644 index 03c1c2d5..00000000 --- a/commands/theme/mod/index.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -layout: default -title: 'wp theme mod' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » mod - -`wp theme mod` - Manage theme mods. - -Quick links: Github issues - -
- -### EXAMPLES - - # Set the 'background_color' theme mod to '000000'. - $ wp theme mod set background_color 000000 - Success: Theme mod background_color set to 000000 - - # Get single theme mod in JSON format. - $ wp theme mod get background_color --format=json - [{"key":"background_color","value":"dd3333"}] - - # Remove all theme mods. - $ wp theme mod remove --all - Success: Theme mods removed. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
getGet one or more theme mods.
removeRemove one or more theme mods.
setSet the value of a theme mod.
diff --git a/commands/theme/mod/remove/index.md b/commands/theme/mod/remove/index.md deleted file mode 100644 index 36695792..00000000 --- a/commands/theme/mod/remove/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -layout: default -title: 'wp theme mod remove' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » [mod](/commands/theme/mod/) » remove - -`wp theme mod remove` - Remove one or more theme mods. - -Quick links: Github issues - -
- -### OPTIONS - -[<mod>...] -: One or more mods to remove. - -[\--all] -: Remove all theme mods. - -### EXAMPLES - - # Remove all theme mods. - $ wp theme mod remove --all - Success: Theme mods removed. - - # Remove single theme mod. - $ wp theme mod remove background_color - Success: 1 mod removed. - - # Remove multiple theme mods. - $ wp theme mod remove background_color header_textcolor - Success: 2 mods removed. - - - diff --git a/commands/theme/mod/set/index.md b/commands/theme/mod/set/index.md deleted file mode 100644 index 2079be33..00000000 --- a/commands/theme/mod/set/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp theme mod set' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » [mod](/commands/theme/mod/) » set - -`wp theme mod set` - Set the value of a theme mod. - -Quick links: Github issues - -
- -### OPTIONS - -<mod> -: The name of the theme mod to set or update. - -<value> -: The new value. - -### EXAMPLES - - # Set theme mod - $ wp theme mod set background_color 000000 - Success: Theme mod background_color set to 000000 - - - diff --git a/commands/theme/path/index.md b/commands/theme/path/index.md deleted file mode 100644 index 9878d003..00000000 --- a/commands/theme/path/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: default -title: 'wp theme path' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » path - -`wp theme path` - Get the path to a theme or to the theme directory. - -Quick links: Github issues - -
- -### OPTIONS - -[<theme>] -: The theme to get the path to. Path includes "style.css" file. -If not set, will return the path to the themes directory. - -[\--dir] -: If set, get the path to the closest parent directory, instead of the -theme's "style.css" file. - -### EXAMPLES - - # Get theme path - $ wp theme path - /var/www/example.com/public_html/wp-content/themes - - # Change directory to theme path - $ cd $(wp theme path) - - - diff --git a/commands/theme/search/index.md b/commands/theme/search/index.md deleted file mode 100644 index 6939aa77..00000000 --- a/commands/theme/search/index.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -layout: default -title: 'wp theme search' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » search - -`wp theme search` - Search the WordPress.org theme directory. - -Quick links: Github issues - -
- -Displays themes in the WordPress.org theme directory matching a given -search query. - -### OPTIONS - -<search> -: The string to search for. - -[\--per-page=<per-page>] -: Optional number of results to display. Defaults to 10. - -[\--field=<field>] -: Prints the value of a single field for each theme. - -[\--fields=<fields>] -: Ask for specific fields from the API. Defaults to name,slug,author,rating. Acceptable values: - - **name**: Theme Name - **slug**: Theme Slug - **version**: Current Version Number - **author**: Theme Author - **preview_url**: Theme Preview URL - **screenshot_url**: Theme Screenshot URL - **rating**: Theme Rating - **num_ratings**: Number of Theme Ratings - **homepage**: Theme Author's Homepage - **description**: Theme Description - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - count - - yaml -\--- - -### EXAMPLES - - $ wp theme search photo --per-page=6 - Success: Showing 6 of 203 themes. - +----------------------+----------------------+--------+ - | name | slug | rating | - +----------------------+----------------------+--------+ - | Photos | photos | 100 | - | Infinite Photography | infinite-photography | 100 | - | PhotoBook | photobook | 100 | - | BG Photo Frame | bg-photo-frame | 0 | - | fPhotography | fphotography | 0 | - | Photo Perfect | photo-perfect | 98 | - +----------------------+----------------------+--------+ - - - diff --git a/commands/theme/status/index.md b/commands/theme/status/index.md deleted file mode 100644 index 4f27d1a3..00000000 --- a/commands/theme/status/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp theme status' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » status - -`wp theme status` - See the status of one or all themes. - -Quick links: Github issues - -
- -### OPTIONS - -[<theme>] -: A particular theme to show the status for. - -### EXAMPLES - - $ wp theme status twentysixteen - Theme twentysixteen details: - Name: Twenty Sixteen - Status: Inactive - Version: 1.2 - Author: the WordPress team - - - diff --git a/commands/theme/update-all/index.md b/commands/theme/update-all/index.md deleted file mode 100644 index 291ec545..00000000 --- a/commands/theme/update-all/index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -layout: default -title: 'wp theme update-all' ---- - -`wp theme update-all` is an alias for [wp theme update --all](/commands/theme/update/). diff --git a/commands/theme/update/index.md b/commands/theme/update/index.md deleted file mode 100644 index 9816da6c..00000000 --- a/commands/theme/update/index.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -layout: default -title: 'wp theme update' -display_global_parameters: true ---- - -[Commands](/commands/) » [theme](/commands/theme/) » update - -`wp theme update` - Update one or more themes. - -Quick links: Github issues - -
- -### OPTIONS - -[<theme>...] -: One or more themes to update. - -[\--all] -: If set, all themes that have updates will be updated. - -[\--format=<format>] -: Output summary as table or summary. Defaults to table. - -[\--version=<version>] -: If set, the theme will be updated to the specified version. - -[\--dry-run] -: Preview which themes would be updated. - -### EXAMPLES - - # Update multiple themes - $ wp theme update twentyfifteen twentysixteen - Downloading update from https://downloads.wordpress.org/theme/twentyfifteen.1.5.zip... - Unpacking the update... - Installing the latest version... - Removing the old version of the theme... - Theme updated successfully. - Downloading update from https://downloads.wordpress.org/theme/twentysixteen.1.2.zip... - Unpacking the update... - Installing the latest version... - Removing the old version of the theme... - Theme updated successfully. - +---------------+-------------+-------------+---------+ - | name | old_version | new_version | status | - +---------------+-------------+-------------+---------+ - | twentyfifteen | 1.4 | 1.5 | Updated | - | twentysixteen | 1.1 | 1.2 | Updated | - +---------------+-------------+-------------+---------+ - Success: Updated 2 of 2 themes. - - # Update all themes - $ wp theme update --all - - - diff --git a/commands/transient/delete/index.md b/commands/transient/delete/index.md deleted file mode 100644 index d6ac4984..00000000 --- a/commands/transient/delete/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -layout: default -title: 'wp transient delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [transient](/commands/transient/) » delete - -`wp transient delete` - Delete a transient value. - -Quick links: Github issues - -
- -### OPTIONS - -[<key>] -: Key for the transient. - -[\--network] -: Delete the value of a network transient, instead of that on a single site. - -[\--all] -: Delete all transients. - -[\--expired] -: Delete all expired transients. - -### EXAMPLES - - # Delete transient. - $ wp transient delete sample_key - Success: Transient deleted. - - # Delete expired transients. - $ wp transient delete --expired - Success: 12 expired transients deleted from the database. - - # Delete all transients. - $ wp transient delete --all - Success: 14 transients deleted from the database. - - - diff --git a/commands/transient/get/index.md b/commands/transient/get/index.md deleted file mode 100644 index 8db11a7f..00000000 --- a/commands/transient/get/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp transient get' -display_global_parameters: true ---- - -[Commands](/commands/) » [transient](/commands/transient/) » get - -`wp transient get` - Get a transient value. - -Quick links: Github issues - -
- -### OPTIONS - -<key> -: Key for the transient. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - yaml -\--- - -[\--network] -: Get the value of the network transient, instead of the single site. - -### EXAMPLES - - $ wp transient get sample_key - test data - - $ wp transient get random_key - Warning: Transient with key "random_key" is not set. - - - diff --git a/commands/transient/index.md b/commands/transient/index.md deleted file mode 100644 index ee40886e..00000000 --- a/commands/transient/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -layout: default -title: 'wp transient' -display_global_parameters: true ---- - -[Commands](/commands/) » transient - -`wp transient` - Manage transients. - -Quick links: Github issues - -
- -### EXAMPLES - - # Set transient. - $ wp transient set sample_key "test data" 3600 - Success: Transient added. - - # Get transient. - $ wp transient get sample_key - test data - - # Delete transient. - $ wp transient delete sample_key - Success: Transient deleted. - - # Delete expired transients. - $ wp transient delete --expired - Success: 12 expired transients deleted from the database. - - # Delete all transients. - $ wp transient delete --all - Success: 14 transients deleted from the database. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
deleteDelete a transient value.
getGet a transient value.
setSet a transient value.
typeDetermine type of transients implementation.
diff --git a/commands/transient/set/index.md b/commands/transient/set/index.md deleted file mode 100644 index 7e347385..00000000 --- a/commands/transient/set/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -layout: default -title: 'wp transient set' -display_global_parameters: true ---- - -[Commands](/commands/) » [transient](/commands/transient/) » set - -`wp transient set` - Set a transient value. - -Quick links: Github issues - -
- -`<expiration>` is the time until expiration, in seconds. - -### OPTIONS - -<key> -: Key for the transient. - -<value> -: Value to be set for the transient. - -[<expiration>] -: Time until expiration, in seconds. - -[\--network] -: Set the transient value on the network, instead of single site. - -### EXAMPLES - - $ wp transient set sample_key "test data" 3600 - Success: Transient added. - - - diff --git a/commands/transient/type/index.md b/commands/transient/type/index.md deleted file mode 100644 index 083f3203..00000000 --- a/commands/transient/type/index.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: default -title: 'wp transient type' -display_global_parameters: true ---- - -[Commands](/commands/) » [transient](/commands/transient/) » type - -`wp transient type` - Determine type of transients implementation. - -Quick links: Github issues - -
- -Indicates whether the transients API is using an object cache or the -options table. - -### EXAMPLES - - $ wp transient type - Transients are saved to the wp_options table. - - - diff --git a/commands/user/add-cap/index.md b/commands/user/add-cap/index.md deleted file mode 100644 index 2ab8daa0..00000000 --- a/commands/user/add-cap/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -layout: default -title: 'wp user add-cap' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » add-cap - -`wp user add-cap` - Add a capability to a user. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -<cap> -: The capability to add. - -### EXAMPLES - - # Add a capability for a user - $ wp user add-cap john create_premium_item - Success: Added 'create_premium_item' capability for john (16). - - # Add a capability for a user - $ wp user add-cap 15 edit_product - Success: Added 'edit_product' capability for johndoe (15). - - - diff --git a/commands/user/add-role/index.md b/commands/user/add-role/index.md deleted file mode 100644 index 9cc45321..00000000 --- a/commands/user/add-role/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp user add-role' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » add-role - -`wp user add-role` - Add a role for a user. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -<role> -: Add the specified role to the user. - -### EXAMPLES - - $ wp user add-role 12 author - Success: Added 'author' role for johndoe (12). - - - diff --git a/commands/user/create/index.md b/commands/user/create/index.md deleted file mode 100644 index dea27afd..00000000 --- a/commands/user/create/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: default -title: 'wp user create' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » create - -`wp user create` - Create a new user. - -Quick links: Github issues - -
- -### OPTIONS - -<user-login> -: The login of the user to create. - -<user-email> -: The email address of the user to create. - -[\--role=<role>] -: The role of the user to create. Default: default role - -[\--user_pass=<password>] -: The user password. Default: randomly generated - -[\--user_registered=<yyyy-mm-dd>] -: The date the user registered. Default: current date - -[\--display_name=<name>] -: The display name. - -[\--first_name=<first_name>] -: The user's first name. - -[\--last_name=<last_name>] -: The user's last name. - -[\--send-email] -: Send an email to the user with their new account details. - -[\--porcelain] -: Output just the new user id. - -### EXAMPLES - - # Create user - $ wp user create bob bob@example.com --role=author - Success: Created user 3. - Password: k9**&I4vNH(& - - - diff --git a/commands/user/delete/index.md b/commands/user/delete/index.md deleted file mode 100644 index 05ee4053..00000000 --- a/commands/user/delete/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: default -title: 'wp user delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » delete - -`wp user delete` - Delete one or more users from the current site. - -Quick links: Github issues - -
- -On multisite, `wp user delete` only removes the user from the current -site. Include `--network` to also remove the user from the database, but -make sure to reassign their posts prior to deleting the user. - -### OPTIONS - -<user>... -: The user login, user email, or user ID of the user(s) to delete. - -[\--network] -: On multisite, delete the user from the entire network. - -[\--reassign=<user-id>] -: User ID to reassign the posts to. - -[\--yes] -: Answer yes to any confirmation prompts. - -### EXAMPLES - - # Delete user 123 and reassign posts to user 567 - $ wp user delete 123 --reassign=567 - Success: Removed user 123 from http://example.com - - # Delete all contributors and reassign their posts to user 2 - $ wp user delete $(wp user list --role=contributor --field=ID) --reassign=2 - Success: Removed user 813 from http://example.com - Success: Removed user 578 from http://example.com - - - diff --git a/commands/user/generate/index.md b/commands/user/generate/index.md deleted file mode 100644 index 76aa06de..00000000 --- a/commands/user/generate/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: 'wp user generate' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » generate - -`wp user generate` - Generate some users. - -Quick links: Github issues - -
- -Creates a specified number of new users with dummy data. - -### OPTIONS - -[\--count=<number>] -: How many users to generate? -\--- -default: 100 -\--- - -[\--role=<role>] -: The role of the generated users. Default: default role from WP - -[\--format=<format>] -: Render output in a particular format. -\--- -default: progress -options: - - progress - - ids -\--- - -### EXAMPLES - - # Add meta to every generated users. - $ wp user generate --format=ids --count=3 | xargs -d ' ' -I % wp user meta add % foo bar - Success: Added custom field. - Success: Added custom field. - Success: Added custom field. - - - diff --git a/commands/user/get/index.md b/commands/user/get/index.md deleted file mode 100644 index 90b8aeb1..00000000 --- a/commands/user/get/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -layout: default -title: 'wp user get' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » get - -`wp user get` - Get details about a user. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -[\--field=<field>] -: Instead of returning the whole user, returns the value of a single field. - -[\--fields=<fields>] -: Get a specific subset of the user's fields. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - yaml -\--- - -### EXAMPLES - - # Get user - $ wp user get 12 --field=login - supervisor - - # Get user and export to JSON file - $ wp user get bob --format=json > bob.json - - - diff --git a/commands/user/import-csv/index.md b/commands/user/import-csv/index.md deleted file mode 100644 index 961ab1c6..00000000 --- a/commands/user/import-csv/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -layout: default -title: 'wp user import-csv' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » import-csv - -`wp user import-csv` - Import users from a CSV file. - -Quick links: Github issues - -
- -If the user already exists (matching the email address or login), then -the user is updated unless the `--skip-update` flag is used. - -### OPTIONS - -<file> -: The local or remote CSV file of users to import. - -[\--send-email] -: Send an email to new users with their account details. - -[\--skip-update] -: Don't update users that already exist. - -### EXAMPLES - - # Import users from local CSV file - $ wp user import-csv /path/to/users.csv - Success: bobjones created - Success: newuser1 created - Success: existinguser created - - # Import users from remote CSV file - $ wp user import-csv http://example.com/users.csv - - Sample users.csv file: - - user_login,user_email,display_name,role - bobjones,bobjones@example.com,Bob Jones,contributor - newuser1,newuser1@example.com,New User,author - existinguser,existinguser@example.com,Existing User,administrator - - - diff --git a/commands/user/index.md b/commands/user/index.md deleted file mode 100644 index abd676dc..00000000 --- a/commands/user/index.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -layout: default -title: 'wp user' -display_global_parameters: true ---- - -[Commands](/commands/) » user - -`wp user` - Manage users. - -Quick links: Github issues - -
- -### EXAMPLES - - # List user IDs - $ wp user list --field=ID - 1 - - # Create a new user. - $ wp user create bob bob@example.com --role=author - Success: Created user 3. - Password: k9**&I4vNH(& - - # Update an existing user. - $ wp user update 123 --display_name=Mary --user_pass=marypass - Success: Updated user 123. - - # Delete user 123 and reassign posts to user 567 - $ wp user delete 123 --reassign=567 - Success: Removed user 123 from http://example.com - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
add-capAdd a capability to a user.
add-roleAdd a role for a user.
createCreate a new user.
deleteDelete one or more users from the current site.
generateGenerate some users.
getGet details about a user.
import-csvImport users from a CSV file.
listList users.
list-capsList all capabilities for a user.
metaManage user custom fields.
remove-capRemove a user's capability.
remove-roleRemove a user's role.
sessionManage a user's sessions.
set-roleSet the user role.
termManage user terms.
updateUpdate an existing user.
diff --git a/commands/user/list-caps/index.md b/commands/user/list-caps/index.md deleted file mode 100644 index 773b37c0..00000000 --- a/commands/user/list-caps/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: default -title: 'wp user list-caps' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » list-caps - -`wp user list-caps` - List all capabilities for a user. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or login. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: list -options: - - list - - table - - csv - - json - - count - - yaml -\--- - -### EXAMPLES - - $ wp user list-caps 21 - edit_product - create_premium_item - - - diff --git a/commands/user/list/index.md b/commands/user/list/index.md deleted file mode 100644 index 58426cf1..00000000 --- a/commands/user/list/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -layout: default -title: 'wp user list' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » list - -`wp user list` - List users. - -Quick links: Github issues - -
- -### OPTIONS - -[\--role=<role>] -: Only display users with a certain role. - -[\--<field>=<value>] -: Control output by one or more arguments of get_users(). - -[\--network] -: List all users in the network for multisite. - -[\--field=<field>] -: Prints the value of a single field for each user. - -[\--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 user: - -* ID -* user_login -* display_name -* user_email -* user_registered -* roles - -These fields are optionally available: - -* user_pass -* user_nicename -* user_url -* user_activation_key -* user_status -* spam -* deleted -* caps -* cap_key -* allcaps -* filter -* url - -### EXAMPLES - - # List user IDs - $ wp user list --field=ID - 1 - - # List users with administrator role - $ wp user list --role=administrator --format=csv - ID,user_login,display_name,user_email,user_registered,roles - 1,supervisor,supervisor,supervisor@gmail.com,"2016-06-03 04:37:00",administrator - - # List users with only given fields - $ wp user list --fields=display_name,user_email --format=json - [{"display_name":"supervisor","user_email":"supervisor@gmail.com"}] - - - diff --git a/commands/user/meta/add/index.md b/commands/user/meta/add/index.md deleted file mode 100644 index c3dfbb24..00000000 --- a/commands/user/meta/add/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp user meta add' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [meta](/commands/user/meta/) » add - -`wp user meta add` - Add a meta field. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: The user login, user email, or user ID of the user to add metadata for. - -<key> -: The metadata key. - -<value> -: The new metadata value. - -[\--format=<format>] -: The serialization format for the value. Default is plaintext. - -### EXAMPLES - - # Add user meta - $ wp user meta add 123 bio "Mary is an WordPress developer." - Success: Added custom field. - - - diff --git a/commands/user/meta/delete/index.md b/commands/user/meta/delete/index.md deleted file mode 100644 index 195c07b9..00000000 --- a/commands/user/meta/delete/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: default -title: 'wp user meta delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [meta](/commands/user/meta/) » delete - -`wp user meta delete` - Delete a meta field. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: The user login, user email, or user ID of the user to delete metadata from. - -<key> -: The metadata key. - -[<value>] -: The value to delete. If omitted, all rows with key will deleted. - -### EXAMPLES - - # Delete user meta - $ wp user meta delete 123 bio - Success: Deleted custom field. - - - diff --git a/commands/user/meta/get/index.md b/commands/user/meta/get/index.md deleted file mode 100644 index fc728092..00000000 --- a/commands/user/meta/get/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -layout: default -title: 'wp user meta get' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [meta](/commands/user/meta/) » get - -`wp user meta get` - Get meta field value. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: The user login, user email, or user ID of the user to get metadata for. - -<key> -: The metadata key. - -[\--format=<format>] -: Render output in a particular format. -\--- -default: table -options: - - table - - csv - - json - - yaml -\--- - -### EXAMPLES - - # Get user meta - $ wp user meta get 123 bio - Mary is an WordPress developer. - - - diff --git a/commands/user/meta/index.md b/commands/user/meta/index.md deleted file mode 100644 index 6c6fdba4..00000000 --- a/commands/user/meta/index.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -layout: default -title: 'wp user meta' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » meta - -`wp user meta` - Manage user custom fields. - -Quick links: Github issues - -
- -### EXAMPLES - - # Add user meta - $ wp user meta add 123 bio "Mary is an WordPress developer." - Success: Added custom field. - - # List user meta - $ wp user meta list 123 --keys=nickname,description,wp_capabilities - +---------+-----------------+--------------------------------+ - | user_id | meta_key | meta_value | - +---------+-----------------+--------------------------------+ - | 123 | nickname | supervisor | - | 123 | description | Mary is a WordPress developer. | - | 123 | wp_capabilities | {"administrator":true} | - +---------+-----------------+--------------------------------+ - - # Update user meta - $ wp user meta update 123 bio "Mary is an awesome WordPress developer." - Success: Updated custom field 'bio'. - - # Delete user meta - $ wp user meta delete 123 bio - Success: Deleted custom field. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a meta field.
deleteDelete a meta field.
getGet meta field value.
listList all metadata associated with a user.
updateUpdate a meta field.
diff --git a/commands/user/meta/list/index.md b/commands/user/meta/list/index.md deleted file mode 100644 index e8d25bed..00000000 --- a/commands/user/meta/list/index.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -layout: default -title: 'wp user meta list' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [meta](/commands/user/meta/) » list - -`wp user meta list` - List all metadata associated with a user. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: The user login, user email, or user ID of the user to get metadata for. - -[\--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 - - count - - yaml -\--- - -### EXAMPLES - - # List user meta - $ wp user meta list 123 --keys=nickname,description,wp_capabilities - +---------+-----------------+--------------------------------+ - | user_id | meta_key | meta_value | - +---------+-----------------+--------------------------------+ - | 123 | nickname | supervisor | - | 123 | description | Mary is a WordPress developer. | - | 123 | wp_capabilities | {"administrator":true} | - +---------+-----------------+--------------------------------+ - - - diff --git a/commands/user/meta/update/index.md b/commands/user/meta/update/index.md deleted file mode 100644 index fe7dc68a..00000000 --- a/commands/user/meta/update/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -layout: default -title: 'wp user meta update' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [meta](/commands/user/meta/) » update - -`wp user meta update` - Update a meta field. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: The user login, user email, or user ID of the user to update metadata for. - -<key> -: The metadata key. - -<value> -: The new metadata value. - -[\--format=<format>] -: The serialization format for the value. Default is plaintext. - -### EXAMPLES - - # Update user meta - $ wp user meta update 123 bio "Mary is an awesome WordPress developer." - Success: Updated custom field 'bio'. - - - diff --git a/commands/user/remove-cap/index.md b/commands/user/remove-cap/index.md deleted file mode 100644 index d5999b50..00000000 --- a/commands/user/remove-cap/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp user remove-cap' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » remove-cap - -`wp user remove-cap` - Remove a user's capability. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -<cap> -: The capability to be removed. - -### EXAMPLES - - $ wp user remove-cap 11 publish_newsletters - Success: Removed 'publish_newsletters' cap for supervisor (11). - - - diff --git a/commands/user/remove-role/index.md b/commands/user/remove-role/index.md deleted file mode 100644 index c273039f..00000000 --- a/commands/user/remove-role/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp user remove-role' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » remove-role - -`wp user remove-role` - Remove a user's role. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -[<role>] -: A specific role to remove. - -### EXAMPLES - - $ wp user remove-role 12 author - Success: Removed 'author' role for johndoe (12). - - - diff --git a/commands/user/session/destroy/index.md b/commands/user/session/destroy/index.md deleted file mode 100644 index 08acfd69..00000000 --- a/commands/user/session/destroy/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -layout: default -title: 'wp user session destroy' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [session](/commands/user/session/) » destroy - -`wp user session destroy` - Destroy a session for the given user. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -[<token>] -: The token of the session to destroy. Defaults to the most recently created session. - -[\--all] -: Destroy all of the user's sessions. - -### EXAMPLES - - # Destroy the most recent session of the given user. - $ wp user session destroy admin - Success: Destroyed session. 3 sessions remaining. - - # Destroy a specific session of the given user. - $ wp user session destroy admin e073ad8540a9c2... - Success: Destroyed session. 2 sessions remaining. - - # Destroy all the sessions of the given user. - $ wp user session destroy admin --all - Success: Destroyed all sessions. - - # Destroy all sessions for all users. - $ wp user list --field=ID | xargs wp user session destroy --all - Success: Destroyed all sessions. - Success: Destroyed all sessions. - - - diff --git a/commands/user/session/index.md b/commands/user/session/index.md deleted file mode 100644 index cefad863..00000000 --- a/commands/user/session/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: default -title: 'wp user session' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » session - -`wp user session` - Manage a user's sessions. - -Quick links: Github issues - -
- -### EXAMPLES - - # List a user's sessions. - $ wp user session list admin@example.com --format=csv - login_time,expiration_time,ip,ua - "2016-01-01 12:34:56","2016-02-01 12:34:56",127.0.0.1,"Mozilla/5.0..." - - # Destroy the most recent session of the given user. - $ wp user session destroy admin - Success: Destroyed session. 3 sessions remaining. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - -
NameDescription
destroyDestroy a session for the given user.
listList sessions for the given user.
diff --git a/commands/user/session/list/index.md b/commands/user/session/list/index.md deleted file mode 100644 index 81890745..00000000 --- a/commands/user/session/list/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -layout: default -title: 'wp user session list' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [session](/commands/user/session/) » list - -`wp user session list` - List sessions for the given user. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -[\--fields=<fields>] -: Limit the output to specific 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 session: - -* token -* login_time -* expiration_time -* ip -* ua - -These fields are optionally available: - -* expiration -* login - -### EXAMPLES - - # List a user's sessions. - $ wp user session list admin@example.com --format=csv - login_time,expiration_time,ip,ua - "2016-01-01 12:34:56","2016-02-01 12:34:56",127.0.0.1,"Mozilla/5.0..." - - - diff --git a/commands/user/set-role/index.md b/commands/user/set-role/index.md deleted file mode 100644 index 7db0071b..00000000 --- a/commands/user/set-role/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp user set-role' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » set-role - -`wp user set-role` - Set the user role. - -Quick links: Github issues - -
- -### OPTIONS - -<user> -: User ID, user email, or user login. - -[<role>] -: Make the user have the specified role. If not passed, the default role is -used. - -### EXAMPLES - - $ wp user set-role 12 author - Success: Added johndoe (12) to http://example.com as author. - - - diff --git a/commands/user/term/add/index.md b/commands/user/term/add/index.md deleted file mode 100644 index f8a43397..00000000 --- a/commands/user/term/add/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp user term add' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [term](/commands/user/term/) » add - -`wp user term add` - Add a term to an object. - -Quick links: Github issues - -
- -Append the term to the existing set of terms on the object. - -<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. - - - diff --git a/commands/user/term/index.md b/commands/user/term/index.md deleted file mode 100644 index 22805c67..00000000 --- a/commands/user/term/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -layout: default -title: 'wp user term' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » term - -`wp user term` - Manage user terms. - -Quick links: Github issues - -
- -### EXAMPLES - - # Set user terms - $ wp user term set 123 test category - Success: Set terms. - - - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a term to an object.
listList all terms associated with an object.
removeRemove a term from an object.
setSet object terms.
diff --git a/commands/user/term/list/index.md b/commands/user/term/list/index.md deleted file mode 100644 index d0b19e68..00000000 --- a/commands/user/term/list/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: default -title: 'wp user term list' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [term](/commands/user/term/) » list - -`wp user term list` - List all terms associated with an object. - -Quick links: Github issues - -
- -<id> -: ID for the object. - -<taxonomy>... -: One or more taxonomies to list. - -[\--fields=<fields>] -: Limit the output to specific row fields. - -[\--format=<format>] -: Accepted values: table, csv, json, count, ids. Default: table - -### 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 - - - diff --git a/commands/user/term/remove/index.md b/commands/user/term/remove/index.md deleted file mode 100644 index c2b2537f..00000000 --- a/commands/user/term/remove/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: 'wp user term remove' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [term](/commands/user/term/) » remove - -`wp user term remove` - Remove a term from an object. - -Quick links: Github issues - -
- -<id> -: The ID of the object. - -<taxonomy> -: The name of the term's taxonomy. - -<term>... -: The name of the term or terms to be removed from the object. - - - diff --git a/commands/user/term/set/index.md b/commands/user/term/set/index.md deleted file mode 100644 index fd17593b..00000000 --- a/commands/user/term/set/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp user term set' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » [term](/commands/user/term/) » set - -`wp user term set` - Set object terms. - -Quick links: Github issues - -
- -Replaces existing terms on the object. - -<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. - - - diff --git a/commands/user/update/index.md b/commands/user/update/index.md deleted file mode 100644 index de37dd77..00000000 --- a/commands/user/update/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp user update' -display_global_parameters: true ---- - -[Commands](/commands/) » [user](/commands/user/) » update - -`wp user update` - Update an existing user. - -Quick links: Github issues - -
- -### OPTIONS - -<user>... -: The user login, user email or user ID of the user(s) to update. - -\--<field>=<value> -: One or more fields to update. For accepted fields, see wp_update_user(). - -### EXAMPLES - - # Update user - $ wp user update 123 --display_name=Mary --user_pass=marypass - Success: Updated user 123. - - - diff --git a/commands/widget/add/index.md b/commands/widget/add/index.md deleted file mode 100644 index 2ca5b43b..00000000 --- a/commands/widget/add/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -layout: default -title: 'wp widget add' -display_global_parameters: true ---- - -[Commands](/commands/) » [widget](/commands/widget/) » add - -`wp widget add` - Add a widget to a sidebar. - -Quick links: Github issues - -
- -Creates a new widget entry in the database, and associates it with the -sidebar. - -### OPTIONS - -<name> -: Widget name. - -<sidebar-id> -: ID for the corresponding sidebar. - -[<position>] -: Widget's current position within the sidebar. Defaults to last - -[\--<field>=<value>] -: Widget option to add, with its new value - -### EXAMPLES - - # Add a new calendar widget to sidebar-1 with title "Calendar" - $ wp widget add calendar sidebar-1 2 --title="Calendar" - Success: Added widget to sidebar. - - - diff --git a/commands/widget/deactivate/index.md b/commands/widget/deactivate/index.md deleted file mode 100644 index 3c809aa3..00000000 --- a/commands/widget/deactivate/index.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -layout: default -title: 'wp widget deactivate' -display_global_parameters: true ---- - -[Commands](/commands/) » [widget](/commands/widget/) » deactivate - -`wp widget deactivate` - Deactivate one or more widgets from an active sidebar. - -Quick links: Github issues - -
- -Moves widgets to Inactive Widgets. - -### OPTIONS - -<widget-id>... -: Unique ID for the widget(s) - -### EXAMPLES - - # Deactivate the recent-comments-2 widget. - $ wp widget deactivate recent-comments-2 - Success: 1 widget deactivated. - - - diff --git a/commands/widget/delete/index.md b/commands/widget/delete/index.md deleted file mode 100644 index 575d9300..00000000 --- a/commands/widget/delete/index.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: default -title: 'wp widget delete' -display_global_parameters: true ---- - -[Commands](/commands/) » [widget](/commands/widget/) » delete - -`wp widget delete` - Delete one or more widgets from a sidebar. - -Quick links: Github issues - -
- -### OPTIONS - -<widget-id>... -: Unique ID for the widget(s) - -### EXAMPLES - - # Delete the recent-comments-2 widget from its sidebar. - $ wp widget delete recent-comments-2 - Success: Deleted 1 of 1 widgets. - - - diff --git a/commands/widget/index.md b/commands/widget/index.md deleted file mode 100644 index 3e813049..00000000 --- a/commands/widget/index.md +++ /dev/null @@ -1,79 +0,0 @@ ---- -layout: default -title: 'wp widget' -display_global_parameters: true ---- - -[Commands](/commands/) » widget - -`wp widget` - Manage sidebar widgets. - -Quick links: Github issues - -
- -### EXAMPLES - - # List widgets on a given sidebar - $ wp widget list sidebar-1 - +----------+------------+----------+----------------------+ - | name | id | position | options | - +----------+------------+----------+----------------------+ - | meta | meta-6 | 1 | {"title":"Meta"} | - | calendar | calendar-2 | 2 | {"title":"Calendar"} | - +----------+------------+----------+----------------------+ - - # Add a calendar widget to the second position on the sidebar - $ wp widget add calendar sidebar-1 2 - Success: Added widget to sidebar. - - # Update option(s) associated with a given widget - $ wp widget update calendar-1 --title="Calendar" - Success: Widget updated. - - # Delete one or more widgets entirely - $ wp widget delete calendar-2 archive-1 - Success: 2 widgets removed from sidebar. - - - -### SUBCOMMANDS - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
addAdd a widget to a sidebar.
deactivateDeactivate one or more widgets from an active sidebar.
deleteDelete one or more widgets from a sidebar.
listList widgets associated with a sidebar.
moveMove the position of a widget.
resetReset sidebar.
updateUpdate options for an existing widget.
diff --git a/commands/widget/list/index.md b/commands/widget/list/index.md deleted file mode 100644 index f56f455e..00000000 --- a/commands/widget/list/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: default -title: 'wp widget list' -display_global_parameters: true ---- - -[Commands](/commands/) » [widget](/commands/widget/) » list - -`wp widget list` - List widgets associated with a sidebar. - -Quick links: Github issues - -
- -### OPTIONS - -<sidebar-id> -: ID for the corresponding sidebar. - -[\--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 widget: - -* name -* id -* position -* options - -There are no optionally available fields. - -### EXAMPLES - - $ wp widget list sidebar-1 --fields=name,id --format=csv - name,id - meta,meta-5 - search,search-3 - - - diff --git a/commands/widget/move/index.md b/commands/widget/move/index.md deleted file mode 100644 index 072dda9c..00000000 --- a/commands/widget/move/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -layout: default -title: 'wp widget move' -display_global_parameters: true ---- - -[Commands](/commands/) » [widget](/commands/widget/) » move - -`wp widget move` - Move the position of a widget. - -Quick links: Github issues - -
- -Changes the order of a widget in its existing sidebar, or moves it to a -new sidebar. - -### OPTIONS - -<widget-id> -: Unique ID for the widget - -[\--position=<position>] -: Assign the widget to a new position. - -[\--sidebar-id=<sidebar-id>] -: Assign the widget to a new sidebar - -### EXAMPLES - - # Change position of widget - $ wp widget move recent-comments-2 --position=2 - Success: Widget moved. - - # Move widget to Inactive Widgets - $ wp widget move recent-comments-2 --sidebar-id=wp_inactive_widgets - Success: Widget moved. - - - diff --git a/commands/widget/reset/index.md b/commands/widget/reset/index.md deleted file mode 100644 index 43ebe40f..00000000 --- a/commands/widget/reset/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -layout: default -title: 'wp widget reset' -display_global_parameters: true ---- - -[Commands](/commands/) » [widget](/commands/widget/) » reset - -`wp widget reset` - Reset sidebar. - -Quick links: Github issues - -
- -Removes all widgets from the sidebar and places them in Inactive Widgets. - -### OPTIONS - -[<sidebar-id>...] -: One or more sidebars to reset. - -[\--all] -: If set, all sidebars will be reset. - -### EXAMPLES - - # Reset a sidebar - $ wp widget reset sidebar-1 - Success: Sidebar 'sidebar-1' reset. - - # Reset multiple sidebars - $ wp widget reset sidebar-1 sidebar-2 - Success: Sidebar 'sidebar-1' reset. - Success: Sidebar 'sidebar-2' reset. - - # Reset all sidebars - $ wp widget reset --all - Success: Sidebar 'sidebar-1' reset. - Success: Sidebar 'sidebar-2' reset. - Success: Sidebar 'sidebar-3' reset. - - - diff --git a/commands/widget/update/index.md b/commands/widget/update/index.md deleted file mode 100644 index c00eacb7..00000000 --- a/commands/widget/update/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: default -title: 'wp widget update' -display_global_parameters: true ---- - -[Commands](/commands/) » [widget](/commands/widget/) » update - -`wp widget update` - Update options for an existing widget. - -Quick links: Github issues - -
- -### OPTIONS - -<widget-id> -: Unique ID for the widget - -[\--<field>=<value>] -: Field to update, with its new value - -### EXAMPLES - - # Change calendar-1 widget title to "Our Calendar" - $ wp widget update calendar-1 --title="Our Calendar" - Success: Widget updated. - - -