From f69ffb17670bd915cc8117f7291ec3a11d79645b Mon Sep 17 00:00:00 2001 From: Alain Schlesser Date: Wed, 8 Aug 2018 21:32:33 +0200 Subject: [PATCH] Add changes for version 2.0.0 --- bin/commands-manifest.json | 264 ++++++++++++++++++ bin/handbook-manifest.json | 14 +- commands/admin.md | 6 +- commands/cache/add.md | 6 +- commands/cache/decr.md | 6 +- commands/cache/delete.md | 6 +- commands/cache/flush.md | 6 +- commands/cache/get.md | 6 +- commands/cache/incr.md | 6 +- commands/cache/replace.md | 6 +- commands/cache/set.md | 6 +- commands/cache/type.md | 6 +- commands/cap/add.md | 15 +- commands/cap/list.md | 12 +- commands/cap/remove.md | 6 +- commands/cli/alias.md | 7 +- commands/cli/check-update.md | 6 +- commands/cli/cmd-dump.md | 6 +- commands/cli/completions.md | 6 +- commands/cli/has-command.md | 6 +- commands/cli/info.md | 6 +- commands/cli/param-dump.md | 6 +- commands/cli/update.md | 6 +- commands/cli/version.md | 6 +- commands/comment/approve.md | 6 +- commands/comment/count.md | 6 +- commands/comment/create.md | 6 +- commands/comment/delete.md | 6 +- commands/comment/exists.md | 6 +- commands/comment/generate.md | 6 +- commands/comment/get.md | 6 +- commands/comment/list.md | 6 +- commands/comment/meta/add.md | 6 +- commands/comment/meta/delete.md | 6 +- commands/comment/meta/get.md | 15 +- commands/comment/meta/list.md | 17 +- commands/comment/meta/patch.md | 6 +- commands/comment/meta/pluck.md | 6 +- commands/comment/meta/update.md | 6 +- commands/comment/recount.md | 6 +- commands/comment/spam.md | 6 +- commands/comment/status.md | 6 +- commands/comment/trash.md | 6 +- commands/comment/unapprove.md | 6 +- commands/comment/unspam.md | 6 +- commands/comment/untrash.md | 6 +- commands/comment/update.md | 6 +- commands/config/create.md | 6 +- commands/config/delete.md | 6 +- commands/config/edit.md | 31 ++ commands/config/get.md | 6 +- commands/config/has.md | 6 +- commands/config/list.md | 6 +- commands/config/path.md | 6 +- commands/config/set.md | 6 +- commands/config/shuffle-salts.md | 31 ++ commands/core/check-update.md | 6 +- commands/core/download.md | 6 +- commands/core/install.md | 6 +- commands/core/is-installed.md | 6 +- commands/core/multisite-convert.md | 6 +- commands/core/multisite-install.md | 6 +- commands/core/update-db.md | 6 +- commands/core/update.md | 6 +- commands/core/verify-checksums.md | 6 +- commands/core/version.md | 6 +- commands/cron/event/delete.md | 6 +- commands/cron/event/list.md | 6 +- commands/cron/event/run.md | 6 +- commands/cron/event/schedule.md | 6 +- commands/cron/schedule/list.md | 6 +- commands/cron/test.md | 6 +- commands/db/check.md | 6 +- commands/db/clean.md | 42 +++ commands/db/cli.md | 6 +- commands/db/columns.md | 70 +++++ commands/db/create.md | 6 +- commands/db/drop.md | 6 +- commands/db/export.md | 14 +- commands/db/import.md | 6 +- commands/db/optimize.md | 6 +- commands/db/prefix.md | 6 +- commands/db/query.md | 6 +- commands/db/repair.md | 6 +- commands/db/reset.md | 6 +- commands/db/search.md | 6 +- commands/db/size.md | 15 +- commands/db/tables.md | 6 +- commands/dist-archive.md | 6 +- commands/embed/cache/clear.md | 6 +- commands/embed/cache/find.md | 6 +- commands/embed/cache/trigger.md | 6 +- commands/embed/fetch.md | 6 +- commands/embed/handler/list.md | 6 +- commands/embed/provider/list.md | 6 +- commands/embed/provider/match.md | 6 +- commands/eval-file.md | 8 +- commands/eval.md | 6 +- commands/export.md | 6 +- commands/find.md | 6 +- commands/help.md | 6 +- commands/i18n.md | 10 + commands/i18n/make-pot.md | 86 ++++++ commands/import.md | 6 +- commands/language.md | 8 + commands/language/core/activate.md | 6 +- commands/language/core/activate_language.md | 25 ++ commands/language/core/install.md | 6 +- commands/language/core/is-installed.md | 37 +++ commands/language/core/list.md | 6 +- commands/language/core/uninstall.md | 6 +- commands/language/core/update.md | 19 +- commands/language/plugin.md | 23 ++ commands/language/plugin/install.md | 39 +++ commands/language/plugin/is-installed.md | 40 +++ commands/language/plugin/list.md | 78 ++++++ commands/language/plugin/uninstall.md | 36 +++ commands/language/plugin/update.md | 42 +++ commands/language/theme.md | 23 ++ commands/language/theme/install.md | 39 +++ commands/language/theme/is-installed.md | 40 +++ commands/language/theme/list.md | 78 ++++++ commands/language/theme/uninstall.md | 36 +++ commands/language/theme/update.md | 42 +++ commands/media/image-size.md | 6 +- commands/media/import.md | 14 +- commands/media/regenerate.md | 12 +- commands/menu/create.md | 6 +- commands/menu/delete.md | 6 +- commands/menu/item/add-custom.md | 6 +- commands/menu/item/add-post.md | 6 +- commands/menu/item/add-term.md | 6 +- commands/menu/item/delete.md | 6 +- commands/menu/item/list.md | 6 +- commands/menu/item/update.md | 6 +- commands/menu/list.md | 6 +- commands/menu/location/assign.md | 6 +- commands/menu/location/list.md | 6 +- commands/menu/location/remove.md | 6 +- commands/network/meta/add.md | 6 +- commands/network/meta/delete.md | 6 +- commands/network/meta/get.md | 15 +- commands/network/meta/list.md | 17 +- commands/network/meta/patch.md | 6 +- commands/network/meta/pluck.md | 6 +- commands/network/meta/update.md | 6 +- commands/option/add.md | 6 +- commands/option/delete.md | 6 +- commands/option/get.md | 6 +- commands/option/list.md | 9 +- commands/option/patch.md | 6 +- commands/option/pluck.md | 6 +- commands/option/update.md | 6 +- commands/package/browse.md | 6 +- commands/package/install.md | 6 +- commands/package/list.md | 6 +- commands/package/path.md | 6 +- commands/package/uninstall.md | 6 +- commands/package/update.md | 6 +- commands/plugin/activate.md | 6 +- commands/plugin/deactivate.md | 6 +- commands/plugin/delete.md | 11 +- commands/plugin/get.md | 6 +- commands/plugin/install.md | 6 +- commands/plugin/is-active.md | 37 +++ commands/plugin/is-installed.md | 6 +- commands/plugin/list.md | 6 +- commands/plugin/path.md | 6 +- commands/plugin/search.md | 7 +- commands/plugin/status.md | 6 +- commands/plugin/toggle.md | 6 +- commands/plugin/uninstall.md | 11 +- commands/plugin/update.md | 6 +- commands/plugin/verify-checksums.md | 6 +- commands/post-type/get.md | 6 +- commands/post-type/list.md | 6 +- commands/post/create.md | 13 +- commands/post/delete.md | 6 +- commands/post/edit.md | 6 +- commands/post/generate.md | 9 +- commands/post/get.md | 6 +- commands/post/list.md | 6 +- commands/post/meta/add.md | 6 +- commands/post/meta/delete.md | 6 +- commands/post/meta/get.md | 15 +- commands/post/meta/list.md | 17 +- commands/post/meta/patch.md | 6 +- commands/post/meta/pluck.md | 6 +- commands/post/meta/update.md | 6 +- commands/post/term/add.md | 6 +- commands/post/term/list.md | 18 +- commands/post/term/remove.md | 6 +- commands/post/term/set.md | 6 +- commands/post/update.md | 6 +- commands/profile/eval-file.md | 6 +- commands/profile/eval.md | 6 +- commands/profile/hook.md | 6 +- commands/profile/stage.md | 6 +- commands/rewrite/flush.md | 6 +- commands/rewrite/list.md | 6 +- commands/rewrite/structure.md | 6 +- commands/role/create.md | 6 +- commands/role/delete.md | 6 +- commands/role/exists.md | 6 +- commands/role/list.md | 9 +- commands/role/reset.md | 6 +- commands/scaffold/_s.md | 9 +- commands/scaffold/block.md | 6 +- commands/scaffold/child-theme.md | 6 +- commands/scaffold/plugin-tests.md | 9 +- commands/scaffold/plugin.md | 8 +- commands/scaffold/post-type.md | 6 +- commands/scaffold/taxonomy.md | 6 +- commands/scaffold/theme-tests.md | 9 +- commands/search-replace.md | 9 +- commands/server.md | 6 +- commands/shell.md | 8 +- commands/sidebar/list.md | 6 +- commands/site/activate.md | 6 +- commands/site/archive.md | 6 +- commands/site/create.md | 6 +- commands/site/deactivate.md | 6 +- commands/site/delete.md | 6 +- commands/site/empty.md | 6 +- commands/site/list.md | 6 +- commands/site/mature.md | 6 +- commands/site/meta.md | 25 ++ commands/site/meta/add.md | 43 +++ commands/site/meta/delete.md | 37 +++ commands/site/meta/get.md | 41 +++ commands/site/meta/list.md | 65 +++++ commands/site/meta/patch.md | 55 ++++ commands/site/meta/pluck.md | 43 +++ commands/site/meta/update.md | 43 +++ commands/site/option.md | 2 +- commands/site/option/add.md | 6 +- commands/site/option/delete.md | 6 +- commands/site/option/get.md | 6 +- commands/site/option/list.md | 6 +- commands/site/option/patch.md | 6 +- commands/site/option/pluck.md | 6 +- commands/site/option/update.md | 6 +- commands/site/private.md | 6 +- commands/site/public.md | 6 +- commands/site/spam.md | 6 +- commands/site/switch-language.md | 33 +++ commands/site/unarchive.md | 6 +- commands/site/unmature.md | 6 +- commands/site/unspam.md | 6 +- commands/super-admin/add.md | 6 +- commands/super-admin/list.md | 6 +- commands/super-admin/remove.md | 6 +- commands/taxonomy/get.md | 6 +- commands/taxonomy/list.md | 6 +- commands/term/create.md | 6 +- commands/term/delete.md | 6 +- commands/term/generate.md | 6 +- commands/term/get.md | 6 +- commands/term/list.md | 6 +- commands/term/meta/add.md | 6 +- commands/term/meta/delete.md | 6 +- commands/term/meta/get.md | 15 +- commands/term/meta/list.md | 17 +- commands/term/meta/patch.md | 6 +- commands/term/meta/pluck.md | 6 +- commands/term/meta/update.md | 6 +- commands/term/recount.md | 6 +- commands/term/update.md | 6 +- commands/theme/activate.md | 6 +- commands/theme/delete.md | 6 +- commands/theme/disable.md | 6 +- commands/theme/enable.md | 6 +- commands/theme/get.md | 6 +- commands/theme/install.md | 6 +- commands/theme/is-active.md | 37 +++ commands/theme/is-installed.md | 6 +- commands/theme/list.md | 6 +- commands/theme/mod/get.md | 6 +- commands/theme/mod/list.md | 51 ++++ commands/theme/mod/remove.md | 6 +- commands/theme/mod/set.md | 6 +- commands/theme/path.md | 6 +- commands/theme/search.md | 7 +- commands/theme/status.md | 6 +- commands/theme/update.md | 6 +- commands/transient/delete.md | 6 +- commands/transient/get.md | 6 +- commands/transient/set.md | 6 +- commands/transient/type.md | 6 +- commands/user/add-cap.md | 6 +- commands/user/add-role.md | 6 +- commands/user/check-password.md | 43 +++ commands/user/create.md | 9 +- commands/user/delete.md | 6 +- commands/user/generate.md | 6 +- commands/user/get.md | 6 +- commands/user/import-csv.md | 6 +- commands/user/list-caps.md | 6 +- commands/user/list.md | 6 +- commands/user/meta/add.md | 14 +- commands/user/meta/delete.md | 6 +- commands/user/meta/get.md | 6 +- commands/user/meta/list.md | 6 +- commands/user/meta/patch.md | 6 +- commands/user/meta/pluck.md | 6 +- commands/user/meta/update.md | 14 +- commands/user/remove-cap.md | 6 +- commands/user/remove-role.md | 6 +- commands/user/reset-password.md | 6 +- commands/user/session/destroy.md | 6 +- commands/user/session/list.md | 6 +- commands/user/set-role.md | 6 +- commands/user/spam.md | 6 +- commands/user/term/add.md | 6 +- commands/user/term/list.md | 18 +- commands/user/term/remove.md | 6 +- commands/user/term/set.md | 6 +- commands/user/unspam.md | 6 +- commands/user/update.md | 9 +- commands/widget/add.md | 6 +- commands/widget/deactivate.md | 6 +- commands/widget/delete.md | 6 +- commands/widget/list.md | 6 +- commands/widget/move.md | 6 +- commands/widget/reset.md | 6 +- commands/widget/update.md | 6 +- internal-api.md | 3 + internal-api/wp-cli-add-hook.md | 1 + internal-api/wp-cli-get-php-binary.md | 3 + internal-api/wp-cli-utils-get-home-dir.md | 3 + internal-api/wp-cli-utils-get-php-binary.md | 3 + internal-api/wp-cli-utils-get-temp-dir.md | 3 + .../wp-cli-utils-launch-editor-for-input.md | 4 +- internal-api/wp-cli-utils-normalize-path.md | 57 ++++ internal-api/wp-cli-utils-trailingslashit.md | 3 + 335 files changed, 2829 insertions(+), 906 deletions(-) create mode 100644 commands/config/edit.md create mode 100644 commands/config/shuffle-salts.md create mode 100644 commands/db/clean.md create mode 100644 commands/db/columns.md create mode 100644 commands/i18n.md create mode 100644 commands/i18n/make-pot.md create mode 100644 commands/language/core/activate_language.md create mode 100644 commands/language/core/is-installed.md create mode 100644 commands/language/plugin.md create mode 100644 commands/language/plugin/install.md create mode 100644 commands/language/plugin/is-installed.md create mode 100644 commands/language/plugin/list.md create mode 100644 commands/language/plugin/uninstall.md create mode 100644 commands/language/plugin/update.md create mode 100644 commands/language/theme.md create mode 100644 commands/language/theme/install.md create mode 100644 commands/language/theme/is-installed.md create mode 100644 commands/language/theme/list.md create mode 100644 commands/language/theme/uninstall.md create mode 100644 commands/language/theme/update.md create mode 100644 commands/plugin/is-active.md create mode 100644 commands/site/meta.md create mode 100644 commands/site/meta/add.md create mode 100644 commands/site/meta/delete.md create mode 100644 commands/site/meta/get.md create mode 100644 commands/site/meta/list.md create mode 100644 commands/site/meta/patch.md create mode 100644 commands/site/meta/pluck.md create mode 100644 commands/site/meta/update.md create mode 100644 commands/site/switch-language.md create mode 100644 commands/theme/is-active.md create mode 100644 commands/theme/mod/list.md create mode 100644 commands/user/check-password.md create mode 100644 internal-api/wp-cli-utils-normalize-path.md diff --git a/bin/commands-manifest.json b/bin/commands-manifest.json index efe16f05..f5837834 100644 --- a/bin/commands-manifest.json +++ b/bin/commands-manifest.json @@ -127,6 +127,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/help.md", "repo_url": "https:\/\/github.com\/wp-cli\/wp-cli" }, + "i18n": { + "title": "i18n", + "slug": "i18n", + "cmd_path": "i18n", + "parent": null, + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/i18n.md", + "repo_url": "https:\/\/github.com\/wp-cli\/i18n-command" + }, "import": { "title": "import", "slug": "import", @@ -655,6 +663,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/config\/delete.md", "repo_url": "https:\/\/github.com\/wp-cli\/config-command" }, + "config\/edit": { + "title": "config edit", + "slug": "edit", + "cmd_path": "config\/edit", + "parent": "config", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/config\/edit.md", + "repo_url": "https:\/\/github.com\/wp-cli\/config-command" + }, "config\/get": { "title": "config get", "slug": "get", @@ -695,6 +711,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/config\/set.md", "repo_url": "https:\/\/github.com\/wp-cli\/config-command" }, + "config\/shuffle-salts": { + "title": "config shuffle-salts", + "slug": "shuffle-salts", + "cmd_path": "config\/shuffle-salts", + "parent": "config", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/config\/shuffle-salts.md", + "repo_url": "https:\/\/github.com\/wp-cli\/config-command" + }, "core\/check-update": { "title": "core check-update", "slug": "check-update", @@ -807,6 +831,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/db\/check.md", "repo_url": "https:\/\/github.com\/wp-cli\/db-command" }, + "db\/clean": { + "title": "db clean", + "slug": "clean", + "cmd_path": "db\/clean", + "parent": "db", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/db\/clean.md", + "repo_url": "https:\/\/github.com\/wp-cli\/db-command" + }, "db\/cli": { "title": "db cli", "slug": "cli", @@ -815,6 +847,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/db\/cli.md", "repo_url": "https:\/\/github.com\/wp-cli\/db-command" }, + "db\/columns": { + "title": "db columns", + "slug": "columns", + "cmd_path": "db\/columns", + "parent": "db", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/db\/columns.md", + "repo_url": "https:\/\/github.com\/wp-cli\/db-command" + }, "db\/create": { "title": "db create", "slug": "create", @@ -943,6 +983,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/embed\/provider.md", "repo_url": "https:\/\/github.com\/wp-cli\/embed-command" }, + "i18n\/make-pot": { + "title": "i18n make-pot", + "slug": "make-pot", + "cmd_path": "i18n\/make-pot", + "parent": "i18n", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/i18n\/make-pot.md", + "repo_url": "https:\/\/github.com\/wp-cli\/i18n-command" + }, "language\/core": { "title": "language core", "slug": "core", @@ -951,6 +999,22 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/core.md", "repo_url": "https:\/\/github.com\/wp-cli\/language-command" }, + "language\/plugin": { + "title": "language plugin", + "slug": "plugin", + "cmd_path": "language\/plugin", + "parent": "language", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/plugin.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/theme": { + "title": "language theme", + "slug": "theme", + "cmd_path": "language\/theme", + "parent": "language", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/theme.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, "media\/image-size": { "title": "media image-size", "slug": "image-size", @@ -1167,6 +1231,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/plugin\/install.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "plugin\/is-active": { + "title": "plugin is-active", + "slug": "is-active", + "cmd_path": "plugin\/is-active", + "parent": "plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/plugin\/is-active.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "plugin\/is-installed": { "title": "plugin is-installed", "slug": "is-installed", @@ -1559,6 +1631,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/mature.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "site\/meta": { + "title": "site meta", + "slug": "meta", + "cmd_path": "site\/meta", + "parent": "site", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "site\/option": { "title": "site option", "slug": "option", @@ -1591,6 +1671,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/spam.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "site\/switch-language": { + "title": "site switch-language", + "slug": "switch-language", + "cmd_path": "site\/switch-language", + "parent": "site", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/switch-language.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, "site\/unarchive": { "title": "site unarchive", "slug": "unarchive", @@ -1767,6 +1855,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/theme\/install.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "theme\/is-active": { + "title": "theme is-active", + "slug": "is-active", + "cmd_path": "theme\/is-active", + "parent": "theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/theme\/is-active.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "theme\/is-installed": { "title": "theme is-installed", "slug": "is-installed", @@ -1871,6 +1967,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/add-role.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "user\/check-password": { + "title": "user check-password", + "slug": "check-password", + "cmd_path": "user\/check-password", + "parent": "user", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/user\/check-password.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "user\/create": { "title": "user create", "slug": "create", @@ -2215,6 +2319,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/core\/activate.md", "repo_url": "https:\/\/github.com\/wp-cli\/language-command" }, + "language\/core\/activate_language": { + "title": "language core activate_language", + "slug": "activate_language", + "cmd_path": "language\/core\/activate_language", + "parent": "language\/core", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/core\/activate_language.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, "language\/core\/install": { "title": "language core install", "slug": "install", @@ -2223,6 +2335,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/core\/install.md", "repo_url": "https:\/\/github.com\/wp-cli\/language-command" }, + "language\/core\/is-installed": { + "title": "language core is-installed", + "slug": "is-installed", + "cmd_path": "language\/core\/is-installed", + "parent": "language\/core", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/core\/is-installed.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, "language\/core\/list": { "title": "language core list", "slug": "list", @@ -2247,6 +2367,86 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/core\/update.md", "repo_url": "https:\/\/github.com\/wp-cli\/language-command" }, + "language\/plugin\/install": { + "title": "language plugin install", + "slug": "install", + "cmd_path": "language\/plugin\/install", + "parent": "language\/plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/plugin\/install.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/plugin\/is-installed": { + "title": "language plugin is-installed", + "slug": "is-installed", + "cmd_path": "language\/plugin\/is-installed", + "parent": "language\/plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/plugin\/is-installed.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/plugin\/list": { + "title": "language plugin list", + "slug": "list", + "cmd_path": "language\/plugin\/list", + "parent": "language\/plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/plugin\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/plugin\/uninstall": { + "title": "language plugin uninstall", + "slug": "uninstall", + "cmd_path": "language\/plugin\/uninstall", + "parent": "language\/plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/plugin\/uninstall.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/plugin\/update": { + "title": "language plugin update", + "slug": "update", + "cmd_path": "language\/plugin\/update", + "parent": "language\/plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/plugin\/update.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/theme\/install": { + "title": "language theme install", + "slug": "install", + "cmd_path": "language\/theme\/install", + "parent": "language\/theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/theme\/install.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/theme\/is-installed": { + "title": "language theme is-installed", + "slug": "is-installed", + "cmd_path": "language\/theme\/is-installed", + "parent": "language\/theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/theme\/is-installed.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/theme\/list": { + "title": "language theme list", + "slug": "list", + "cmd_path": "language\/theme\/list", + "parent": "language\/theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/theme\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/theme\/uninstall": { + "title": "language theme uninstall", + "slug": "uninstall", + "cmd_path": "language\/theme\/uninstall", + "parent": "language\/theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/theme\/uninstall.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, + "language\/theme\/update": { + "title": "language theme update", + "slug": "update", + "cmd_path": "language\/theme\/update", + "parent": "language\/theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/language\/theme\/update.md", + "repo_url": "https:\/\/github.com\/wp-cli\/language-command" + }, "menu\/item\/add-custom": { "title": "menu item add-custom", "slug": "add-custom", @@ -2463,6 +2663,62 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/post\/term\/set.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "site\/meta\/add": { + "title": "site meta add", + "slug": "add", + "cmd_path": "site\/meta\/add", + "parent": "site\/meta", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta\/add.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "site\/meta\/delete": { + "title": "site meta delete", + "slug": "delete", + "cmd_path": "site\/meta\/delete", + "parent": "site\/meta", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta\/delete.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "site\/meta\/get": { + "title": "site meta get", + "slug": "get", + "cmd_path": "site\/meta\/get", + "parent": "site\/meta", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "site\/meta\/list": { + "title": "site meta list", + "slug": "list", + "cmd_path": "site\/meta\/list", + "parent": "site\/meta", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "site\/meta\/patch": { + "title": "site meta patch", + "slug": "patch", + "cmd_path": "site\/meta\/patch", + "parent": "site\/meta", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta\/patch.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "site\/meta\/pluck": { + "title": "site meta pluck", + "slug": "pluck", + "cmd_path": "site\/meta\/pluck", + "parent": "site\/meta", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta\/pluck.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "site\/meta\/update": { + "title": "site meta update", + "slug": "update", + "cmd_path": "site\/meta\/update", + "parent": "site\/meta", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/site\/meta\/update.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "site\/option\/add": { "title": "site option add", "slug": "add", @@ -2583,6 +2839,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/theme\/mod\/get.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "theme\/mod\/list": { + "title": "theme mod list", + "slug": "list", + "cmd_path": "theme\/mod\/list", + "parent": "theme\/mod", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/commands\/theme\/mod\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "theme\/mod\/remove": { "title": "theme mod remove", "slug": "remove", diff --git a/bin/handbook-manifest.json b/bin/handbook-manifest.json index 4ae20bed..0e204a67 100644 --- a/bin/handbook-manifest.json +++ b/bin/handbook-manifest.json @@ -167,6 +167,12 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/tools.md", "parent": null }, + "troubleshooting": { + "title": "Troubleshooting Guide", + "slug": "troubleshooting", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/troubleshooting.md", + "parent": null + }, "wp-cli-add-command": { "title": "WP_CLI::add_command()", "slug": "wp-cli-add-command", @@ -359,6 +365,12 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/internal-api\/wp-cli-utils-make-progress-bar.md", "parent": "internal-api" }, + "wp-cli-utils-normalize-path": { + "title": "WP_CLI\\Utils\\normalize_path()", + "slug": "wp-cli-utils-normalize-path", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/internal-api\/wp-cli-utils-normalize-path.md", + "parent": "internal-api" + }, "wp-cli-utils-parse-ssh-url": { "title": "WP_CLI\\Utils\\parse_ssh_url()", "slug": "wp-cli-utils-parse-ssh-url", @@ -401,4 +413,4 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/master\/internal-api\/wp-cli-warning.md", "parent": "internal-api" } -} +} \ No newline at end of file diff --git a/commands/admin.md b/commands/admin.md index 1f5b9a40..c43a4dae 100644 --- a/commands/admin.md +++ b/commands/admin.md @@ -15,11 +15,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/add.md b/commands/cache/add.md index 04266055..03011b58 100644 --- a/commands/cache/add.md +++ b/commands/cache/add.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/decr.md b/commands/cache/decr.md index 3daeb497..1866d4bd 100644 --- a/commands/cache/decr.md +++ b/commands/cache/decr.md @@ -38,11 +38,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/delete.md b/commands/cache/delete.md index da30c04d..661a2ac7 100644 --- a/commands/cache/delete.md +++ b/commands/cache/delete.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/flush.md b/commands/cache/flush.md index ebdaed76..6cf38ea1 100644 --- a/commands/cache/flush.md +++ b/commands/cache/flush.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/get.md b/commands/cache/get.md index 5a86cc37..1ed7ce27 100644 --- a/commands/cache/get.md +++ b/commands/cache/get.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/incr.md b/commands/cache/incr.md index 61e75ecf..78c027e0 100644 --- a/commands/cache/incr.md +++ b/commands/cache/incr.md @@ -38,11 +38,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/replace.md b/commands/cache/replace.md index a8ab6de9..c8707d6a 100644 --- a/commands/cache/replace.md +++ b/commands/cache/replace.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/set.md b/commands/cache/set.md index 75c45b7a..f22a84ef 100644 --- a/commands/cache/set.md +++ b/commands/cache/set.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cache/type.md b/commands/cache/type.md index 28bf365f..81685dc2 100644 --- a/commands/cache/type.md +++ b/commands/cache/type.md @@ -21,11 +21,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cap/add.md b/commands/cap/add.md index 350b2523..3dfb2e6b 100644 --- a/commands/cap/add.md +++ b/commands/cap/add.md @@ -10,6 +10,15 @@ Adds capabilities to a given role. <cap>... : One or more capabilities to add. +[\--grant] +: Adds the capability as an explicit boolean value, instead of implicitly defaulting to `true`. +\--- +default: true +options: + - true + - false +\--- + ### EXAMPLES # Add 'spectate' capability to 'author' role. @@ -27,11 +36,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cap/list.md b/commands/cap/list.md index 6b9dc81d..59bc5790 100644 --- a/commands/cap/list.md +++ b/commands/cap/list.md @@ -20,6 +20,12 @@ options: - yaml \--- +[\--show-grant] +: Display all capabilities defined for a role including grant. +\--- +default: false +\--- + ### EXAMPLES # Display alphabetical list of Contributor capabilities. @@ -41,11 +47,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cap/remove.md b/commands/cap/remove.md index 48a677b8..41bb44e5 100644 --- a/commands/cap/remove.md +++ b/commands/cap/remove.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/alias.md b/commands/cli/alias.md index b08c32b0..99c54faa 100644 --- a/commands/cli/alias.md +++ b/commands/cli/alias.md @@ -13,6 +13,7 @@ default: yaml options: - yaml - json + - var_export \--- ### EXAMPLES @@ -40,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/check-update.md b/commands/cli/check-update.md index 0a47e960..db9cca77 100644 --- a/commands/cli/check-update.md +++ b/commands/cli/check-update.md @@ -58,11 +58,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/cmd-dump.md b/commands/cli/cmd-dump.md index 10300a94..7b53a167 100644 --- a/commands/cli/cmd-dump.md +++ b/commands/cli/cmd-dump.md @@ -17,11 +17,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/completions.md b/commands/cli/completions.md index 16618313..953809a1 100644 --- a/commands/cli/completions.md +++ b/commands/cli/completions.md @@ -28,11 +28,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/has-command.md b/commands/cli/has-command.md index d8b8a818..1652aae2 100644 --- a/commands/cli/has-command.md +++ b/commands/cli/has-command.md @@ -31,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/info.md b/commands/cli/info.md index f3130442..63e28a62 100644 --- a/commands/cli/info.md +++ b/commands/cli/info.md @@ -53,11 +53,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/param-dump.md b/commands/cli/param-dump.md index b8d806ce..481c3c24 100644 --- a/commands/cli/param-dump.md +++ b/commands/cli/param-dump.md @@ -44,11 +44,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/update.md b/commands/cli/update.md index 420e3ea9..9ce00881 100644 --- a/commands/cli/update.md +++ b/commands/cli/update.md @@ -50,11 +50,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cli/version.md b/commands/cli/version.md index a330c1ea..4eb8e7c5 100644 --- a/commands/cli/version.md +++ b/commands/cli/version.md @@ -19,11 +19,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/approve.md b/commands/comment/approve.md index 1acaa8fa..5989438d 100644 --- a/commands/comment/approve.md +++ b/commands/comment/approve.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/count.md b/commands/comment/count.md index b597b738..a71fc6d7 100644 --- a/commands/comment/count.md +++ b/commands/comment/count.md @@ -40,11 +40,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/create.md b/commands/comment/create.md index ca5967d2..5c7b5a54 100644 --- a/commands/comment/create.md +++ b/commands/comment/create.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/delete.md b/commands/comment/delete.md index 938a80d5..3a126df5 100644 --- a/commands/comment/delete.md +++ b/commands/comment/delete.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/exists.md b/commands/comment/exists.md index 23b7334c..f2a28cb1 100644 --- a/commands/comment/exists.md +++ b/commands/comment/exists.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/generate.md b/commands/comment/generate.md index 184e2115..2e49d7e6 100644 --- a/commands/comment/generate.md +++ b/commands/comment/generate.md @@ -47,11 +47,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/get.md b/commands/comment/get.md index d3ac2ed6..0424d647 100644 --- a/commands/comment/get.md +++ b/commands/comment/get.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/list.md b/commands/comment/list.md index de9d1566..f0ce7c02 100644 --- a/commands/comment/list.md +++ b/commands/comment/list.md @@ -87,11 +87,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/meta/add.md b/commands/comment/meta/add.md index e0524ab3..1b5913bb 100644 --- a/commands/comment/meta/add.md +++ b/commands/comment/meta/add.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/meta/delete.md b/commands/comment/meta/delete.md index 46c97b36..88a043e4 100644 --- a/commands/comment/meta/delete.md +++ b/commands/comment/meta/delete.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/meta/get.md b/commands/comment/meta/get.md index 3207f6a6..3912a603 100644 --- a/commands/comment/meta/get.md +++ b/commands/comment/meta/get.md @@ -11,7 +11,14 @@ Get meta field value. : The name of the meta field to get. [\--format=<format>] -: Accepted values: table, json. Default: table +: Get value in a particular format. +\--- +default: var_export +options: + - var_export + - json + - yaml +\--- ### GLOBAL PARAMETERS @@ -24,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/meta/list.md b/commands/comment/meta/list.md index bc0286bd..77c43feb 100644 --- a/commands/comment/meta/list.md +++ b/commands/comment/meta/list.md @@ -14,7 +14,16 @@ List all metadata associated with an object. : Limit the output to specific row fields. Defaults to id,meta_key,meta_value. [\--format=<format>] -: Accepted values: table, csv, json, count. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count +\--- [\--orderby=<fields>] : Set orderby which field. @@ -46,11 +55,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/meta/patch.md b/commands/comment/meta/patch.md index 28d62105..113be0f3 100644 --- a/commands/comment/meta/patch.md +++ b/commands/comment/meta/patch.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/meta/pluck.md b/commands/comment/meta/pluck.md index 210aca62..0e339f77 100644 --- a/commands/comment/meta/pluck.md +++ b/commands/comment/meta/pluck.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/meta/update.md b/commands/comment/meta/update.md index 196b35b1..0dfbdec2 100644 --- a/commands/comment/meta/update.md +++ b/commands/comment/meta/update.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/recount.md b/commands/comment/recount.md index 390b69fb..41069b42 100644 --- a/commands/comment/recount.md +++ b/commands/comment/recount.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/spam.md b/commands/comment/spam.md index 3a2601f3..5fa3ff4a 100644 --- a/commands/comment/spam.md +++ b/commands/comment/spam.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/status.md b/commands/comment/status.md index db2b81bd..538db192 100644 --- a/commands/comment/status.md +++ b/commands/comment/status.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/trash.md b/commands/comment/trash.md index f3a9163a..8f26e324 100644 --- a/commands/comment/trash.md +++ b/commands/comment/trash.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/unapprove.md b/commands/comment/unapprove.md index b0bf46b6..975b86c0 100644 --- a/commands/comment/unapprove.md +++ b/commands/comment/unapprove.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/unspam.md b/commands/comment/unspam.md index 431fb76b..5ed9ff8c 100644 --- a/commands/comment/unspam.md +++ b/commands/comment/unspam.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/untrash.md b/commands/comment/untrash.md index f5a77b9d..ed8d5f9f 100644 --- a/commands/comment/untrash.md +++ b/commands/comment/untrash.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/comment/update.md b/commands/comment/update.md index e9f6c4f3..1a3ed2a5 100644 --- a/commands/comment/update.md +++ b/commands/comment/update.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/create.md b/commands/config/create.md index 2cfb1175..94b5a09d 100644 --- a/commands/config/create.md +++ b/commands/config/create.md @@ -83,11 +83,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/delete.md b/commands/config/delete.md index 6a3cb34f..71c317eb 100644 --- a/commands/config/delete.md +++ b/commands/config/delete.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/edit.md b/commands/config/edit.md new file mode 100644 index 00000000..f3c988be --- /dev/null +++ b/commands/config/edit.md @@ -0,0 +1,31 @@ +# wp config edit + +Launches system editor to edit the wp-config.php file. + +### EXAMPLES + + # Launch system editor to edit wp-config.php file + $ wp config edit + + # Edit wp-config.php file in a specific editor + $ EDITOR=vim wp config edit + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/config/get.md b/commands/config/get.md index 107660ab..acda3e20 100644 --- a/commands/config/get.md +++ b/commands/config/get.md @@ -34,11 +34,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/has.md b/commands/config/has.md index b4fa036e..686bd072 100644 --- a/commands/config/has.md +++ b/commands/config/has.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/list.md b/commands/config/list.md index 64c94308..4c545c81 100644 --- a/commands/config/list.md +++ b/commands/config/list.md @@ -70,11 +70,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/path.md b/commands/config/path.md index 714c7808..ba8a26c9 100644 --- a/commands/config/path.md +++ b/commands/config/path.md @@ -19,11 +19,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/set.md b/commands/config/set.md index 86bdf616..350d8714 100644 --- a/commands/config/set.md +++ b/commands/config/set.md @@ -57,11 +57,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/config/shuffle-salts.md b/commands/config/shuffle-salts.md new file mode 100644 index 00000000..b7607f55 --- /dev/null +++ b/commands/config/shuffle-salts.md @@ -0,0 +1,31 @@ +# wp config shuffle-salts + +Refreshes the salts defined in the wp-config.php file. + +### OPTIONS + +### EXAMPLES + + # Get new salts for your wp-config.php file + $ wp config shuffle-salts + Success: Shuffled the salt keys. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/core/check-update.md b/commands/core/check-update.md index d6887b4a..c173b19e 100644 --- a/commands/core/check-update.md +++ b/commands/core/check-update.md @@ -50,11 +50,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/download.md b/commands/core/download.md index 6d078e08..9e8b8f34 100644 --- a/commands/core/download.md +++ b/commands/core/download.md @@ -39,11 +39,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/install.md b/commands/core/install.md index c66a4daf..c63ce84d 100644 --- a/commands/core/install.md +++ b/commands/core/install.md @@ -48,11 +48,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/is-installed.md b/commands/core/is-installed.md index 94e68136..52859c10 100644 --- a/commands/core/is-installed.md +++ b/commands/core/is-installed.md @@ -30,11 +30,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/multisite-convert.md b/commands/core/multisite-convert.md index e7605050..cad42d7a 100644 --- a/commands/core/multisite-convert.md +++ b/commands/core/multisite-convert.md @@ -40,11 +40,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/multisite-install.md b/commands/core/multisite-install.md index 1a5f9320..39d7de44 100644 --- a/commands/core/multisite-install.md +++ b/commands/core/multisite-install.md @@ -62,11 +62,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/update-db.md b/commands/core/update-db.md index 89d68665..dd4467c8 100644 --- a/commands/core/update-db.md +++ b/commands/core/update-db.md @@ -30,11 +30,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/update.md b/commands/core/update.md index 19c8cfa3..a6aab0d7 100644 --- a/commands/core/update.md +++ b/commands/core/update.md @@ -64,11 +64,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/verify-checksums.md b/commands/core/verify-checksums.md index 42220461..c1792f4b 100644 --- a/commands/core/verify-checksums.md +++ b/commands/core/verify-checksums.md @@ -51,11 +51,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/core/version.md b/commands/core/version.md index 0fd08e17..b75d9904 100644 --- a/commands/core/version.md +++ b/commands/core/version.md @@ -31,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cron/event/delete.md b/commands/cron/event/delete.md index 2b259d28..a0d37360 100644 --- a/commands/cron/event/delete.md +++ b/commands/cron/event/delete.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cron/event/list.md b/commands/cron/event/list.md index a4392aa9..154bc6ec 100644 --- a/commands/cron/event/list.md +++ b/commands/cron/event/list.md @@ -69,11 +69,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cron/event/run.md b/commands/cron/event/run.md index d5a2d3a2..16ead4b4 100644 --- a/commands/cron/event/run.md +++ b/commands/cron/event/run.md @@ -30,11 +30,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cron/event/schedule.md b/commands/cron/event/schedule.md index 72ec3f67..06743190 100644 --- a/commands/cron/event/schedule.md +++ b/commands/cron/event/schedule.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cron/schedule/list.md b/commands/cron/schedule/list.md index 67210259..bfc40abc 100644 --- a/commands/cron/schedule/list.md +++ b/commands/cron/schedule/list.md @@ -59,11 +59,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/cron/test.md b/commands/cron/test.md index ad5aae0e..d760cdc7 100644 --- a/commands/cron/test.md +++ b/commands/cron/test.md @@ -25,11 +25,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/check.md b/commands/db/check.md index f0c8e12d..d28a15b2 100644 --- a/commands/db/check.md +++ b/commands/db/check.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/clean.md b/commands/db/clean.md new file mode 100644 index 00000000..796051eb --- /dev/null +++ b/commands/db/clean.md @@ -0,0 +1,42 @@ +# wp db clean + +Removes all tables with `$table_prefix` from the database. + +Runs `DROP_TABLE` for each table that has a `$table_prefix` as specified in wp-config.php. + +### OPTIONS + +[\--dbuser=<value>] +: Username to pass to mysql. Defaults to DB_USER. + +[\--dbpass=<value>] +: Password to pass to mysql. Defaults to DB_PASSWORD. + +[\--yes] +: Answer yes to the confirmation message. + +### EXAMPLES + + # Delete all tables that match the current site prefix. + $ wp db clean --yes + Success: Tables dropped. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/db/cli.md b/commands/db/cli.md index d7d7a993..7da73686 100644 --- a/commands/db/cli.md +++ b/commands/db/cli.md @@ -36,11 +36,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/columns.md b/commands/db/columns.md new file mode 100644 index 00000000..28f0f96e --- /dev/null +++ b/commands/db/columns.md @@ -0,0 +1,70 @@ +# wp db columns + +Displays information about a given table. + +### OPTIONS + +[<table>] +: Name of the database table. + +[\--format] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + $ wp db columns wp_posts + +-----------------------+---------------------+------+-----+---------------------+----------------+ + | Field | Type | Null | Key | Default | Extra | + +-----------------------+---------------------+------+-----+---------------------+----------------+ + | ID | bigint(20) unsigned | NO | PRI | | auto_increment | + | post_author | bigint(20) unsigned | NO | MUL | 0 | | + | post_date | datetime | NO | | 0000-00-00 00:00:00 | | + | post_date_gmt | datetime | NO | | 0000-00-00 00:00:00 | | + | post_content | longtext | NO | | | | + | post_title | text | NO | | | | + | post_excerpt | text | NO | | | | + | post_status | varchar(20) | NO | | publish | | + | comment_status | varchar(20) | NO | | open | | + | ping_status | varchar(20) | NO | | open | | + | post_password | varchar(255) | NO | | | | + | post_name | varchar(200) | NO | MUL | | | + | to_ping | text | NO | | | | + | pinged | text | NO | | | | + | post_modified | datetime | NO | | 0000-00-00 00:00:00 | | + | post_modified_gmt | datetime | NO | | 0000-00-00 00:00:00 | | + | post_content_filtered | longtext | NO | | | | + | post_parent | bigint(20) unsigned | NO | MUL | 0 | | + | guid | varchar(255) | NO | | | | + | menu_order | int(11) | NO | | 0 | | + | post_type | varchar(20) | NO | MUL | post | | + | post_mime_type | varchar(100) | NO | | | | + | comment_count | bigint(20) | NO | | 0 | | + +-----------------------+---------------------+------+-----+---------------------+----------------+ + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/db/create.md b/commands/db/create.md index 9e44b3ce..528070a4 100644 --- a/commands/db/create.md +++ b/commands/db/create.md @@ -28,11 +28,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/drop.md b/commands/db/drop.md index e5966595..e3eca997 100644 --- a/commands/db/drop.md +++ b/commands/db/drop.md @@ -31,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/export.md b/commands/db/export.md index b1b06119..b5a1fc7c 100644 --- a/commands/db/export.md +++ b/commands/db/export.md @@ -45,6 +45,14 @@ Runs `mysqldump` utility using `DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` $ wp db export --tables=$(wp db tables --all-tables-with-prefix --format=csv) Success: Exported to 'wordpress_dbase-db72bb5.sql'. + # Export certain posts without create table statements + $ wp db export --no-create-info=true --tables=wp_posts --where="ID in (100,101,102)" + Success: Exported to 'wordpress_dbase-db72bb5.sql'. + + # Export relating meta for certain posts without create table statements + $ wp db export --no-create-info=true --tables=wp_postmeta --where="post_id in (100,101,102)" + Success: Exported to 'wordpress_dbase-db72bb5.sql'. + # Skip certain tables from the exported database $ wp db export --exclude_tables=wp_options,wp_users Success: Exported to 'wordpress_dbase-db72bb5.sql'. @@ -77,11 +85,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/import.md b/commands/db/import.md index fff7834a..a68e81a7 100644 --- a/commands/db/import.md +++ b/commands/db/import.md @@ -35,11 +35,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/optimize.md b/commands/db/optimize.md index 03a1b156..25e2cbf4 100644 --- a/commands/db/optimize.md +++ b/commands/db/optimize.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/prefix.md b/commands/db/prefix.md index e9f6e736..37f9d226 100644 --- a/commands/db/prefix.md +++ b/commands/db/prefix.md @@ -20,11 +20,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/query.md b/commands/db/query.md index 0d12bc90..c14d93a8 100644 --- a/commands/db/query.md +++ b/commands/db/query.md @@ -60,11 +60,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/repair.md b/commands/db/repair.md index 9a695e53..7cd71ace 100644 --- a/commands/db/repair.md +++ b/commands/db/repair.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/reset.md b/commands/db/reset.md index d13630d7..97004a82 100644 --- a/commands/db/reset.md +++ b/commands/db/reset.md @@ -31,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/search.md b/commands/db/search.md index d470b3d0..5f3a8ad6 100644 --- a/commands/db/search.md +++ b/commands/db/search.md @@ -134,11 +134,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/size.md b/commands/db/size.md index c6a164a7..0b33b910 100644 --- a/commands/db/size.md +++ b/commands/db/size.md @@ -16,6 +16,15 @@ options: - mb (megabytes) - gb (gigabytes) - tb (terabytes) + - B (ISO Byte setting, with no conversion) + - KB (ISO Kilobyte setting, with 1 KB = 1,000 B) + - KiB (ISO Kibibyte setting, with 1 KiB = 1,024 B) + - MB (ISO Megabyte setting, with 1 MB = 1,000 KB) + - MiB (ISO Mebibyte setting, with 1 MiB = 1,024 KiB) + - GB (ISO Gigabyte setting, with 1 GB = 1,000 MB) + - GiB (ISO Gibibyte setting, with 1 GiB = 1,024 MiB) + - TB (ISO Terabyte setting, with 1 TB = 1,000 GB) + - TiB (ISO Tebibyte setting, with 1 TiB = 1,024 GiB) --- [\--tables] @@ -89,11 +98,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/db/tables.md b/commands/db/tables.md index a4c3f580..fb6a9d0b 100644 --- a/commands/db/tables.md +++ b/commands/db/tables.md @@ -59,11 +59,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/dist-archive.md b/commands/dist-archive.md index 0d145292..ce6499ea 100644 --- a/commands/dist-archive.md +++ b/commands/dist-archive.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/embed/cache/clear.md b/commands/embed/cache/clear.md index 149fad10..35383138 100644 --- a/commands/embed/cache/clear.md +++ b/commands/embed/cache/clear.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/embed/cache/find.md b/commands/embed/cache/find.md index dbc1cbbc..28df6245 100644 --- a/commands/embed/cache/find.md +++ b/commands/embed/cache/find.md @@ -37,11 +37,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/embed/cache/trigger.md b/commands/embed/cache/trigger.md index 0f25859f..59b2ea97 100644 --- a/commands/embed/cache/trigger.md +++ b/commands/embed/cache/trigger.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/embed/fetch.md b/commands/embed/fetch.md index a9ef13e1..d8a2a32b 100644 --- a/commands/embed/fetch.md +++ b/commands/embed/fetch.md @@ -67,11 +67,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/embed/handler/list.md b/commands/embed/handler/list.md index 10113d73..16994674 100644 --- a/commands/embed/handler/list.md +++ b/commands/embed/handler/list.md @@ -54,11 +54,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/embed/provider/list.md b/commands/embed/provider/list.md index cbfaaa28..7627e5cb 100644 --- a/commands/embed/provider/list.md +++ b/commands/embed/provider/list.md @@ -56,11 +56,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/embed/provider/match.md b/commands/embed/provider/match.md index a86743c5..98bac294 100644 --- a/commands/embed/provider/match.md +++ b/commands/embed/provider/match.md @@ -38,11 +38,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/eval-file.md b/commands/eval-file.md index 1d2c8444..dd6a2b02 100644 --- a/commands/eval-file.md +++ b/commands/eval-file.md @@ -7,7 +7,7 @@ Note: because code is executed within a method, global variables need to be expl ### OPTIONS <file> -: The path to the PHP file to execute. +: The path to the PHP file to execute. Use '-' to run code from STDIN. [<arg>...] : One or more arguments to pass to the file. They are placed in the $args variable. @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/eval.md b/commands/eval.md index 54195781..bb7b880c 100644 --- a/commands/eval.md +++ b/commands/eval.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/export.md b/commands/export.md index 31bfd9a4..db863043 100644 --- a/commands/export.md +++ b/commands/export.md @@ -93,11 +93,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/find.md b/commands/find.md index 2ec81da6..fae82bbd 100644 --- a/commands/find.md +++ b/commands/find.md @@ -63,11 +63,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/help.md b/commands/help.md index d2823dbc..3cb4e61e 100644 --- a/commands/help.md +++ b/commands/help.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/i18n.md b/commands/i18n.md new file mode 100644 index 00000000..51fff382 --- /dev/null +++ b/commands/i18n.md @@ -0,0 +1,10 @@ +# wp i18n + +Provides internationalization tools for WordPress projects. + +### EXAMPLES + + # Create a POT file for the WordPress plugin/theme in the current directory + $ wp i18n make-pot . languages/my-plugin.pot + + diff --git a/commands/i18n/make-pot.md b/commands/i18n/make-pot.md new file mode 100644 index 00000000..c8961bc0 --- /dev/null +++ b/commands/i18n/make-pot.md @@ -0,0 +1,86 @@ +# wp i18n make-pot + +Create a POT file for a WordPress project. + +Scans PHP and JavaScript files for translatable strings, as well as theme stylesheets and plugin files if the source directory is detected as either a plugin or theme. + +### OPTIONS + +<source> +: Directory to scan for string extraction. + +[<destination>] +: Name of the resulting POT file. + +[\--slug=<slug>] +: Plugin or theme slug. Defaults to the source directory's basename. + +[\--domain=<domain>] +: Text domain to look for in the source code, unless the `--ignore-domain` option is used. By default, the "Text Domain" header of the plugin or theme is used. If none is provided, it falls back to the project slug. + +[\--ignore-domain] +: Ignore the text domain completely and extract strings with any text domain. + +[\--merge[=<paths>]] +: Comma-separated list of POT files whose contents should be merged with the extracted strings. If left empty, defaults to the destination POT file. POT file headers will be ignored. + +[\--subtract=<paths>] +: Comma-separated list of POT files whose contents should act as some sort of blacklist for string extraction. Any string which is found on that blacklist will not be extracted. This can be useful when you want to create multiple POT files from the same source directory with slightly different content and no duplicate strings between them. + +[\--include=<paths>] +: Comma-separated list of files and paths that should be used for string extraction. If provided, only these files and folders will be taken into account for string extraction. For example, `--include="src,my-file.php` will ignore anything besides `my-file.php` and files in the `src` directory. Simple glob patterns can be used, i.e. `--include=foo-*.php` includes any PHP file with the `foo-` prefix. Leading and trailing slashes are ignored, i.e. `/my/directory/` is the same as `my/directory`. + +[\--exclude=<paths>] +: Comma-separated list of files and paths that should be skipped for string extraction. For example, `--exclude=".github,myfile.php` would ignore any strings found within `myfile.php` or the `.github` folder. Simple glob patterns can be used, i.e. `--exclude=foo-*.php` excludes any PHP file with the `foo-` prefix. Leading and trailing slashes are ignored, i.e. `/my/directory/` is the same as `my/directory`. The following files and folders are always excluded: node_modules, .git, .svn, .CVS, .hg, vendor, *.min.js. + +[\--headers=<headers>] +: Array in JSON format of custom headers which will be added to the POT file. Defaults to empty array. + +[\--skip-js] +: Skips JavaScript string extraction. Useful when this is done in another build step, e.g. through Babel. + +[\--file-comment] +: String that should be added as a comment to the top of the resulting POT file. By default, a copyright comment is added for WordPress plugins and themes in the following manner: + + ``` + Copyright (C) 2018 Example Plugin Author + This file is distributed under the same license as the Example Plugin package. + ``` + + If a plugin or theme specifies a license in their main plugin file or stylesheet, the comment looks like this: + + ``` + Copyright (C) 2018 Example Plugin Author + This file is distributed under the GPLv2. + ``` + +[\--package-name=<name>] +: Name to use for package name in the resulting POT file's `Project-Id-Version` header. Overrides plugin or theme name, if applicable. + +### EXAMPLES + + # Create a POT file for the WordPress plugin/theme in the current directory + $ wp i18n make-pot . languages/my-plugin.pot + + # Create a POT file for the continents and cities list in WordPress core. + $ wp i18n make-pot . continents-and-cities.pot --include="wp-admin/includes/continents-cities.php" --ignore-domain + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/import.md b/commands/import.md index 08a51a92..66fd1ce0 100644 --- a/commands/import.md +++ b/commands/import.md @@ -37,11 +37,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/language.md b/commands/language.md index a7efc128..7315e31f 100644 --- a/commands/language.md +++ b/commands/language.md @@ -12,4 +12,12 @@ Installs, activates, and manages language packs. $ wp language core activate nl_NL Success: Language activated. + # Install the Dutch language pack for Twenty Seventeen. + $ wp language theme install twentyseventeen nl_NL + Success: Language installed. + + # Install the Dutch language pack for Akismet. + $ wp language plugin install akismet nl_NL + Success: Language installed. + diff --git a/commands/language/core/activate.md b/commands/language/core/activate.md index d3a3b392..0ac13f32 100644 --- a/commands/language/core/activate.md +++ b/commands/language/core/activate.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/language/core/activate_language.md b/commands/language/core/activate_language.md new file mode 100644 index 00000000..21d94488 --- /dev/null +++ b/commands/language/core/activate_language.md @@ -0,0 +1,25 @@ +# wp language core activate_language + + + + + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/core/install.md b/commands/language/core/install.md index ad21ffa1..7180b6b1 100644 --- a/commands/language/core/install.md +++ b/commands/language/core/install.md @@ -29,11 +29,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/language/core/is-installed.md b/commands/language/core/is-installed.md new file mode 100644 index 00000000..d8e5b3cb --- /dev/null +++ b/commands/language/core/is-installed.md @@ -0,0 +1,37 @@ +# wp language core is-installed + +Checks if a given language is installed. + +Returns exit code 0 when installed, 1 when uninstalled. + +### OPTIONS + +<language> +: The language code to check. + +### EXAMPLES + + # Check whether the German language is installed; exit status 0 if installed, otherwise 1. + $ wp language core is-installed de_DE + $ echo $? + 1 + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/core/list.md b/commands/language/core/list.md index c4f57f1c..479ac014 100644 --- a/commands/language/core/list.md +++ b/commands/language/core/list.md @@ -61,11 +61,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/language/core/uninstall.md b/commands/language/core/uninstall.md index d194c660..e3cef28d 100644 --- a/commands/language/core/uninstall.md +++ b/commands/language/core/uninstall.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/language/core/update.md b/commands/language/core/update.md index 3edd639d..dca2c2f8 100644 --- a/commands/language/core/update.md +++ b/commands/language/core/update.md @@ -1,8 +1,6 @@ # wp language core update -Updates installed languages. - -Updates installed languages for core, plugins and themes. +Updates installed languages for core. ### OPTIONS @@ -12,13 +10,10 @@ Updates installed languages for core, plugins and themes. ### EXAMPLES $ wp language core 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... + Updating 'Japanese' translation for WordPress 4.9.2... + Downloading translation from https://downloads.wordpress.org/translation/core/4.9.2/ja.zip... Translation updated successfully. - Success: Updated 2/2 translations. + Success: Updated 1/1 translation. ### GLOBAL PARAMETERS @@ -31,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/language/plugin.md b/commands/language/plugin.md new file mode 100644 index 00000000..302032c9 --- /dev/null +++ b/commands/language/plugin.md @@ -0,0 +1,23 @@ +# wp language plugin + +Installs, activates, and manages plugin language packs. + +### EXAMPLES + + # Install the Dutch theme language pack. + $ wp language plugin install hello-dolly nl_NL + Success: Language installed. + + # Uninstall the Dutch theme language pack. + $ wp language plugin uninstall hello-dolly nl_NL + Success: Language uninstalled. + + # List installed theme language packages. + $ wp language plugin list --status=installed + +----------+--------------+-------------+-----------+-----------+---------------------+ + | language | english_name | native_name | status | update | updated | + +----------+--------------+-------------+-----------+-----------+---------------------+ + | nl_NL | Dutch | Nederlands | installed | available | 2016-05-13 08:12:50 | + +----------+--------------+-------------+-----------+-----------+---------------------+ + + diff --git a/commands/language/plugin/install.md b/commands/language/plugin/install.md new file mode 100644 index 00000000..4346acb5 --- /dev/null +++ b/commands/language/plugin/install.md @@ -0,0 +1,39 @@ +# wp language plugin install + +Installs a given language for a plugin. + +Downloads the language pack from WordPress.org. + +### OPTIONS + +<plugin> +: Plugin to install language for. + +<language>... +: Language code to install. + +### EXAMPLES + + # Install the Japanese language for Akismet. + $ wp language plugin install akismet ja + Success: Language installed. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/plugin/is-installed.md b/commands/language/plugin/is-installed.md new file mode 100644 index 00000000..5fd44fb9 --- /dev/null +++ b/commands/language/plugin/is-installed.md @@ -0,0 +1,40 @@ +# wp language plugin is-installed + +Checks if a given language is installed. + +Returns exit code 0 when installed, 1 when uninstalled. + +### OPTIONS + +<plugin> +: Plugin to check for. + +<language>... +: The language code to check. + +### EXAMPLES + + # Check whether the German language is installed for Akismet; exit status 0 if installed, otherwise 1. + $ wp language plugin is-installed akismet de_DE + $ echo $? + 1 + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/plugin/list.md b/commands/language/plugin/list.md new file mode 100644 index 00000000..05f00853 --- /dev/null +++ b/commands/language/plugin/list.md @@ -0,0 +1,78 @@ +# wp language plugin list + +Lists all available languages for one or more plugins. + +### OPTIONS + +[<plugin>...] +: One or more plugins to list languages for. + +[\--all] +: If set, available languages for all plugins will be listed. + +[\--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>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for each translation: + +* plugin +* 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 language plugin list --fields=language,english_name,status + +----------------+-------------------------+-------------+ + | language | english_name | status | + +----------------+-------------------------+-------------+ + | ar | Arabic | uninstalled | + | ary | Moroccan Arabic | uninstalled | + | az | Azerbaijani | uninstalled | + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/plugin/uninstall.md b/commands/language/plugin/uninstall.md new file mode 100644 index 00000000..1a17674c --- /dev/null +++ b/commands/language/plugin/uninstall.md @@ -0,0 +1,36 @@ +# wp language plugin uninstall + +Uninstalls a given language for a plugin. + +### OPTIONS + +<plugin> +: Plugin to uninstall language for. + +<language>... +: Language code to uninstall. + +### EXAMPLES + + $ wp language plugin uninstall hello-dolly ja + Success: Language uninstalled. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/plugin/update.md b/commands/language/plugin/update.md new file mode 100644 index 00000000..bb071ec6 --- /dev/null +++ b/commands/language/plugin/update.md @@ -0,0 +1,42 @@ +# wp language plugin update + +Updates installed languages for one or more plugins. + +### OPTIONS + +[<plugin>...] +: One or more plugins to update languages for. + +[\--all] +: If set, languages for all plugins will be updated. + +[\--dry-run] +: Preview which translations would be updated. + +### EXAMPLES + + $ wp language plugin update --all + 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. + Success: Updated 1/1 translation. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/theme.md b/commands/language/theme.md new file mode 100644 index 00000000..e1b220e9 --- /dev/null +++ b/commands/language/theme.md @@ -0,0 +1,23 @@ +# wp language theme + +Installs, activates, and manages theme language packs. + +### EXAMPLES + + # Install the Dutch theme language pack. + $ wp language theme install twentyten nl_NL + Success: Language installed. + + # Uninstall the Dutch theme language pack. + $ wp language theme uninstall twentyten nl_NL + Success: Language uninstalled. + + # List installed theme language packages. + $ wp language theme list --status=installed + +----------+--------------+-------------+-----------+-----------+---------------------+ + | language | english_name | native_name | status | update | updated | + +----------+--------------+-------------+-----------+-----------+---------------------+ + | nl_NL | Dutch | Nederlands | installed | available | 2016-05-13 08:12:50 | + +----------+--------------+-------------+-----------+-----------+---------------------+ + + diff --git a/commands/language/theme/install.md b/commands/language/theme/install.md new file mode 100644 index 00000000..36a3c82e --- /dev/null +++ b/commands/language/theme/install.md @@ -0,0 +1,39 @@ +# wp language theme install + +Installs a given language for a theme. + +Downloads the language pack from WordPress.org. + +### OPTIONS + +<theme> +: Theme to install language for. + +<language>... +: Language code to install. + +### EXAMPLES + + # Install the Japanese language for Twenty Seventeen. + $ wp language theme install twentyseventeen ja + Success: Language installed. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/theme/is-installed.md b/commands/language/theme/is-installed.md new file mode 100644 index 00000000..2481e269 --- /dev/null +++ b/commands/language/theme/is-installed.md @@ -0,0 +1,40 @@ +# wp language theme is-installed + +Checks if a given language is installed. + +Returns exit code 0 when installed, 1 when uninstalled. + +### OPTIONS + +<theme> +: Theme to check for. + +<language>... +: The language code to check. + +### EXAMPLES + + # Check whether the German language is installed for Twenty Seventeen; exit status 0 if installed, otherwise 1. + $ wp language theme is-installed twentyseventeen de_DE + $ echo $? + 1 + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/theme/list.md b/commands/language/theme/list.md new file mode 100644 index 00000000..713196bb --- /dev/null +++ b/commands/language/theme/list.md @@ -0,0 +1,78 @@ +# wp language theme list + +Lists all available languages for one or more themes. + +### OPTIONS + +[<theme>...] +: One or more themes to list languages for. + +[\--all] +: If set, available languages for all themes will be listed. + +[\--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>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for each translation: + +* theme +* 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 language theme list --fields=language,english_name,status + +----------------+-------------------------+-------------+ + | language | english_name | status | + +----------------+-------------------------+-------------+ + | ar | Arabic | uninstalled | + | ary | Moroccan Arabic | uninstalled | + | az | Azerbaijani | uninstalled | + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/theme/uninstall.md b/commands/language/theme/uninstall.md new file mode 100644 index 00000000..23b531ad --- /dev/null +++ b/commands/language/theme/uninstall.md @@ -0,0 +1,36 @@ +# wp language theme uninstall + +Uninstalls a given language for a theme. + +### OPTIONS + +<theme> +: Theme to uninstall language for. + +<language>... +: Language code to uninstall. + +### EXAMPLES + + $ wp language theme uninstall twentyten ja + Success: Language uninstalled. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/language/theme/update.md b/commands/language/theme/update.md new file mode 100644 index 00000000..8857f4d7 --- /dev/null +++ b/commands/language/theme/update.md @@ -0,0 +1,42 @@ +# wp language theme update + +Updates installed languages for one or more themes. + +### OPTIONS + +[<plugin>...] +: One or more plugins to update languages for. + +[\--all] +: If set, languages for all themes will be updated. + +[\--dry-run] +: Preview which translations would be updated. + +### EXAMPLES + + $ wp language theme update --all + 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 1/1 translation. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/media/image-size.md b/commands/media/image-size.md index 1215b7e2..db1a7771 100644 --- a/commands/media/image-size.md +++ b/commands/media/image-size.md @@ -54,11 +54,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/media/import.md b/commands/media/import.md index 5bd629bd..e0c656c4 100644 --- a/commands/media/import.md +++ b/commands/media/import.md @@ -40,8 +40,8 @@ Creates attachments from local files or URLs. # 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. + Imported file '/home/person/Pictures/landscape-photo.jpg' as attachment ID 1751. + Imported file '/home/person/Pictures/fashion-icon.jpg' as attachment ID 1752. Success: Imported 2 of 2 items. # Import a local image and set it to be the post thumbnail for a post. @@ -62,6 +62,10 @@ Creates attachments from local files or URLs. Imported file 'http://s.wordpress.org/style/images/wp-header-logo.png' as attachment ID 1755. Success: Imported 1 of 1 images. + # Get the URL for an attachment after import. + $ wp media import http://s.wordpress.org/style/images/wp-header-logo.png --porcelain | xargs -I {} wp post list --post__in={} --field=url --post_type=attachment + http://wordpress-develop.dev/wp-header-logo/ + ### GLOBAL PARAMETERS These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. @@ -73,11 +77,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/media/regenerate.md b/commands/media/regenerate.md index 95c90c34..0db5383c 100644 --- a/commands/media/regenerate.md +++ b/commands/media/regenerate.md @@ -50,9 +50,9 @@ Regenerates thumbnails for one or more attachments. $ wp media regenerate --image_size=large Do you really want to regenerate the "large" image size for all images? [y/n] y Found 3 images to regenerate. - 1/3 Regenerated "large" thumbnail for "Yoogest Image Ever, Really" (ID 9999). - 2/3 No "large" thumbnail regeneration needed for "Snowflake" (ID 9998). - 3/3 Regenerated "large" thumbnail for "Even Yooger than the Yoogest Image Ever, Really" (ID 9997). + 1/3 Regenerated "large" thumbnail for "Sydney Harbor Bridge" (ID 760). + 2/3 No "large" thumbnail regeneration needed for "Boardwalk" (ID 757). + 3/3 Regenerated "large" thumbnail for "Sunburst Over River" (ID 756). Success: Regenerated 3 of 3 images. ### GLOBAL PARAMETERS @@ -66,11 +66,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/create.md b/commands/menu/create.md index 9a9f2cdc..29b3b519 100644 --- a/commands/menu/create.md +++ b/commands/menu/create.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/delete.md b/commands/menu/delete.md index db6e3572..e93fe8ea 100644 --- a/commands/menu/delete.md +++ b/commands/menu/delete.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/item/add-custom.md b/commands/menu/item/add-custom.md index 64642b0c..c1357c13 100644 --- a/commands/menu/item/add-custom.md +++ b/commands/menu/item/add-custom.md @@ -50,11 +50,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/item/add-post.md b/commands/menu/item/add-post.md index a1f64d61..dedf299d 100644 --- a/commands/menu/item/add-post.md +++ b/commands/menu/item/add-post.md @@ -53,11 +53,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/item/add-term.md b/commands/menu/item/add-term.md index 0b9224d0..bf3bf165 100644 --- a/commands/menu/item/add-term.md +++ b/commands/menu/item/add-term.md @@ -56,11 +56,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/item/delete.md b/commands/menu/item/delete.md index 30213d99..44275052 100644 --- a/commands/menu/item/delete.md +++ b/commands/menu/item/delete.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/item/list.md b/commands/menu/item/list.md index 4373a927..c16ced40 100644 --- a/commands/menu/item/list.md +++ b/commands/menu/item/list.md @@ -67,11 +67,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/item/update.md b/commands/menu/item/update.md index 41c3c3a3..c6e12c5c 100644 --- a/commands/menu/item/update.md +++ b/commands/menu/item/update.md @@ -47,11 +47,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/list.md b/commands/menu/list.md index 44c5e870..8602eab2 100644 --- a/commands/menu/list.md +++ b/commands/menu/list.md @@ -59,11 +59,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/location/assign.md b/commands/menu/location/assign.md index 56e8e7b7..289fee92 100644 --- a/commands/menu/location/assign.md +++ b/commands/menu/location/assign.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/location/list.md b/commands/menu/location/list.md index b0692f9e..1a83bd7b 100644 --- a/commands/menu/location/list.md +++ b/commands/menu/location/list.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/menu/location/remove.md b/commands/menu/location/remove.md index 7de217ca..f5638cde 100644 --- a/commands/menu/location/remove.md +++ b/commands/menu/location/remove.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/network/meta/add.md b/commands/network/meta/add.md index 8d8b2971..304e2ed0 100644 --- a/commands/network/meta/add.md +++ b/commands/network/meta/add.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/network/meta/delete.md b/commands/network/meta/delete.md index a90518c3..d04caa41 100644 --- a/commands/network/meta/delete.md +++ b/commands/network/meta/delete.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/network/meta/get.md b/commands/network/meta/get.md index e4208833..9042f911 100644 --- a/commands/network/meta/get.md +++ b/commands/network/meta/get.md @@ -11,7 +11,14 @@ Get meta field value. : The name of the meta field to get. [\--format=<format>] -: Accepted values: table, json. Default: table +: Get value in a particular format. +\--- +default: var_export +options: + - var_export + - json + - yaml +\--- ### GLOBAL PARAMETERS @@ -24,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/network/meta/list.md b/commands/network/meta/list.md index 03fc1124..ab32adc3 100644 --- a/commands/network/meta/list.md +++ b/commands/network/meta/list.md @@ -14,7 +14,16 @@ List all metadata associated with an object. : Limit the output to specific row fields. Defaults to id,meta_key,meta_value. [\--format=<format>] -: Accepted values: table, csv, json, count. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count +\--- [\--orderby=<fields>] : Set orderby which field. @@ -46,11 +55,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/network/meta/patch.md b/commands/network/meta/patch.md index 7d6c72b0..ee2dbe73 100644 --- a/commands/network/meta/patch.md +++ b/commands/network/meta/patch.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/network/meta/pluck.md b/commands/network/meta/pluck.md index 860ebe66..e43583a7 100644 --- a/commands/network/meta/pluck.md +++ b/commands/network/meta/pluck.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/network/meta/update.md b/commands/network/meta/update.md index 45475bfe..0b63dfa3 100644 --- a/commands/network/meta/update.md +++ b/commands/network/meta/update.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/option/add.md b/commands/option/add.md index 7e296278..11402066 100644 --- a/commands/option/add.md +++ b/commands/option/add.md @@ -46,11 +46,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/option/delete.md b/commands/option/delete.md index b59100b1..9bef402a 100644 --- a/commands/option/delete.md +++ b/commands/option/delete.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/option/get.md b/commands/option/get.md index a22b6ac9..7ac63aee 100644 --- a/commands/option/get.md +++ b/commands/option/get.md @@ -50,11 +50,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/option/list.md b/commands/option/list.md index 45a365f1..e83108a2 100644 --- a/commands/option/list.md +++ b/commands/option/list.md @@ -16,6 +16,9 @@ Lists options and their values. [\--transients] : List only transients. Use `--no-transients` to ignore all transients. +[\--unserialize] +: Unserialize option values in output. + [\--field=<field>] : Prints the value of a single field. @@ -106,11 +109,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/option/patch.md b/commands/option/patch.md index a9ff223c..029821b6 100644 --- a/commands/option/patch.md +++ b/commands/option/patch.md @@ -42,11 +42,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/option/pluck.md b/commands/option/pluck.md index 5a428d24..fe0f6744 100644 --- a/commands/option/pluck.md +++ b/commands/option/pluck.md @@ -31,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/option/update.md b/commands/option/update.md index 5144e9c1..439c8dd6 100644 --- a/commands/option/update.md +++ b/commands/option/update.md @@ -69,11 +69,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/package/browse.md b/commands/package/browse.md index 087ab9aa..a0e16b47 100644 --- a/commands/package/browse.md +++ b/commands/package/browse.md @@ -63,11 +63,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/package/install.md b/commands/package/install.md index 0c651434..35cdd70e 100644 --- a/commands/package/install.md +++ b/commands/package/install.md @@ -60,11 +60,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/package/list.md b/commands/package/list.md index 4392c1c8..c5255d48 100644 --- a/commands/package/list.md +++ b/commands/package/list.md @@ -53,11 +53,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/package/path.md b/commands/package/path.md index a4b640cc..f0a4ba57 100644 --- a/commands/package/path.md +++ b/commands/package/path.md @@ -30,11 +30,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/package/uninstall.md b/commands/package/uninstall.md index 29a1f681..dfb0e330 100644 --- a/commands/package/uninstall.md +++ b/commands/package/uninstall.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/package/update.md b/commands/package/update.md index f3da77b3..cfdfdfd0 100644 --- a/commands/package/update.md +++ b/commands/package/update.md @@ -29,11 +29,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/activate.md b/commands/plugin/activate.md index 1b47fb44..e5632104 100644 --- a/commands/plugin/activate.md +++ b/commands/plugin/activate.md @@ -36,11 +36,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/deactivate.md b/commands/plugin/deactivate.md index c4ab966b..98bce056 100644 --- a/commands/plugin/deactivate.md +++ b/commands/plugin/deactivate.md @@ -34,11 +34,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/delete.md b/commands/plugin/delete.md index 8245ca05..5f94e378 100644 --- a/commands/plugin/delete.md +++ b/commands/plugin/delete.md @@ -4,9 +4,12 @@ Deletes plugin files without deactivating or uninstalling. ### OPTIONS -<plugin>... +[<plugin>...] : One or more plugins to delete. +[\--all] +: If set, all plugins will be deleted. + ### EXAMPLES # Delete plugin @@ -30,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/get.md b/commands/plugin/get.md index ef6f7489..084a90a1 100644 --- a/commands/plugin/get.md +++ b/commands/plugin/get.md @@ -40,11 +40,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/install.md b/commands/plugin/install.md index 202b660a..122eb627 100644 --- a/commands/plugin/install.md +++ b/commands/plugin/install.md @@ -87,11 +87,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/is-active.md b/commands/plugin/is-active.md new file mode 100644 index 00000000..8819f657 --- /dev/null +++ b/commands/plugin/is-active.md @@ -0,0 +1,37 @@ +# wp plugin is-active + +Checks if a given plugin is active. + +Returns exit code 0 when active, 1 when not active. + +### OPTIONS + +<plugin> +: The plugin to check. + +### EXAMPLES + + # Check whether plugin is Active; exit status 0 if active, otherwise 1 + $ wp plugin is-active hello + $ echo $? + 1 + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/is-installed.md b/commands/plugin/is-installed.md index d75eda8c..d90f30c0 100644 --- a/commands/plugin/is-installed.md +++ b/commands/plugin/is-installed.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/list.md b/commands/plugin/list.md index 02fb6257..7b77c757 100644 --- a/commands/plugin/list.md +++ b/commands/plugin/list.md @@ -78,11 +78,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/path.md b/commands/plugin/path.md index 94244cf4..a760a26f 100644 --- a/commands/plugin/path.md +++ b/commands/plugin/path.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/search.md b/commands/plugin/search.md index 9a388e7d..693e8c99 100644 --- a/commands/plugin/search.md +++ b/commands/plugin/search.md @@ -53,6 +53,7 @@ default: 10 **icons**: Plugin's Icon Image Link **active_installs**: Plugin's Number of Active Installs **contributors**: Plugin's List of Contributors + **url**: Plugin's URL on wordpress.org [\--format=<format>] : Render output in a particular format. @@ -93,11 +94,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/status.md b/commands/plugin/status.md index af63686d..ad3641cd 100644 --- a/commands/plugin/status.md +++ b/commands/plugin/status.md @@ -39,11 +39,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/toggle.md b/commands/plugin/toggle.md index 2cb75183..a9da7b5d 100644 --- a/commands/plugin/toggle.md +++ b/commands/plugin/toggle.md @@ -35,11 +35,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/uninstall.md b/commands/plugin/uninstall.md index dbfb460c..a23e8181 100644 --- a/commands/plugin/uninstall.md +++ b/commands/plugin/uninstall.md @@ -4,7 +4,7 @@ Uninstalls one or more plugins. ### OPTIONS -<plugin>... +[<plugin>...] : One or more plugins to uninstall. [\--deactivate] @@ -13,6 +13,9 @@ Uninstalls one or more plugins. [\--skip-delete] : If set, the plugin files will not be deleted. Only the uninstall procedure will be run. +[\--all] +: If set, all plugins will be uninstalled. + ### EXAMPLES $ wp plugin uninstall hello @@ -30,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/update.md b/commands/plugin/update.md index 8eec2536..c9524c44 100644 --- a/commands/plugin/update.md +++ b/commands/plugin/update.md @@ -93,11 +93,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/plugin/verify-checksums.md b/commands/plugin/verify-checksums.md index e9286ca3..b921dbaa 100644 --- a/commands/plugin/verify-checksums.md +++ b/commands/plugin/verify-checksums.md @@ -46,11 +46,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post-type/get.md b/commands/post-type/get.md index 680d1d17..13f5ef32 100644 --- a/commands/post-type/get.md +++ b/commands/post-type/get.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post-type/list.md b/commands/post-type/list.md index 8f659d6b..7d94ae3f 100644 --- a/commands/post-type/list.md +++ b/commands/post-type/list.md @@ -71,11 +71,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/create.md b/commands/post/create.md index d1b1bf51..a7e90be6 100644 --- a/commands/post/create.md +++ b/commands/post/create.md @@ -43,6 +43,9 @@ Creates a new post. [\--post_name=<post_name>] : The post name. Default is the sanitized post title when creating a new post. +[\--from-post=<post_id>] +: Post id of a post to be duplicated. + [\--to_ping=<to_ping>] : Space or carriage return-separated list of URLs to ping. Default empty. @@ -113,6 +116,10 @@ Creates a new post. $ wp post create --post_title='A post' --post_content='Just a small post.' --meta_input='{"key1":"value1","key2":"value2"} Success: Created post 1923. + # Create a duplicate post from existing posts. + $ wp post create --from-post=123 --post_title='Different Title' + Success: Created post 2350. + ### GLOBAL PARAMETERS These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. @@ -124,11 +131,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/delete.md b/commands/post/delete.md index 238107ac..79b40a35 100644 --- a/commands/post/delete.md +++ b/commands/post/delete.md @@ -40,11 +40,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/edit.md b/commands/post/edit.md index a879dbbe..743a24ae 100644 --- a/commands/post/edit.md +++ b/commands/post/edit.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/generate.md b/commands/post/generate.md index b4b05e9f..e0c7d92c 100644 --- a/commands/post/generate.md +++ b/commands/post/generate.md @@ -39,6 +39,9 @@ default: [\--post_date=<yyyy-mm-dd-hh-ii-ss>] : The date of the generated posts. Default: current date +[\--post_date_gmt=<yyyy-mm-dd-hh-ii-ss>] +: The GMT date of the generated posts. Default: value of post_date (or current date if it's not set) + [\--post_content] : If set, the command reads the post_content from STDIN. @@ -87,11 +90,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/get.md b/commands/post/get.md index b6370712..ccf8e36c 100644 --- a/commands/post/get.md +++ b/commands/post/get.md @@ -40,11 +40,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/list.md b/commands/post/list.md index e1e30aa5..c7ae58f6 100644 --- a/commands/post/list.md +++ b/commands/post/list.md @@ -104,11 +104,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/meta/add.md b/commands/post/meta/add.md index dca46cae..7ffd1a13 100644 --- a/commands/post/meta/add.md +++ b/commands/post/meta/add.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/meta/delete.md b/commands/post/meta/delete.md index 7e43d2b5..a5c33aa0 100644 --- a/commands/post/meta/delete.md +++ b/commands/post/meta/delete.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/meta/get.md b/commands/post/meta/get.md index 272eac57..6ff6c32c 100644 --- a/commands/post/meta/get.md +++ b/commands/post/meta/get.md @@ -11,7 +11,14 @@ Get meta field value. : The name of the meta field to get. [\--format=<format>] -: Accepted values: table, json. Default: table +: Get value in a particular format. +\--- +default: var_export +options: + - var_export + - json + - yaml +\--- ### GLOBAL PARAMETERS @@ -24,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/meta/list.md b/commands/post/meta/list.md index 3c6344f4..db715b74 100644 --- a/commands/post/meta/list.md +++ b/commands/post/meta/list.md @@ -14,7 +14,16 @@ List all metadata associated with an object. : Limit the output to specific row fields. Defaults to id,meta_key,meta_value. [\--format=<format>] -: Accepted values: table, csv, json, count. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count +\--- [\--orderby=<fields>] : Set orderby which field. @@ -46,11 +55,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/meta/patch.md b/commands/post/meta/patch.md index 053fa9ba..d78bfed6 100644 --- a/commands/post/meta/patch.md +++ b/commands/post/meta/patch.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/meta/pluck.md b/commands/post/meta/pluck.md index 92b9cf7b..bbb9b330 100644 --- a/commands/post/meta/pluck.md +++ b/commands/post/meta/pluck.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/meta/update.md b/commands/post/meta/update.md index 162618ab..1d2d890f 100644 --- a/commands/post/meta/update.md +++ b/commands/post/meta/update.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/term/add.md b/commands/post/term/add.md index 829f3454..cd35d769 100644 --- a/commands/post/term/add.md +++ b/commands/post/term/add.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/term/list.md b/commands/post/term/list.md index 26b2547b..b83bac1e 100644 --- a/commands/post/term/list.md +++ b/commands/post/term/list.md @@ -15,7 +15,17 @@ List all terms associated with an object. : Limit the output to specific row fields. [\--format=<format>] -: Accepted values: table, csv, json, count, ids. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count + - ids +\--- ### AVAILABLE FIELDS @@ -45,11 +55,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/term/remove.md b/commands/post/term/remove.md index 0c497258..baeba674 100644 --- a/commands/post/term/remove.md +++ b/commands/post/term/remove.md @@ -35,11 +35,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/term/set.md b/commands/post/term/set.md index 80480f2c..af10039a 100644 --- a/commands/post/term/set.md +++ b/commands/post/term/set.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/post/update.md b/commands/post/update.md index a4321356..11000443 100644 --- a/commands/post/update.md +++ b/commands/post/update.md @@ -115,11 +115,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/profile/eval-file.md b/commands/profile/eval-file.md index ea766e25..1b30ce2d 100644 --- a/commands/profile/eval-file.md +++ b/commands/profile/eval-file.md @@ -49,11 +49,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/profile/eval.md b/commands/profile/eval.md index ecc3f088..8b2af0db 100644 --- a/commands/profile/eval.md +++ b/commands/profile/eval.md @@ -49,11 +49,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/profile/hook.md b/commands/profile/hook.md index f6181c7b..d9995a17 100644 --- a/commands/profile/hook.md +++ b/commands/profile/hook.md @@ -55,11 +55,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/profile/stage.md b/commands/profile/stage.md index e44bec27..c891b0a4 100644 --- a/commands/profile/stage.md +++ b/commands/profile/stage.md @@ -89,11 +89,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/rewrite/flush.md b/commands/rewrite/flush.md index 9ea9720a..814a0014 100644 --- a/commands/rewrite/flush.md +++ b/commands/rewrite/flush.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/rewrite/list.md b/commands/rewrite/list.md index a2b1c051..e1d3a825 100644 --- a/commands/rewrite/list.md +++ b/commands/rewrite/list.md @@ -46,11 +46,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/rewrite/structure.md b/commands/rewrite/structure.md index d9bfbe23..5664635a 100644 --- a/commands/rewrite/structure.md +++ b/commands/rewrite/structure.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/role/create.md b/commands/role/create.md index 68cc9d4e..174b3c29 100644 --- a/commands/role/create.md +++ b/commands/role/create.md @@ -34,11 +34,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/role/delete.md b/commands/role/delete.md index ec48eaa4..ae603b3c 100644 --- a/commands/role/delete.md +++ b/commands/role/delete.md @@ -28,11 +28,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/role/exists.md b/commands/role/exists.md index e1e9a463..809f4220 100644 --- a/commands/role/exists.md +++ b/commands/role/exists.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/role/list.md b/commands/role/list.md index 9fe2b075..8a00472b 100644 --- a/commands/role/list.md +++ b/commands/role/list.md @@ -7,6 +7,9 @@ Lists all roles. [\--fields=<fields>] : Limit the output to specific object fields. +[\--field=<field>] +: Prints the value of a single field. + [\--format=<format>] : Render output in a particular format. \--- @@ -50,11 +53,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/role/reset.md b/commands/role/reset.md index 26ac129a..6a1ee71f 100644 --- a/commands/role/reset.md +++ b/commands/role/reset.md @@ -31,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/_s.md b/commands/scaffold/_s.md index 5d9c6a8a..d35941ff 100644 --- a/commands/scaffold/_s.md +++ b/commands/scaffold/_s.md @@ -27,6 +27,9 @@ See the [Underscores website](https://underscores.me/) for more details. [\--sassify] : Include stylesheets as SASS. +[\--woocommerce] +: Include WooCommerce boilerplate files. + [\--force] : Overwrite files that already exist. @@ -47,11 +50,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/block.md b/commands/scaffold/block.md index 543fabce..9c24cff9 100644 --- a/commands/scaffold/block.md +++ b/commands/scaffold/block.md @@ -69,11 +69,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/child-theme.md b/commands/scaffold/child-theme.md index 3cc407ef..89d522ab 100644 --- a/commands/scaffold/child-theme.md +++ b/commands/scaffold/child-theme.md @@ -50,11 +50,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/plugin-tests.md b/commands/scaffold/plugin-tests.md index c4bad486..f3a845bc 100644 --- a/commands/scaffold/plugin-tests.md +++ b/commands/scaffold/plugin-tests.md @@ -9,7 +9,7 @@ The following files are generated by default: * `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.xml.dist` is a collection of PHP_CodeSniffer rules. +* `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules. Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/). @@ -33,6 +33,7 @@ options: - travis - circle - gitlab + - bitbucket \--- [\--force] @@ -55,11 +56,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/plugin.md b/commands/scaffold/plugin.md index 25e9f815..28d14636 100644 --- a/commands/scaffold/plugin.md +++ b/commands/scaffold/plugin.md @@ -19,7 +19,7 @@ The following files are also included unless the `--skip-tests` is used: * `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.xml.dist` is a collection of PHP_CodeSniffer rules. +* `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules. ### OPTIONS @@ -83,11 +83,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/post-type.md b/commands/scaffold/post-type.md index 6c8bc5a3..53ef165f 100644 --- a/commands/scaffold/post-type.md +++ b/commands/scaffold/post-type.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/taxonomy.md b/commands/scaffold/taxonomy.md index 4bf46cd7..cda74061 100644 --- a/commands/scaffold/taxonomy.md +++ b/commands/scaffold/taxonomy.md @@ -44,11 +44,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/scaffold/theme-tests.md b/commands/scaffold/theme-tests.md index 01dac308..a398bbb3 100644 --- a/commands/scaffold/theme-tests.md +++ b/commands/scaffold/theme-tests.md @@ -9,7 +9,7 @@ The following files are generated by default: * `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.xml.dist` is a collection of PHP_CodeSniffer rules. +* `.phpcs.xml.dist` is a collection of PHP_CodeSniffer rules. Learn more from the [plugin unit tests documentation](https://make.wordpress.org/cli/handbook/plugin-unit-tests/). @@ -33,6 +33,7 @@ options: - travis - circle - gitlab + - bitbucket \--- [\--force] @@ -55,11 +56,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/search-replace.md b/commands/search-replace.md index 7f227180..e06296b6 100644 --- a/commands/search-replace.md +++ b/commands/search-replace.md @@ -64,6 +64,9 @@ Search/replace intelligently handles PHP serialized data, and does not change pr [\--regex-delimiter=<regex-delimiter>] : The delimiter to use for the regex. It must be escaped if it appears in the search string. The default value is the result of `chr(1)`. +[\--regex-limit=<regex-limit>] +: The maximum possible replacements for the regex per row (or per unserialized data bit per row). Defaults to -1 (no limit). + [\--format=<format>] : Render output in a particular format. \--- @@ -124,11 +127,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/server.md b/commands/server.md index d42d5360..4596a2e0 100644 --- a/commands/server.md +++ b/commands/server.md @@ -61,11 +61,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/shell.md b/commands/shell.md index 797c8bdb..6b0562af 100644 --- a/commands/shell.md +++ b/commands/shell.md @@ -7,7 +7,7 @@ Opens an interactive PHP console for running and testing PHP code. ### OPTIONS [\--basic] -: Start in fail-safe mode, even if Boris is available. +: Force the use of WP-CLI's built-in PHP REPL, even if the Boris or PsySH PHP REPLs are available. ### EXAMPLES @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/sidebar/list.md b/commands/sidebar/list.md index 035d6136..99898486 100644 --- a/commands/sidebar/list.md +++ b/commands/sidebar/list.md @@ -54,11 +54,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/activate.md b/commands/site/activate.md index e0010bc4..b2c745fb 100644 --- a/commands/site/activate.md +++ b/commands/site/activate.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/archive.md b/commands/site/archive.md index af9021e5..5b9d427d 100644 --- a/commands/site/archive.md +++ b/commands/site/archive.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/create.md b/commands/site/create.md index d989fab2..5b00b8b0 100644 --- a/commands/site/create.md +++ b/commands/site/create.md @@ -38,11 +38,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/deactivate.md b/commands/site/deactivate.md index d45c194a..a072bd92 100644 --- a/commands/site/deactivate.md +++ b/commands/site/deactivate.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/delete.md b/commands/site/delete.md index a941dd48..4bfb7858 100644 --- a/commands/site/delete.md +++ b/commands/site/delete.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/empty.md b/commands/site/empty.md index dccc5d02..5cb3369a 100644 --- a/commands/site/empty.md +++ b/commands/site/empty.md @@ -43,11 +43,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/list.md b/commands/site/list.md index 71f51e07..ff7f1b9e 100644 --- a/commands/site/list.md +++ b/commands/site/list.md @@ -72,11 +72,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/mature.md b/commands/site/mature.md index c2fecce9..d316019f 100644 --- a/commands/site/mature.md +++ b/commands/site/mature.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/meta.md b/commands/site/meta.md new file mode 100644 index 00000000..5aa0e8f3 --- /dev/null +++ b/commands/site/meta.md @@ -0,0 +1,25 @@ +# wp site meta + +Adds, updates, deletes, and lists site custom fields. + +### EXAMPLES + + # Set site meta + $ wp site meta set 123 bio "Mary is a WordPress developer." + Success: Updated custom field 'bio'. + + # Get site meta + $ wp site meta get 123 bio + Mary is a WordPress developer. + + # Update site meta + $ wp site meta update 123 bio "Mary is an awesome WordPress developer." + Success: Updated custom field 'bio'. + + # Delete site meta + $ wp site meta delete 123 bio + Success: Deleted custom field. + + + + diff --git a/commands/site/meta/add.md b/commands/site/meta/add.md new file mode 100644 index 00000000..dc955267 --- /dev/null +++ b/commands/site/meta/add.md @@ -0,0 +1,43 @@ +# wp site meta add + +Add a meta field. + +### 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 +\--- + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/meta/delete.md b/commands/site/meta/delete.md new file mode 100644 index 00000000..99a4ae30 --- /dev/null +++ b/commands/site/meta/delete.md @@ -0,0 +1,37 @@ +# wp site meta delete + +Delete a meta field. + +### OPTIONS + +<id> +: The ID of the object. + +[<key>] +: The name of the meta field to delete. + +[<value>] +: The value to delete. If omitted, all rows with key will deleted. + +[\--all] +: Delete all meta for the object. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/meta/get.md b/commands/site/meta/get.md new file mode 100644 index 00000000..4ce56e8c --- /dev/null +++ b/commands/site/meta/get.md @@ -0,0 +1,41 @@ +# wp site meta get + +Get meta field value. + +### OPTIONS + +<id> +: The ID of the object. + +<key> +: The name of the meta field to get. + +[\--format=<format>] +: Get value in a particular format. +\--- +default: var_export +options: + - var_export + - json + - yaml +\--- + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/meta/list.md b/commands/site/meta/list.md new file mode 100644 index 00000000..97671b1b --- /dev/null +++ b/commands/site/meta/list.md @@ -0,0 +1,65 @@ +# wp site meta list + +List all metadata associated with an object. + +### OPTIONS + +<id> +: ID for the object. + +[\--keys=<keys>] +: Limit output to metadata of specific keys. + +[\--fields=<fields>] +: Limit the output to specific row fields. Defaults to id,meta_key,meta_value. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count +\--- + +[\--orderby=<fields>] +: Set orderby which field. +\--- +default: id +options: + - id + - meta_key + - meta_value +\--- + +[\--order=<order>] +: Set ascending or descending order. +\--- +default: asc +options: + - asc + - desc +\--- + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/meta/patch.md b/commands/site/meta/patch.md new file mode 100644 index 00000000..6765b4b7 --- /dev/null +++ b/commands/site/meta/patch.md @@ -0,0 +1,55 @@ +# wp site meta patch + +Update a nested value for a meta field. + +### OPTIONS + +<action> +: Patch action to perform. +\--- +options: + - insert + - update + - delete +\--- + +<id> +: The ID of the object. + +<key> +: The name of the meta field to update. + +<key-path>... +: The name(s) of the keys within the value to locate the value to patch. + +[<value>] +: The new value. If omitted, the value is read from STDIN. + +[\--format=<format>] +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/meta/pluck.md b/commands/site/meta/pluck.md new file mode 100644 index 00000000..bae49f5d --- /dev/null +++ b/commands/site/meta/pluck.md @@ -0,0 +1,43 @@ +# wp site meta pluck + +Get a nested value from a meta field. + +### OPTIONS + +<id> +: The ID of the object. + +<key> +: The name of the meta field to get. + +<key-path>... +: The name(s) of the keys within the value to locate the value to pluck. + +[\--format=<format>] +: The output format of the value. +\--- +default: plaintext +options: + - plaintext + - json + - yaml + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/meta/update.md b/commands/site/meta/update.md new file mode 100644 index 00000000..34e0372c --- /dev/null +++ b/commands/site/meta/update.md @@ -0,0 +1,43 @@ +# wp site meta update + +Update a meta field. + +### 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 +\--- + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/option.md b/commands/site/option.md index ae2aba98..be4c5f76 100644 --- a/commands/site/option.md +++ b/commands/site/option.md @@ -1,6 +1,6 @@ # wp site option -Adds, updates, deletes, and lists site options in a multisite install. +Adds, updates, deletes, and lists site options in a multisite installation. ### EXAMPLES diff --git a/commands/site/option/add.md b/commands/site/option/add.md index e5129e38..3a0956c4 100644 --- a/commands/site/option/add.md +++ b/commands/site/option/add.md @@ -36,11 +36,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/option/delete.md b/commands/site/option/delete.md index 1fb42abd..50f6e3df 100644 --- a/commands/site/option/delete.md +++ b/commands/site/option/delete.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/option/get.md b/commands/site/option/get.md index 628a15b2..94d47870 100644 --- a/commands/site/option/get.md +++ b/commands/site/option/get.md @@ -34,11 +34,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/option/list.md b/commands/site/option/list.md index 98125495..22cda129 100644 --- a/commands/site/option/list.md +++ b/commands/site/option/list.md @@ -63,11 +63,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/option/patch.md b/commands/site/option/patch.md index 28d0f603..564b84e9 100644 --- a/commands/site/option/patch.md +++ b/commands/site/option/patch.md @@ -42,11 +42,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/option/pluck.md b/commands/site/option/pluck.md index 3e6af731..47852aac 100644 --- a/commands/site/option/pluck.md +++ b/commands/site/option/pluck.md @@ -30,11 +30,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/option/update.md b/commands/site/option/update.md index 2e18388d..25031b90 100644 --- a/commands/site/option/update.md +++ b/commands/site/option/update.md @@ -36,11 +36,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/private.md b/commands/site/private.md index de444c63..8ea9425d 100644 --- a/commands/site/private.md +++ b/commands/site/private.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/public.md b/commands/site/public.md index c508912e..e71bb5b8 100644 --- a/commands/site/public.md +++ b/commands/site/public.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/spam.md b/commands/site/spam.md index 3cebbfb4..c402171c 100644 --- a/commands/site/spam.md +++ b/commands/site/spam.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/switch-language.md b/commands/site/switch-language.md new file mode 100644 index 00000000..1ad061d4 --- /dev/null +++ b/commands/site/switch-language.md @@ -0,0 +1,33 @@ +# wp site switch-language + +Activates a given language. + +### OPTIONS + +<language> +: Language code to activate. + +### EXAMPLES + + $ wp site switch-language ja + Success: Language activated. + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/site/unarchive.md b/commands/site/unarchive.md index a6fc748f..7189f2d9 100644 --- a/commands/site/unarchive.md +++ b/commands/site/unarchive.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/unmature.md b/commands/site/unmature.md index 093ec1fb..29208300 100644 --- a/commands/site/unmature.md +++ b/commands/site/unmature.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/site/unspam.md b/commands/site/unspam.md index 792809d9..d2e53d81 100644 --- a/commands/site/unspam.md +++ b/commands/site/unspam.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/super-admin/add.md b/commands/super-admin/add.md index 3d4f2da5..6df42722 100644 --- a/commands/super-admin/add.md +++ b/commands/super-admin/add.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/super-admin/list.md b/commands/super-admin/list.md index 19121b3c..84bd07d0 100644 --- a/commands/super-admin/list.md +++ b/commands/super-admin/list.md @@ -35,11 +35,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/super-admin/remove.md b/commands/super-admin/remove.md index 8707ea2d..52c078c9 100644 --- a/commands/super-admin/remove.md +++ b/commands/super-admin/remove.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/taxonomy/get.md b/commands/taxonomy/get.md index 407ff1b0..7f701207 100644 --- a/commands/taxonomy/get.md +++ b/commands/taxonomy/get.md @@ -51,11 +51,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/taxonomy/list.md b/commands/taxonomy/list.md index 9a42024f..50248794 100644 --- a/commands/taxonomy/list.md +++ b/commands/taxonomy/list.md @@ -69,11 +69,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/create.md b/commands/term/create.md index a732db7b..89136e40 100644 --- a/commands/term/create.md +++ b/commands/term/create.md @@ -39,11 +39,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/delete.md b/commands/term/delete.md index 6aa813ca..3e47f967 100644 --- a/commands/term/delete.md +++ b/commands/term/delete.md @@ -51,11 +51,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/generate.md b/commands/term/generate.md index 66ac91fd..2a00fa30 100644 --- a/commands/term/generate.md +++ b/commands/term/generate.md @@ -53,11 +53,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/get.md b/commands/term/get.md index 2af7efc7..3c5edf41 100644 --- a/commands/term/get.md +++ b/commands/term/get.md @@ -57,11 +57,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/list.md b/commands/term/list.md index acf57ecf..3277871c 100644 --- a/commands/term/list.md +++ b/commands/term/list.md @@ -77,11 +77,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/meta/add.md b/commands/term/meta/add.md index b03a4a2a..67cbcba4 100644 --- a/commands/term/meta/add.md +++ b/commands/term/meta/add.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/meta/delete.md b/commands/term/meta/delete.md index 68854ece..889091e0 100644 --- a/commands/term/meta/delete.md +++ b/commands/term/meta/delete.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/meta/get.md b/commands/term/meta/get.md index fb2acf7d..346ddf16 100644 --- a/commands/term/meta/get.md +++ b/commands/term/meta/get.md @@ -11,7 +11,14 @@ Get meta field value. : The name of the meta field to get. [\--format=<format>] -: Accepted values: table, json. Default: table +: Get value in a particular format. +\--- +default: var_export +options: + - var_export + - json + - yaml +\--- ### GLOBAL PARAMETERS @@ -24,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/meta/list.md b/commands/term/meta/list.md index 8c0824e2..9ffd6276 100644 --- a/commands/term/meta/list.md +++ b/commands/term/meta/list.md @@ -14,7 +14,16 @@ List all metadata associated with an object. : Limit the output to specific row fields. Defaults to id,meta_key,meta_value. [\--format=<format>] -: Accepted values: table, csv, json, count. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count +\--- [\--orderby=<fields>] : Set orderby which field. @@ -46,11 +55,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/meta/patch.md b/commands/term/meta/patch.md index 94ca137d..8c910a70 100644 --- a/commands/term/meta/patch.md +++ b/commands/term/meta/patch.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/meta/pluck.md b/commands/term/meta/pluck.md index 6e69e210..c862333d 100644 --- a/commands/term/meta/pluck.md +++ b/commands/term/meta/pluck.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/meta/update.md b/commands/term/meta/update.md index 97f9f5bf..3b4eb598 100644 --- a/commands/term/meta/update.md +++ b/commands/term/meta/update.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/recount.md b/commands/term/recount.md index 4e266961..40e44b16 100644 --- a/commands/term/recount.md +++ b/commands/term/recount.md @@ -37,11 +37,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/term/update.md b/commands/term/update.md index ae010c69..da8916d9 100644 --- a/commands/term/update.md +++ b/commands/term/update.md @@ -52,11 +52,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/activate.md b/commands/theme/activate.md index 0280a061..c9ba6ab0 100644 --- a/commands/theme/activate.md +++ b/commands/theme/activate.md @@ -23,11 +23,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/delete.md b/commands/theme/delete.md index 7afd38b2..a9966fea 100644 --- a/commands/theme/delete.md +++ b/commands/theme/delete.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/disable.md b/commands/theme/disable.md index 28e93070..e144fe47 100644 --- a/commands/theme/disable.md +++ b/commands/theme/disable.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/enable.md b/commands/theme/enable.md index 0513d045..3774e174 100644 --- a/commands/theme/enable.md +++ b/commands/theme/enable.md @@ -41,11 +41,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/get.md b/commands/theme/get.md index 01da10c4..5422d4a6 100644 --- a/commands/theme/get.md +++ b/commands/theme/get.md @@ -46,11 +46,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/install.md b/commands/theme/install.md index 55f3a3e1..0821f420 100644 --- a/commands/theme/install.md +++ b/commands/theme/install.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/is-active.md b/commands/theme/is-active.md new file mode 100644 index 00000000..0e32b5fc --- /dev/null +++ b/commands/theme/is-active.md @@ -0,0 +1,37 @@ +# wp theme is-active + +Checks if a given theme is active. + +Returns exit code 0 when active, 1 when not active. + +### OPTIONS + +<theme> +: The plugin to check. + +### EXAMPLES + + # Check whether theme is Active; exit status 0 if active, otherwise 1 + $ wp theme is-active twentyfifteen + $ echo $? + 1 + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/theme/is-installed.md b/commands/theme/is-installed.md index 5558dbd7..eae9e8fe 100644 --- a/commands/theme/is-installed.md +++ b/commands/theme/is-installed.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/list.md b/commands/theme/list.md index 5cedcf87..da763763 100644 --- a/commands/theme/list.md +++ b/commands/theme/list.md @@ -61,11 +61,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/mod/get.md b/commands/theme/mod/get.md index 5136b9db..eb4306c8 100644 --- a/commands/theme/mod/get.md +++ b/commands/theme/mod/get.md @@ -64,11 +64,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/mod/list.md b/commands/theme/mod/list.md new file mode 100644 index 00000000..0ef539ee --- /dev/null +++ b/commands/theme/mod/list.md @@ -0,0 +1,51 @@ +# wp theme mod list + +Gets a list of theme mods. + +### OPTIONS + +[\--field=<field>] +: Returns the value of a single field. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - json + - csv + - yaml +\--- + +### EXAMPLES + + # Gets a list of theme mods. + $ wp theme mod list + +------------------+---------+ + | key | value | + +------------------+---------+ + | background_color | dd3333 | + | link_color | #dd9933 | + | main_text_color | #8224e3 | + +------------------+---------+ + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/theme/mod/remove.md b/commands/theme/mod/remove.md index 03ae1982..38325d58 100644 --- a/commands/theme/mod/remove.md +++ b/commands/theme/mod/remove.md @@ -35,11 +35,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/mod/set.md b/commands/theme/mod/set.md index eb4b32f4..251f703e 100644 --- a/commands/theme/mod/set.md +++ b/commands/theme/mod/set.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/path.md b/commands/theme/path.md index c381e3e7..e25f7cfa 100644 --- a/commands/theme/path.md +++ b/commands/theme/path.md @@ -30,11 +30,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/search.md b/commands/theme/search.md index 747f1c4f..9738b51f 100644 --- a/commands/theme/search.md +++ b/commands/theme/search.md @@ -28,6 +28,7 @@ Displays themes in the WordPress.org theme directory matching a given search que **num_ratings**: Number of Theme Ratings **homepage**: Theme Author's Homepage **description**: Theme Description + **url**: Theme's URL on wordpress.org [\--format=<format>] : Render output in a particular format. @@ -67,11 +68,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/status.md b/commands/theme/status.md index 538a5503..49a944fd 100644 --- a/commands/theme/status.md +++ b/commands/theme/status.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/theme/update.md b/commands/theme/update.md index 351b7e00..e9314d98 100644 --- a/commands/theme/update.md +++ b/commands/theme/update.md @@ -86,11 +86,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/transient/delete.md b/commands/transient/delete.md index bbc12585..f2233b0c 100644 --- a/commands/transient/delete.md +++ b/commands/transient/delete.md @@ -43,11 +43,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/transient/get.md b/commands/transient/get.md index 77b71a73..405d7400 100644 --- a/commands/transient/get.md +++ b/commands/transient/get.md @@ -42,11 +42,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/transient/set.md b/commands/transient/set.md index 6059cdb1..1bfebaf2 100644 --- a/commands/transient/set.md +++ b/commands/transient/set.md @@ -36,11 +36,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/transient/type.md b/commands/transient/type.md index 7702b1f6..43723149 100644 --- a/commands/transient/type.md +++ b/commands/transient/type.md @@ -22,11 +22,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/add-cap.md b/commands/user/add-cap.md index 05d66bc5..e6a2bbb5 100644 --- a/commands/user/add-cap.md +++ b/commands/user/add-cap.md @@ -31,11 +31,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/add-role.md b/commands/user/add-role.md index 47c46589..33fd4432 100644 --- a/commands/user/add-role.md +++ b/commands/user/add-role.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/check-password.md b/commands/user/check-password.md new file mode 100644 index 00000000..73e43b54 --- /dev/null +++ b/commands/user/check-password.md @@ -0,0 +1,43 @@ +# wp user check-password + +Checks if a user's password is valid or not. + +### OPTIONS + +<user> +: The user login, user email or user ID of the user to check credentials for. + +<user_pass> +: A string that contains the plain text password for the user. + +### EXAMPLES + + # Check whether given credentials are valid; exit status 0 if valid, otherwise 1 + $ wp user check-password admin adminpass + $ echo $? + 1 + + # Bash script for checking whether given credentials are valid or not + if ! $(wp user check-password admin adminpass); then + notify-send "Invalid Credentials"; + fi + +### GLOBAL PARAMETERS + +These [global parameters](https://make.wordpress.org/cli/handbook/config/) have the same behavior across all commands and affect how WP-CLI interacts with WordPress. + +| **Argument** | **Description** | +|:----------------|:-----------------------------| +| `--path=` | Path to the WordPress files. | +| `--url=` | Pretend request came from given URL. In multisite, this argument is how the target site is specified. | +| `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | +| `--http=` | Perform operation against a remote WordPress install over HTTP. | +| `--user=` | Set the WordPress user. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | +| `--skip-packages` | Skip loading all installed packages. | +| `--require=` | Load PHP file before running the command (may be used more than once). | +| `--[no-]color` | Whether to colorize the output. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | +| `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | +| `--quiet` | Suppress informational messages. | diff --git a/commands/user/create.md b/commands/user/create.md index a6d30ca5..0ad490c5 100644 --- a/commands/user/create.md +++ b/commands/user/create.md @@ -28,9 +28,6 @@ Creates a new user. [\--user_url=<url>] : A string containing the user's URL for the user's web site. -[\--user_email=<email>] -: A string containing the user's email address. - [\--nickname=<nickname>] : The user's nickname, defaults to the user's username. @@ -74,11 +71,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/delete.md b/commands/user/delete.md index 4633c5e4..21ef6e0c 100644 --- a/commands/user/delete.md +++ b/commands/user/delete.md @@ -40,11 +40,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/generate.md b/commands/user/generate.md index 1833be41..0cd2634d 100644 --- a/commands/user/generate.md +++ b/commands/user/generate.md @@ -43,11 +43,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/get.md b/commands/user/get.md index 98d3487b..f67ed23e 100644 --- a/commands/user/get.md +++ b/commands/user/get.md @@ -44,11 +44,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/import-csv.md b/commands/user/import-csv.md index 8af130ea..ea654251 100644 --- a/commands/user/import-csv.md +++ b/commands/user/import-csv.md @@ -44,11 +44,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/list-caps.md b/commands/user/list-caps.md index fc270023..901903c2 100644 --- a/commands/user/list-caps.md +++ b/commands/user/list-caps.md @@ -37,11 +37,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/list.md b/commands/user/list.md index f7b91055..dc2906c0 100644 --- a/commands/user/list.md +++ b/commands/user/list.md @@ -90,11 +90,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/meta/add.md b/commands/user/meta/add.md index 3d4ba0a6..00b17ad4 100644 --- a/commands/user/meta/add.md +++ b/commands/user/meta/add.md @@ -14,7 +14,13 @@ Adds a meta field. : The new metadata value. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- ### EXAMPLES @@ -33,11 +39,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/meta/delete.md b/commands/user/meta/delete.md index a666bf20..e3eb8910 100644 --- a/commands/user/meta/delete.md +++ b/commands/user/meta/delete.md @@ -30,11 +30,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/meta/get.md b/commands/user/meta/get.md index 44fa1d0f..ca1200ab 100644 --- a/commands/user/meta/get.md +++ b/commands/user/meta/get.md @@ -38,11 +38,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/meta/list.md b/commands/user/meta/list.md index ef208d26..03f613e4 100644 --- a/commands/user/meta/list.md +++ b/commands/user/meta/list.md @@ -67,11 +67,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/meta/patch.md b/commands/user/meta/patch.md index 2bf3c659..b2a788b6 100644 --- a/commands/user/meta/patch.md +++ b/commands/user/meta/patch.md @@ -45,11 +45,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/meta/pluck.md b/commands/user/meta/pluck.md index 3abd4287..8cb45cd0 100644 --- a/commands/user/meta/pluck.md +++ b/commands/user/meta/pluck.md @@ -33,11 +33,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/meta/update.md b/commands/user/meta/update.md index 7d7a8160..d4ac4372 100644 --- a/commands/user/meta/update.md +++ b/commands/user/meta/update.md @@ -14,7 +14,13 @@ Updates a meta field. : The new metadata value. [\--format=<format>] -: The serialization format for the value. Default is plaintext. +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- ### EXAMPLES @@ -33,11 +39,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/remove-cap.md b/commands/user/remove-cap.md index b3f8eaa8..94eec553 100644 --- a/commands/user/remove-cap.md +++ b/commands/user/remove-cap.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/remove-role.md b/commands/user/remove-role.md index 4af5a538..bbec5298 100644 --- a/commands/user/remove-role.md +++ b/commands/user/remove-role.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/reset-password.md b/commands/user/reset-password.md index 5116fe23..e940fb7f 100644 --- a/commands/user/reset-password.md +++ b/commands/user/reset-password.md @@ -29,11 +29,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/session/destroy.md b/commands/user/session/destroy.md index 5732dc77..9987dc8e 100644 --- a/commands/user/session/destroy.md +++ b/commands/user/session/destroy.md @@ -43,11 +43,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/session/list.md b/commands/user/session/list.md index 2f37ad13..8731eab0 100644 --- a/commands/user/session/list.md +++ b/commands/user/session/list.md @@ -58,11 +58,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/set-role.md b/commands/user/set-role.md index 600b992c..61293e32 100644 --- a/commands/user/set-role.md +++ b/commands/user/set-role.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/spam.md b/commands/user/spam.md index f5932603..0c95c09b 100644 --- a/commands/user/spam.md +++ b/commands/user/spam.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/term/add.md b/commands/user/term/add.md index 91b2b897..d5c65ba6 100644 --- a/commands/user/term/add.md +++ b/commands/user/term/add.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/term/list.md b/commands/user/term/list.md index c803cbb2..0eee3fcd 100644 --- a/commands/user/term/list.md +++ b/commands/user/term/list.md @@ -15,7 +15,17 @@ List all terms associated with an object. : Limit the output to specific row fields. [\--format=<format>] -: Accepted values: table, csv, json, count, ids. Default: table +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count + - ids +\--- ### AVAILABLE FIELDS @@ -45,11 +55,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/term/remove.md b/commands/user/term/remove.md index 9897306c..d04f821a 100644 --- a/commands/user/term/remove.md +++ b/commands/user/term/remove.md @@ -35,11 +35,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/term/set.md b/commands/user/term/set.md index cab017e4..4b3ec649 100644 --- a/commands/user/term/set.md +++ b/commands/user/term/set.md @@ -32,11 +32,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/unspam.md b/commands/user/unspam.md index 464880b7..148891fd 100644 --- a/commands/user/unspam.md +++ b/commands/user/unspam.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/user/update.md b/commands/user/update.md index 0c8d65bd..1d9b9b6d 100644 --- a/commands/user/update.md +++ b/commands/user/update.md @@ -46,6 +46,9 @@ Updates an existing user. \--<field>=<value> : One or more fields to update. For accepted fields, see wp_update_user(). +[\--skip-email] +: Don't send an email notification to the user. + ### EXAMPLES # Update user @@ -63,11 +66,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/widget/add.md b/commands/widget/add.md index edab5bb3..5e37b009 100644 --- a/commands/widget/add.md +++ b/commands/widget/add.md @@ -35,11 +35,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/widget/deactivate.md b/commands/widget/deactivate.md index 0e9e81b5..97fa93d1 100644 --- a/commands/widget/deactivate.md +++ b/commands/widget/deactivate.md @@ -26,11 +26,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/widget/delete.md b/commands/widget/delete.md index 892db5c2..eade0b50 100644 --- a/commands/widget/delete.md +++ b/commands/widget/delete.md @@ -24,11 +24,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/widget/list.md b/commands/widget/list.md index e2cf43cb..89e30f02 100644 --- a/commands/widget/list.md +++ b/commands/widget/list.md @@ -52,11 +52,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/widget/move.md b/commands/widget/move.md index b6ba1fee..698d49a4 100644 --- a/commands/widget/move.md +++ b/commands/widget/move.md @@ -36,11 +36,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/widget/reset.md b/commands/widget/reset.md index 369f879f..3fe5d362 100644 --- a/commands/widget/reset.md +++ b/commands/widget/reset.md @@ -40,11 +40,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/commands/widget/update.md b/commands/widget/update.md index 551414f5..067cf395 100644 --- a/commands/widget/update.md +++ b/commands/widget/update.md @@ -27,11 +27,11 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--ssh=[:][@][:][]` | Perform operation against a remote server over SSH (or a container using scheme of "docker", "docker-compose", "vagrant"). | | `--http=` | Perform operation against a remote WordPress install over HTTP. | | `--user=` | Set the WordPress user. | -| `--skip-plugins[=]` | Skip loading all or some plugins. Note: mu-plugins are still loaded. | -| `--skip-themes[=]` | Skip loading all or some themes. | +| `--skip-plugins[=]` | Skip loading all plugins, or a comma-separated list of plugins. Note: mu-plugins are still loaded. | +| `--skip-themes[=]` | Skip loading all themes, or a comma-separated list of themes. | | `--skip-packages` | Skip loading all installed packages. | | `--require=` | Load PHP file before running the command (may be used more than once). | | `--[no-]color` | Whether to colorize the output. | -| `--debug[=]` | Show all PHP errors; add verbosity to WP-CLI bootstrap. | +| `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | diff --git a/internal-api.md b/internal-api.md index 70ce5f9b..83508cdb 100644 --- a/internal-api.md +++ b/internal-api.md @@ -128,6 +128,9 @@ This also means functions and methods not listed here are considered part of the
  • WP_CLI\Utils\trailingslashit() - Appends a trailing slash.
    • +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • + +
  • WP_CLI\Utils\get_temp_dir() - Get the system's temp directory. Warns user if it isn't writable.
    • diff --git a/internal-api/wp-cli-add-hook.md b/internal-api/wp-cli-add-hook.md index 197d1088..2fc9e16b 100644 --- a/internal-api/wp-cli-add-hook.md +++ b/internal-api/wp-cli-add-hook.md @@ -33,6 +33,7 @@ WP-CLI hooks include: * `before_wp_config_load` - After wp-config.php has been located. * `after_wp_config_load` - After wp-config.php has been loaded into scope. * `after_wp_load` - Just after the WP load process has completed. +* `before_run_command` - Just before the command is executed. WP-CLI commands can create their own hooks with `WP_CLI::do_hook()`. diff --git a/internal-api/wp-cli-get-php-binary.md b/internal-api/wp-cli-get-php-binary.md index a7aa830a..e9edb746 100644 --- a/internal-api/wp-cli-get-php-binary.md +++ b/internal-api/wp-cli-get-php-binary.md @@ -39,6 +39,9 @@ Note: moved to Utils, left for BC.
  • WP_CLI\Utils\trailingslashit() - Appends a trailing slash.
    • +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • + +
  • WP_CLI\Utils\get_temp_dir() - Get the system's temp directory. Warns user if it isn't writable.
    • diff --git a/internal-api/wp-cli-utils-get-home-dir.md b/internal-api/wp-cli-utils-get-home-dir.md index cdd4adf9..43baf242 100644 --- a/internal-api/wp-cli-utils-get-home-dir.md +++ b/internal-api/wp-cli-utils-get-home-dir.md @@ -27,6 +27,9 @@ Get the home directory.
  • WP_CLI\Utils\trailingslashit() - Appends a trailing slash.
    • +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • + +
  • WP_CLI\Utils\get_temp_dir() - Get the system's temp directory. Warns user if it isn't writable.
    • diff --git a/internal-api/wp-cli-utils-get-php-binary.md b/internal-api/wp-cli-utils-get-php-binary.md index 3fab721b..a16dc3b6 100644 --- a/internal-api/wp-cli-utils-get-php-binary.md +++ b/internal-api/wp-cli-utils-get-php-binary.md @@ -37,6 +37,9 @@ Environment values permit specific binaries to be indicated.
  • WP_CLI\Utils\trailingslashit() - Appends a trailing slash.
    • +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • + +
  • WP_CLI\Utils\get_temp_dir() - Get the system's temp directory. Warns user if it isn't writable.
    • diff --git a/internal-api/wp-cli-utils-get-temp-dir.md b/internal-api/wp-cli-utils-get-temp-dir.md index 05c18093..38f05cce 100644 --- a/internal-api/wp-cli-utils-get-temp-dir.md +++ b/internal-api/wp-cli-utils-get-temp-dir.md @@ -30,6 +30,9 @@ Get the system's temp directory. Warns user if it isn't writable.
  • WP_CLI\Utils\trailingslashit() - Appends a trailing slash.
    • +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • + +
  • WP_CLI\Utils\get_php_binary() - Get the path to the PHP binary used when executing WP-CLI.
    • diff --git a/internal-api/wp-cli-utils-launch-editor-for-input.md b/internal-api/wp-cli-utils-launch-editor-for-input.md index 649025ff..5a99da65 100644 --- a/internal-api/wp-cli-utils-launch-editor-for-input.md +++ b/internal-api/wp-cli-utils-launch-editor-for-input.md @@ -6,10 +6,12 @@ Launch system's $EDITOR for the user to edit some text. ## Usage - WP_CLI\Utils\launch_editor_for_input( $input, $filename = WP-CLI ) + WP_CLI\Utils\launch_editor_for_input( $input, $title = WP-CLI, $ext = tmp )
    string () $content Some form of text to edit (e.g. post content)
    +string () $title Title to display in the editor.
    +string () $ext Extension to use with the temp file.
    @return (string|bool) text, if file is saved from editor; false, if no change to file.
    diff --git a/internal-api/wp-cli-utils-normalize-path.md b/internal-api/wp-cli-utils-normalize-path.md new file mode 100644 index 00000000..f0a88103 --- /dev/null +++ b/internal-api/wp-cli-utils-normalize-path.md @@ -0,0 +1,57 @@ +# WP_CLI\Utils\normalize_path() + +Normalize a filesystem path. + +*** + +## Usage + + WP_CLI\Utils\normalize_path( $path ) + +
    +$path (string) Path to normalize.
    +@return (string) path.
    +
    + + +*** + +## Notes + +On Windows systems, replaces backslashes with forward slashes +and forces upper-case drive letters. +Allows for two leading slashes for Windows network shares, but +ensures that all other duplicate slashes are reduced to a single one. +Ensures upper-case drive letters on Windows systems. + + +*Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.* + + +*** + +## Related + + + + diff --git a/internal-api/wp-cli-utils-trailingslashit.md b/internal-api/wp-cli-utils-trailingslashit.md index 01d3caa3..0e2a2c0e 100644 --- a/internal-api/wp-cli-utils-trailingslashit.md +++ b/internal-api/wp-cli-utils-trailingslashit.md @@ -28,6 +28,9 @@ Appends a trailing slash.
  • WP_CLI\Utils\get_home_dir() - Get the home directory.
    • +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • + +
  • WP_CLI\Utils\get_temp_dir() - Get the system's temp directory. Warns user if it isn't writable.