diff --git a/bin/commands-manifest.json b/bin/commands-manifest.json index 1b99011e..00077b5e 100644 --- a/bin/commands-manifest.json +++ b/bin/commands-manifest.json @@ -15,6 +15,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/admin.md", "repo_url": "https:\/\/github.com\/wp-cli\/admin-command" }, + "ai": { + "title": "ai", + "slug": "ai", + "cmd_path": "ai", + "parent": null, + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ai.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, "block": { "title": "block", "slug": "block", @@ -63,6 +71,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/config.md", "repo_url": "https:\/\/github.com\/wp-cli\/config-command" }, + "connectors": { + "title": "connectors", + "slug": "connectors", + "cmd_path": "connectors", + "parent": null, + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/connectors.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, "core": { "title": "core", "slug": "core", @@ -135,6 +151,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/find.md", "repo_url": "https:\/\/github.com\/wp-cli\/find-command" }, + "font": { + "title": "font", + "slug": "font", + "cmd_path": "font", + "parent": null, + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "help": { "title": "help", "slug": "help", @@ -303,6 +327,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/sidebar.md", "repo_url": "https:\/\/github.com\/wp-cli\/widget-command" }, + "site-health": { + "title": "site-health", + "slug": "site-health", + "cmd_path": "site-health", + "parent": null, + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/site-health.md", + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command" + }, "site": { "title": "site", "slug": "site", @@ -423,6 +455,38 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/validate.md", "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" }, + "ai\/check": { + "title": "ai check", + "slug": "check", + "cmd_path": "ai\/check", + "parent": "ai", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ai\/check.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, + "ai\/generate": { + "title": "ai generate", + "slug": "generate", + "cmd_path": "ai\/generate", + "parent": "ai", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ai\/generate.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, + "ai\/is-supported": { + "title": "ai is-supported", + "slug": "is-supported", + "cmd_path": "ai\/is-supported", + "parent": "ai", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ai\/is-supported.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, + "ai\/status": { + "title": "ai status", + "slug": "status", + "cmd_path": "ai\/status", + "parent": "ai", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ai\/status.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, "block\/binding": { "title": "block binding", "slug": "binding", @@ -823,6 +887,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/comment\/update.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "config\/add": { + "title": "config add", + "slug": "add", + "cmd_path": "config\/add", + "parent": "config", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/config\/add.md", + "repo_url": "https:\/\/github.com\/wp-cli\/config-command" + }, "config\/create": { "title": "config create", "slug": "create", @@ -903,6 +975,38 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/config\/shuffle-salts.md", "repo_url": "https:\/\/github.com\/wp-cli\/config-command" }, + "config\/update": { + "title": "config update", + "slug": "update", + "cmd_path": "config\/update", + "parent": "config", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/config\/update.md", + "repo_url": "https:\/\/github.com\/wp-cli\/config-command" + }, + "connectors\/get": { + "title": "connectors get", + "slug": "get", + "cmd_path": "connectors\/get", + "parent": "connectors", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/connectors\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, + "connectors\/list": { + "title": "connectors list", + "slug": "list", + "cmd_path": "connectors\/list", + "parent": "connectors", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/connectors\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command" + }, + "core\/check-update-db": { + "title": "core check-update-db", + "slug": "check-update-db", + "cmd_path": "core\/check-update-db", + "parent": "core", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/core\/check-update-db.md", + "repo_url": "https:\/\/github.com\/wp-cli\/core-command" + }, "core\/check-update": { "title": "core check-update", "slug": "check-update", @@ -1195,6 +1299,38 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/embed\/provider.md", "repo_url": "https:\/\/github.com\/wp-cli\/embed-command" }, + "font\/collection": { + "title": "font collection", + "slug": "collection", + "cmd_path": "font\/collection", + "parent": "font", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/collection.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/face": { + "title": "font face", + "slug": "face", + "cmd_path": "font\/face", + "parent": "font", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/face.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/family": { + "title": "font family", + "slug": "family", + "cmd_path": "font\/family", + "parent": "font", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/family.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "i18n\/audit": { + "title": "i18n audit", + "slug": "audit", + "cmd_path": "i18n\/audit", + "parent": "i18n", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/i18n\/audit.md", + "repo_url": "https:\/\/github.com\/wp-cli\/i18n-command" + }, "i18n\/make-json": { "title": "i18n make-json", "slug": "make-json", @@ -1315,6 +1451,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/media\/import.md", "repo_url": "https:\/\/github.com\/wp-cli\/media-command" }, + "media\/prune": { + "title": "media prune", + "slug": "prune", + "cmd_path": "media\/prune", + "parent": "media", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/media\/prune.md", + "repo_url": "https:\/\/github.com\/wp-cli\/media-command" + }, "media\/regenerate": { "title": "media regenerate", "slug": "regenerate", @@ -1323,6 +1467,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/media\/regenerate.md", "repo_url": "https:\/\/github.com\/wp-cli\/media-command" }, + "media\/replace": { + "title": "media replace", + "slug": "replace", + "cmd_path": "media\/replace", + "parent": "media", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/media\/replace.md", + "repo_url": "https:\/\/github.com\/wp-cli\/media-command" + }, "menu\/create": { "title": "menu create", "slug": "create", @@ -1458,6 +1610,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/package\/browse.md", "repo_url": "https:\/\/github.com\/wp-cli\/package-command" }, + "package\/get": { + "title": "package get", + "slug": "get", + "cmd_path": "package\/get", + "parent": "package", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/package\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/package-command" + }, "package\/install": { "title": "package install", "slug": "install", @@ -1466,6 +1626,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/package\/install.md", "repo_url": "https:\/\/github.com\/wp-cli\/package-command" }, + "package\/is-installed": { + "title": "package is-installed", + "slug": "is-installed", + "cmd_path": "package\/is-installed", + "parent": "package", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/package\/is-installed.md", + "repo_url": "https:\/\/github.com\/wp-cli\/package-command" + }, "package\/list": { "title": "package list", "slug": "list", @@ -1514,6 +1682,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/plugin\/auto-updates.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "plugin\/check-update": { + "title": "plugin check-update", + "slug": "check-update", + "cmd_path": "plugin\/check-update", + "parent": "plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/plugin\/check-update.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "plugin\/deactivate": { "title": "plugin deactivate", "slug": "deactivate", @@ -1530,6 +1706,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/plugin\/delete.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "plugin\/download": { + "title": "plugin download", + "slug": "download", + "cmd_path": "plugin\/download", + "parent": "plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/plugin\/download.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "plugin\/get": { "title": "plugin get", "slug": "get", @@ -1538,6 +1722,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/plugin\/get.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "plugin\/install-dependencies": { + "title": "plugin install-dependencies", + "slug": "install-dependencies", + "cmd_path": "plugin\/install-dependencies", + "parent": "plugin", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/plugin\/install-dependencies.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "plugin\/install": { "title": "plugin install", "slug": "install", @@ -1649,6 +1841,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post-type\/list.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "post\/block": { + "title": "post block", + "slug": "block", + "cmd_path": "post\/block", + "parent": "post", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "post\/create": { "title": "post create", "slug": "create", @@ -1697,6 +1897,22 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/get.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "post\/has-block": { + "title": "post has-block", + "slug": "has-block", + "cmd_path": "post\/has-block", + "parent": "post", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/has-block.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/has-blocks": { + "title": "post has-blocks", + "slug": "has-blocks", + "cmd_path": "post\/has-blocks", + "parent": "post", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/has-blocks.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "post\/list": { "title": "post list", "slug": "list", @@ -1713,6 +1929,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/meta.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "post\/revision": { + "title": "post revision", + "slug": "revision", + "cmd_path": "post\/revision", + "parent": "post", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/revision.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "post\/term": { "title": "post term", "slug": "term", @@ -1761,6 +1985,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/profile\/hook.md", "repo_url": "https:\/\/github.com\/wp-cli\/profile-command" }, + "profile\/queries": { + "title": "profile queries", + "slug": "queries", + "cmd_path": "profile\/queries", + "parent": "profile", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/profile\/queries.md", + "repo_url": "https:\/\/github.com\/wp-cli\/profile-command" + }, "profile\/stage": { "title": "profile stage", "slug": "stage", @@ -1918,6 +2150,22 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/scaffold\/underscores.md", "repo_url": "https:\/\/github.com\/wp-cli\/scaffold-command" }, + "sidebar\/exists": { + "title": "sidebar exists", + "slug": "exists", + "cmd_path": "sidebar\/exists", + "parent": "sidebar", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/sidebar\/exists.md", + "repo_url": "https:\/\/github.com\/wp-cli\/widget-command" + }, + "sidebar\/get": { + "title": "sidebar get", + "slug": "get", + "cmd_path": "sidebar\/get", + "parent": "sidebar", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/sidebar\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/widget-command" + }, "sidebar\/list": { "title": "sidebar list", "slug": "list", @@ -1926,6 +2174,38 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/sidebar\/list.md", "repo_url": "https:\/\/github.com\/wp-cli\/widget-command" }, + "site-health\/check": { + "title": "site-health check", + "slug": "check", + "cmd_path": "site-health\/check", + "parent": "site-health", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/site-health\/check.md", + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command" + }, + "site-health\/info": { + "title": "site-health info", + "slug": "info", + "cmd_path": "site-health\/info", + "parent": "site-health", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/site-health\/info.md", + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command" + }, + "site-health\/list-info-sections": { + "title": "site-health list-info-sections", + "slug": "list-info-sections", + "cmd_path": "site-health\/list-info-sections", + "parent": "site-health", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/site-health\/list-info-sections.md", + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command" + }, + "site-health\/status": { + "title": "site-health status", + "slug": "status", + "cmd_path": "site-health\/status", + "parent": "site-health", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/site-health\/status.md", + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command" + }, "site\/activate": { "title": "site activate", "slug": "activate", @@ -1982,6 +2262,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/site\/generate.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "site\/get": { + "title": "site get", + "slug": "get", + "cmd_path": "site\/get", + "parent": "site", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/site\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "site\/list": { "title": "site list", "slug": "list", @@ -2166,6 +2454,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/term\/migrate.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "term\/prune": { + "title": "term prune", + "slug": "prune", + "cmd_path": "term\/prune", + "parent": "term", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/term\/prune.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "term\/recount": { "title": "term recount", "slug": "recount", @@ -2198,6 +2494,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/theme\/auto-updates.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "theme\/check-update": { + "title": "theme check-update", + "slug": "check-update", + "cmd_path": "theme\/check-update", + "parent": "theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/theme\/check-update.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "theme\/delete": { "title": "theme delete", "slug": "delete", @@ -2214,6 +2518,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/theme\/disable.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "theme\/download": { + "title": "theme download", + "slug": "download", + "cmd_path": "theme\/download", + "parent": "theme", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/theme\/download.md", + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" + }, "theme\/enable": { "title": "theme enable", "slug": "enable", @@ -2476,6 +2788,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/meta.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "user\/privacy-request": { + "title": "user privacy-request", + "slug": "privacy-request", + "cmd_path": "user\/privacy-request", + "parent": "user", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/privacy-request.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "user\/remove-cap": { "title": "user remove-cap", "slug": "remove-cap", @@ -2596,6 +2916,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/widget\/move.md", "repo_url": "https:\/\/github.com\/wp-cli\/widget-command" }, + "widget\/patch": { + "title": "widget patch", + "slug": "patch", + "cmd_path": "widget\/patch", + "parent": "widget", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/widget\/patch.md", + "repo_url": "https:\/\/github.com\/wp-cli\/widget-command" + }, "widget\/reset": { "title": "widget reset", "slug": "reset", @@ -3011,6 +3339,62 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/embed\/provider\/match.md", "repo_url": "https:\/\/github.com\/wp-cli\/embed-command" }, + "font\/collection\/get": { + "title": "font collection get", + "slug": "get", + "cmd_path": "font\/collection\/get", + "parent": "font\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/collection\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/collection\/is-registered": { + "title": "font collection is-registered", + "slug": "is-registered", + "cmd_path": "font\/collection\/is-registered", + "parent": "font\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/collection\/is-registered.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/collection\/list-categories": { + "title": "font collection list-categories", + "slug": "list-categories", + "cmd_path": "font\/collection\/list-categories", + "parent": "font\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/collection\/list-categories.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/collection\/list-families": { + "title": "font collection list-families", + "slug": "list-families", + "cmd_path": "font\/collection\/list-families", + "parent": "font\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/collection\/list-families.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/collection\/list": { + "title": "font collection list", + "slug": "list", + "cmd_path": "font\/collection\/list", + "parent": "font\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/collection\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/face\/install": { + "title": "font face install", + "slug": "install", + "cmd_path": "font\/face\/install", + "parent": "font\/face", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/face\/install.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "font\/family\/install": { + "title": "font family install", + "slug": "install", + "cmd_path": "font\/family\/install", + "parent": "font\/family", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/font\/family\/install.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "language\/core\/activate": { "title": "language core activate", "slug": "activate", @@ -3147,6 +3531,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/menu\/item\/add-custom.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "menu\/item\/add-post-type-archive": { + "title": "menu item add-post-type-archive", + "slug": "add-post-type-archive", + "cmd_path": "menu\/item\/add-post-type-archive", + "parent": "menu\/item", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/menu\/item\/add-post-type-archive.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "menu\/item\/add-post": { "title": "menu item add-post", "slug": "add-post", @@ -3171,6 +3563,14 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/menu\/item\/delete.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "menu\/item\/get": { + "title": "menu item get", + "slug": "get", + "cmd_path": "menu\/item\/get", + "parent": "menu\/item", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/menu\/item\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "menu\/item\/list": { "title": "menu item list", "slug": "list", @@ -3298,6 +3698,118 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/plugin\/auto-updates\/status.md", "repo_url": "https:\/\/github.com\/wp-cli\/extension-command" }, + "post\/block\/clone": { + "title": "post block clone", + "slug": "clone", + "cmd_path": "post\/block\/clone", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/clone.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/count": { + "title": "post block count", + "slug": "count", + "cmd_path": "post\/block\/count", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/count.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/export": { + "title": "post block export", + "slug": "export", + "cmd_path": "post\/block\/export", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/export.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/extract": { + "title": "post block extract", + "slug": "extract", + "cmd_path": "post\/block\/extract", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/extract.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/get": { + "title": "post block get", + "slug": "get", + "cmd_path": "post\/block\/get", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/import": { + "title": "post block import", + "slug": "import", + "cmd_path": "post\/block\/import", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/import.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/insert": { + "title": "post block insert", + "slug": "insert", + "cmd_path": "post\/block\/insert", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/insert.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/list": { + "title": "post block list", + "slug": "list", + "cmd_path": "post\/block\/list", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/move": { + "title": "post block move", + "slug": "move", + "cmd_path": "post\/block\/move", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/move.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/parse": { + "title": "post block parse", + "slug": "parse", + "cmd_path": "post\/block\/parse", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/parse.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/remove": { + "title": "post block remove", + "slug": "remove", + "cmd_path": "post\/block\/remove", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/remove.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/render": { + "title": "post block render", + "slug": "render", + "cmd_path": "post\/block\/render", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/render.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/replace": { + "title": "post block replace", + "slug": "replace", + "cmd_path": "post\/block\/replace", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/replace.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/block\/update": { + "title": "post block update", + "slug": "update", + "cmd_path": "post\/block\/update", + "parent": "post\/block", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/block\/update.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "post\/meta\/add": { "title": "post meta add", "slug": "add", @@ -3369,6 +3881,30 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/meta\/update.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "post\/revision\/diff": { + "title": "post revision diff", + "slug": "diff", + "cmd_path": "post\/revision\/diff", + "parent": "post\/revision", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/revision\/diff.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/revision\/prune": { + "title": "post revision prune", + "slug": "prune", + "cmd_path": "post\/revision\/prune", + "parent": "post\/revision", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/revision\/prune.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "post\/revision\/restore": { + "title": "post revision restore", + "slug": "restore", + "cmd_path": "post\/revision\/restore", + "parent": "post\/revision", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/post\/revision\/restore.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "post\/term\/add": { "title": "post term add", "slug": "add", @@ -3765,6 +4301,54 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/meta\/update.md", "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" }, + "user\/privacy-request\/complete": { + "title": "user privacy-request complete", + "slug": "complete", + "cmd_path": "user\/privacy-request\/complete", + "parent": "user\/privacy-request", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/privacy-request\/complete.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "user\/privacy-request\/create": { + "title": "user privacy-request create", + "slug": "create", + "cmd_path": "user\/privacy-request\/create", + "parent": "user\/privacy-request", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/privacy-request\/create.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "user\/privacy-request\/delete": { + "title": "user privacy-request delete", + "slug": "delete", + "cmd_path": "user\/privacy-request\/delete", + "parent": "user\/privacy-request", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/privacy-request\/delete.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "user\/privacy-request\/erase": { + "title": "user privacy-request erase", + "slug": "erase", + "cmd_path": "user\/privacy-request\/erase", + "parent": "user\/privacy-request", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/privacy-request\/erase.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "user\/privacy-request\/export": { + "title": "user privacy-request export", + "slug": "export", + "cmd_path": "user\/privacy-request\/export", + "parent": "user\/privacy-request", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/privacy-request\/export.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, + "user\/privacy-request\/list": { + "title": "user privacy-request list", + "slug": "list", + "cmd_path": "user\/privacy-request\/list", + "parent": "user\/privacy-request", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/user\/privacy-request\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command" + }, "user\/session\/destroy": { "title": "user session destroy", "slug": "destroy", diff --git a/bin/handbook-manifest.json b/bin/handbook-manifest.json index a6b98703..9c6f19ec 100644 --- a/bin/handbook-manifest.json +++ b/bin/handbook-manifest.json @@ -14,8 +14,8 @@ "behat-steps": { "title": "Behat Steps", "slug": "behat-steps", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps.md", - "parent": "references" + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps.md", + "parent": null }, "behat-tests": { "title": "Writing Behat Tests for WP-CLI", @@ -170,55 +170,55 @@ "given-a-custom-wp-content-directory": { "title": "Given a custom wp-content directory", "slug": "given-a-custom-wp-content-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-custom-wp-content-directory.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-custom-wp-content-directory.md", "parent": "behat-steps" }, "given-a-database": { "title": "Given a database", "slug": "given-a-database", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-database.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-database.md", "parent": "behat-steps" }, "given-a-dependency-on-current-wp-cli": { "title": "Given a dependency on current wp-cli", "slug": "given-a-dependency-on-current-wp-cli", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-dependency-on-current-wp-cli.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-dependency-on-current-wp-cli.md", "parent": "behat-steps" }, "given-a-downloaded-phar-with-the-same-version-version": { "title": "Given \/^a downloaded Phar with (?:the same version|version "([^"]+)")$\/", "slug": "given-a-downloaded-phar-with-the-same-version-version", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-downloaded-phar-with-the-same-version-version.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-downloaded-phar-with-the-same-version-version.md", "parent": "behat-steps" }, "given-a-misconfigured-wp-content-dir-constant-directory": { "title": "Given a misconfigured WP_CONTENT_DIR constant directory", "slug": "given-a-misconfigured-wp-content-dir-constant-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-misconfigured-wp-content-dir-constant-directory.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-misconfigured-wp-content-dir-constant-directory.md", "parent": "behat-steps" }, "given-a-new-phar-with-the-same-version-version": { "title": "Given \/^a new Phar with (?:the same version|version "([^"]+)")$\/", "slug": "given-a-new-phar-with-the-same-version-version", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-new-phar-with-the-same-version-version.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-new-phar-with-the-same-version-version.md", "parent": "behat-steps" }, "given-a-php-built-in-web-server": { "title": "Given a PHP built-in web server", "slug": "given-a-php-built-in-web-server", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-php-built-in-web-server.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-php-built-in-web-server.md", "parent": "behat-steps" }, "given-a-php-built-in-web-server-to-serve-subdir": { "title": "Given a PHP built-in web server to serve :subdir", "slug": "given-a-php-built-in-web-server-to-serve-subdir", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-php-built-in-web-server-to-serve-subdir.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-php-built-in-web-server-to-serve-subdir.md", "parent": "behat-steps" }, "given-a-wp-installation": { - "title": "Given a WP install(ation)", + "title": "Given \/^a WP( \\d[^\\s]+)? install(?:ation)?$\/", "slug": "given-a-wp-installation", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-installation.md", "parent": "behat-steps" }, "given-a-wp-installation-in": { @@ -236,91 +236,91 @@ "given-a-wp-installation-with-composer": { "title": "Given a WP install(ation) with Composer", "slug": "given-a-wp-installation-with-composer", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation-with-composer.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-installation-with-composer.md", "parent": "behat-steps" }, "given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory": { "title": "Given a WP install(ation) with Composer and a custom vendor directory :vendor_directory", "slug": "given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-installation-with-composer-and-a-custom-vendor-directory-vendor-directory.md", "parent": "behat-steps" }, "given-a-wp-multisite-subdirectory-subdomaininstall-installation": { "title": "Given \/^a WP multisite (subdirectory|subdomain)?\\s?(install|installation)$\/", "slug": "given-a-wp-multisite-subdirectory-subdomaininstall-installation", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-a-wp-multisite-subdirectory-subdomaininstall-installation.md", "parent": "behat-steps" }, "given-an-empty-cache": { "title": "Given an empty cache", "slug": "given-an-empty-cache", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-empty-cache.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-empty-cache.md", "parent": "behat-steps" }, "given-an-empty-directory": { "title": "Given an empty directory", "slug": "given-an-empty-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-empty-directory.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-empty-directory.md", "parent": "behat-steps" }, "given-an-empty-non-existent-directory": { "title": "Given \/^an? (empty|non-existent) ([^\\s]+) directory$\/", "slug": "given-an-empty-non-existent-directory", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-empty-non-existent-directory.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-empty-non-existent-directory.md", "parent": "behat-steps" }, "given-an-file-cache-file": { "title": "Given \/^an? ([^\\s]+) (file|cache file):$\/", "slug": "given-an-file-cache-file", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-an-file-cache-file.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-an-file-cache-file.md", "parent": "behat-steps" }, "given-download": { "title": "Given download:", "slug": "given-download", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-download.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-download.md", "parent": "behat-steps" }, "given-replaced-with-in-the-file": { "title": "Given \/^"([^"]+)" replaced with "([^"]+)" in the ([^\\s]+) file$\/", "slug": "given-replaced-with-in-the-file", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-replaced-with-in-the-file.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-replaced-with-in-the-file.md", "parent": "behat-steps" }, "given-save-stdout-stderr-as": { "title": "Given \/^save (STDOUT|STDERR) ([\\'].+[^\\'])?\\s?as \\{(\\w+)\\}$\/", "slug": "given-save-stdout-stderr-as", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-save-stdout-stderr-as.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-save-stdout-stderr-as.md", "parent": "behat-steps" }, "given-save-the-file-as": { "title": "Given \/^save the (.+) file ([\\'].+[^\\'])?as \\{(\\w+)\\}$\/", "slug": "given-save-the-file-as", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-save-the-file-as.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-save-the-file-as.md", "parent": "behat-steps" }, "given-that-http-requests-to-will-respond-with": { "title": "Given \/^that HTTP requests to (.*?) will respond with:$\/", "slug": "given-that-http-requests-to-will-respond-with", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-that-http-requests-to-will-respond-with.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-that-http-requests-to-will-respond-with.md", "parent": "behat-steps" }, "given-these-installed-and-active-plugins": { "title": "Given these installed and active plugins:", "slug": "given-these-installed-and-active-plugins", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-these-installed-and-active-plugins.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-these-installed-and-active-plugins.md", "parent": "behat-steps" }, "given-wp-config-php": { "title": "Given wp-config.php", "slug": "given-wp-config-php", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-wp-config-php.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-wp-config-php.md", "parent": "behat-steps" }, "given-wp-files": { "title": "Given WP files", "slug": "given-wp-files", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/given-wp-files.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/given-wp-files.md", "parent": "behat-steps" }, "governance": { @@ -500,109 +500,109 @@ "then-an-email-should-be-sent-not-be-sent": { "title": "Then \/^an email should (be sent|not be sent)$\/", "slug": "then-an-email-should-be-sent-not-be-sent", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-an-email-should-be-sent-not-be-sent.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-an-email-should-be-sent-not-be-sent.md", "parent": "behat-steps" }, "then-stdout-should-be-a-json-array-containing": { "title": "Then \/^STDOUT should be a JSON array containing:$\/", "slug": "then-stdout-should-be-a-json-array-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-a-json-array-containing.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-a-json-array-containing.md", "parent": "behat-steps" }, "then-stdout-should-be-a-table-containing-rows": { "title": "Then \/^STDOUT should be a table containing rows:$\/", "slug": "then-stdout-should-be-a-table-containing-rows", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-a-table-containing-rows.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-a-table-containing-rows.md", "parent": "behat-steps" }, "then-stdout-should-be-csv-containing": { "title": "Then \/^STDOUT should be CSV containing:$\/", "slug": "then-stdout-should-be-csv-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-csv-containing.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-csv-containing.md", "parent": "behat-steps" }, "then-stdout-should-be-json-containing": { "title": "Then \/^STDOUT should be JSON containing:$\/", "slug": "then-stdout-should-be-json-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-json-containing.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-json-containing.md", "parent": "behat-steps" }, "then-stdout-should-be-yaml-containing": { "title": "Then \/^STDOUT should be YAML containing:$\/", "slug": "then-stdout-should-be-yaml-containing", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-be-yaml-containing.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-be-yaml-containing.md", "parent": "behat-steps" }, "then-stdout-should-end-with-a-table-containing-rows": { "title": "Then \/^STDOUT should end with a table containing rows:$\/", "slug": "then-stdout-should-end-with-a-table-containing-rows", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-should-end-with-a-table-containing-rows.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-should-end-with-a-table-containing-rows.md", "parent": "behat-steps" }, "then-stdout-stderr-should-be-a-number": { "title": "Then \/^(STDOUT|STDERR) should be a number$\/", "slug": "then-stdout-stderr-should-be-a-number", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-be-a-number.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-be-a-number.md", "parent": "behat-steps" }, "then-stdout-stderr-should-be-a-version-string-w": { "title": "Then \/^(STDOUT|STDERR) should be a version string (<|<=|>|>=|==|=|!=|<>) ([+\\w.{}-]+)$\/", "slug": "then-stdout-stderr-should-be-a-version-string-w", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-be-a-version-string-w.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-be-a-version-string-w.md", "parent": "behat-steps" }, "then-stdout-stderr-should-be-empty": { "title": "Then \/^(STDOUT|STDERR) should be empty$\/", "slug": "then-stdout-stderr-should-be-empty", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-be-empty.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-be-empty.md", "parent": "behat-steps" }, "then-stdout-stderr-should-not-be-a-number": { "title": "Then \/^(STDOUT|STDERR) should not be a number$\/", "slug": "then-stdout-stderr-should-not-be-a-number", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-not-be-a-number.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-not-be-a-number.md", "parent": "behat-steps" }, "then-stdout-stderr-should-not-be-empty": { "title": "Then \/^(STDOUT|STDERR) should not be empty$\/", "slug": "then-stdout-stderr-should-not-be-empty", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-not-be-empty.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-not-be-empty.md", "parent": "behat-steps" }, "then-stdout-stderr-should-not-match": { "title": "Then \/^(STDOUT|STDERR) should( not)? match (((\\\/.+\\\/)|(#.+#))([a-z]+)?)$\/", "slug": "then-stdout-stderr-should-not-match", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-not-match.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-not-match.md", "parent": "behat-steps" }, "then-stdout-stderr-should-strictly-be-contain-not-contain": { "title": "Then \/^(STDOUT|STDERR) should( strictly)? (be|contain|not contain):$\/", "slug": "then-stdout-stderr-should-strictly-be-contain-not-contain", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-stdout-stderr-should-strictly-be-contain-not-contain.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-stdout-stderr-should-strictly-be-contain-not-contain.md", "parent": "behat-steps" }, "then-the-contents-of-the-file-should-not-match": { "title": "Then \/^the contents of the (.+) file should( not)? match (((\\\/.+\\\/)|(#.+#))([a-z]+)?)$\/", "slug": "then-the-contents-of-the-file-should-not-match", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-contents-of-the-file-should-not-match.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-contents-of-the-file-should-not-match.md", "parent": "behat-steps" }, "then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain": { "title": "Then \/^the (.+) (file|directory) should( strictly)? (exist|not exist|be:|contain:|not contain:)$\/", "slug": "then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-file-directory-should-strictly-exist-not-exist-be-contain-not-contain.md", "parent": "behat-steps" }, "then-the-http-status-code-should-be-code": { "title": "Then the HTTP status code should be :code", "slug": "then-the-http-status-code-should-be-code", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-http-status-code-should-be-code.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-http-status-code-should-be-code.md", "parent": "behat-steps" }, "then-the-return-code-should-not-be": { "title": "Then \/^the return code should( not)? be (\\d+)$\/", "slug": "then-the-return-code-should-not-be", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/then-the-return-code-should-not-be.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/then-the-return-code-should-not-be.md", "parent": "behat-steps" }, "tools": { @@ -626,271 +626,277 @@ "when-i-launch-in-the-background": { "title": "When \/^I launch in the background `([^`]+)`$\/", "slug": "when-i-launch-in-the-background", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-launch-in-the-background.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-launch-in-the-background.md", "parent": "behat-steps" }, "when-i-run-try": { "title": "When \/^I (run|try) `([^`]+)`$\/", "slug": "when-i-run-try", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-run-try.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-run-try.md", "parent": "behat-steps" }, "when-i-run-try-from": { "title": "When \/^I (run|try) `([^`]+)` from '([^\\s]+)'$\/", "slug": "when-i-run-try-from", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-run-try-from.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-run-try-from.md", "parent": "behat-steps" }, "when-i-run-try-the-previous-command-again": { "title": "When \/^I (run|try) the previous command again$\/", "slug": "when-i-run-try-the-previous-command-again", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/behat-steps\/when-i-run-try-the-previous-command-again.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/behat-steps\/when-i-run-try-the-previous-command-again.md", "parent": "behat-steps" }, "wp-cli-add-command": { "title": "WP_CLI::add_command()", "slug": "wp-cli-add-command", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-add-command.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-add-command.md", "parent": "internal-api" }, "wp-cli-add-hook": { "title": "WP_CLI::add_hook()", "slug": "wp-cli-add-hook", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-add-hook.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-add-hook.md", "parent": "internal-api" }, "wp-cli-add-wp-hook": { "title": "WP_CLI::add_wp_hook()", "slug": "wp-cli-add-wp-hook", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-add-wp-hook.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-add-wp-hook.md", "parent": "internal-api" }, "wp-cli-colorize": { "title": "WP_CLI::colorize()", "slug": "wp-cli-colorize", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-colorize.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-colorize.md", "parent": "internal-api" }, "wp-cli-confirm": { "title": "WP_CLI::confirm()", "slug": "wp-cli-confirm", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-confirm.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-confirm.md", "parent": "internal-api" }, "wp-cli-debug": { "title": "WP_CLI::debug()", "slug": "wp-cli-debug", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-debug.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-debug.md", "parent": "internal-api" }, "wp-cli-do-hook": { "title": "WP_CLI::do_hook()", "slug": "wp-cli-do-hook", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-do-hook.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-do-hook.md", "parent": "internal-api" }, "wp-cli-error": { "title": "WP_CLI::error()", "slug": "wp-cli-error", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-error.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-error.md", "parent": "internal-api" }, "wp-cli-error-multi-line": { "title": "WP_CLI::error_multi_line()", "slug": "wp-cli-error-multi-line", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-error-multi-line.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-error-multi-line.md", "parent": "internal-api" }, "wp-cli-get-config": { "title": "WP_CLI::get_config()", "slug": "wp-cli-get-config", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-get-config.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-get-config.md", "parent": "internal-api" }, "wp-cli-get-php-binary": { "title": "WP_CLI::get_php_binary()", "slug": "wp-cli-get-php-binary", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-get-php-binary.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-get-php-binary.md", "parent": "internal-api" }, "wp-cli-halt": { "title": "WP_CLI::halt()", "slug": "wp-cli-halt", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-halt.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-halt.md", "parent": "internal-api" }, "wp-cli-has-config": { "title": "WP_CLI::has_config()", "slug": "wp-cli-has-config", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-has-config.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-has-config.md", "parent": "internal-api" }, "wp-cli-launch": { "title": "WP_CLI::launch()", "slug": "wp-cli-launch", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-launch.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-launch.md", "parent": "internal-api" }, "wp-cli-launch-self": { "title": "WP_CLI::launch_self()", "slug": "wp-cli-launch-self", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-launch-self.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-launch-self.md", "parent": "internal-api" }, "wp-cli-line": { "title": "WP_CLI::line()", "slug": "wp-cli-line", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-line.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-line.md", "parent": "internal-api" }, "wp-cli-log": { "title": "WP_CLI::log()", "slug": "wp-cli-log", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-log.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-log.md", "parent": "internal-api" }, "wp-cli-read-value": { "title": "WP_CLI::read_value()", "slug": "wp-cli-read-value", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-read-value.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-read-value.md", "parent": "internal-api" }, "wp-cli-run-command": { "title": "WP_CLI::run_command()", "slug": "wp-cli-run-command", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-run-command.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-run-command.md", "parent": "internal-api" }, "wp-cli-runcommand": { "title": "WP_CLI::runcommand()", "slug": "wp-cli-runcommand", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-runcommand.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-runcommand.md", "parent": "internal-api" }, "wp-cli-success": { "title": "WP_CLI::success()", "slug": "wp-cli-success", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-success.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-success.md", "parent": "internal-api" }, "wp-cli-utils-basename": { "title": "WP_CLI\\Utils\\basename()", "slug": "wp-cli-utils-basename", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-basename.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-basename.md", "parent": "internal-api" }, "wp-cli-utils-esc-like": { "title": "WP_CLI\\Utils\\esc_like()", "slug": "wp-cli-utils-esc-like", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-esc-like.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-esc-like.md", "parent": "internal-api" }, "wp-cli-utils-format-items": { "title": "WP_CLI\\Utils\\format_items()", "slug": "wp-cli-utils-format-items", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-format-items.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-format-items.md", "parent": "internal-api" }, "wp-cli-utils-get-flag-value": { "title": "WP_CLI\\Utils\\get_flag_value()", "slug": "wp-cli-utils-get-flag-value", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-flag-value.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-flag-value.md", "parent": "internal-api" }, "wp-cli-utils-get-home-dir": { "title": "WP_CLI\\Utils\\get_home_dir()", "slug": "wp-cli-utils-get-home-dir", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-home-dir.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-home-dir.md", "parent": "internal-api" }, "wp-cli-utils-get-named-sem-ver": { "title": "WP_CLI\\Utils\\get_named_sem_ver()", "slug": "wp-cli-utils-get-named-sem-ver", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-named-sem-ver.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-named-sem-ver.md", "parent": "internal-api" }, "wp-cli-utils-get-php-binary": { "title": "WP_CLI\\Utils\\get_php_binary()", "slug": "wp-cli-utils-get-php-binary", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-php-binary.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-php-binary.md", "parent": "internal-api" }, "wp-cli-utils-get-temp-dir": { "title": "WP_CLI\\Utils\\get_temp_dir()", "slug": "wp-cli-utils-get-temp-dir", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-get-temp-dir.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-get-temp-dir.md", "parent": "internal-api" }, "wp-cli-utils-http-request": { "title": "WP_CLI\\Utils\\http_request()", "slug": "wp-cli-utils-http-request", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-http-request.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-http-request.md", + "parent": "internal-api" + }, + "wp-cli-utils-is-stream": { + "title": "WP_CLI\\Utils\\is_stream()", + "slug": "wp-cli-utils-is-stream", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-is-stream.md", "parent": "internal-api" }, "wp-cli-utils-ispiped": { "title": "WP_CLI\\Utils\\isPiped()", "slug": "wp-cli-utils-ispiped", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-ispiped.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-ispiped.md", "parent": "internal-api" }, "wp-cli-utils-launch-editor-for-input": { "title": "WP_CLI\\Utils\\launch_editor_for_input()", "slug": "wp-cli-utils-launch-editor-for-input", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-launch-editor-for-input.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-launch-editor-for-input.md", "parent": "internal-api" }, "wp-cli-utils-make-progress-bar": { "title": "WP_CLI\\Utils\\make_progress_bar()", "slug": "wp-cli-utils-make-progress-bar", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-make-progress-bar.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/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\/main\/references\/internal-api\/wp-cli-utils-normalize-path.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/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", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-parse-ssh-url.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-parse-ssh-url.md", "parent": "internal-api" }, "wp-cli-utils-parse-str-to-argv": { "title": "WP_CLI\\Utils\\parse_str_to_argv()", "slug": "wp-cli-utils-parse-str-to-argv", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-parse-str-to-argv.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-parse-str-to-argv.md", "parent": "internal-api" }, "wp-cli-utils-proc-open-compat": { "title": "WP_CLI\\Utils\\proc_open_compat()", "slug": "wp-cli-utils-proc-open-compat", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-proc-open-compat.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-proc-open-compat.md", "parent": "internal-api" }, "wp-cli-utils-report-batch-operation-results": { "title": "WP_CLI\\Utils\\report_batch_operation_results()", "slug": "wp-cli-utils-report-batch-operation-results", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-report-batch-operation-results.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-report-batch-operation-results.md", "parent": "internal-api" }, "wp-cli-utils-trailingslashit": { "title": "WP_CLI\\Utils\\trailingslashit()", "slug": "wp-cli-utils-trailingslashit", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-trailingslashit.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-trailingslashit.md", "parent": "internal-api" }, "wp-cli-utils-write-csv": { "title": "WP_CLI\\Utils\\write_csv()", "slug": "wp-cli-utils-write-csv", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-utils-write-csv.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-utils-write-csv.md", "parent": "internal-api" }, "wp-cli-warning": { "title": "WP_CLI::warning()", "slug": "wp-cli-warning", - "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/references\/internal-api\/wp-cli-warning.md", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/internal-api\/wp-cli-warning.md", "parent": "internal-api" } } \ No newline at end of file diff --git a/commands/ability/can-run.md b/commands/ability/can-run.md index 64df1640..b1e987c9 100644 --- a/commands/ability/can-run.md +++ b/commands/ability/can-run.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/category/exists.md b/commands/ability/category/exists.md index 10f2a4df..03c004f3 100644 --- a/commands/ability/category/exists.md +++ b/commands/ability/category/exists.md @@ -37,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -49,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/category/get.md b/commands/ability/category/get.md index 01b333ee..51ca5c66 100644 --- a/commands/ability/category/get.md +++ b/commands/ability/category/get.md @@ -63,6 +63,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -75,3 +76,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/category/list.md b/commands/ability/category/list.md index 193faf4d..ce9cea79 100644 --- a/commands/ability/category/list.md +++ b/commands/ability/category/list.md @@ -61,6 +61,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -73,3 +74,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/exists.md b/commands/ability/exists.md index 9df0c806..bf9253df 100644 --- a/commands/ability/exists.md +++ b/commands/ability/exists.md @@ -37,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -49,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/get.md b/commands/ability/get.md index 827d6ab1..46e1ab1f 100644 --- a/commands/ability/get.md +++ b/commands/ability/get.md @@ -74,6 +74,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -86,3 +87,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/list.md b/commands/ability/list.md index b5d1a723..09952337 100644 --- a/commands/ability/list.md +++ b/commands/ability/list.md @@ -88,6 +88,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -100,3 +101,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/run.md b/commands/ability/run.md index 058b6521..46996eab 100644 --- a/commands/ability/run.md +++ b/commands/ability/run.md @@ -64,6 +64,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -76,3 +77,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ability/validate.md b/commands/ability/validate.md index 04fa73dc..eaa47912 100644 --- a/commands/ability/validate.md +++ b/commands/ability/validate.md @@ -40,6 +40,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -52,3 +53,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/admin.md b/commands/admin.md index 93199199..0ba6897c 100644 --- a/commands/admin.md +++ b/commands/admin.md @@ -1,6 +1,6 @@ # wp admin -Open /wp-admin/ in a browser. + @@ -13,6 +13,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -25,3 +26,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ai.md b/commands/ai.md new file mode 100644 index 00000000..676f2826 --- /dev/null +++ b/commands/ai.md @@ -0,0 +1,31 @@ +# wp ai + +Interacts with the WordPress AI Client for text and image generation. + +### EXAMPLES + + # Check AI capabilities status + $ wp ai status + +------------------+-----------+ + | Capability | Supported | + +------------------+-----------+ + | Text Generation | Yes | + | Image Generation | No | + +------------------+-----------+ + + # Generate text from a prompt + $ wp ai generate text "Write a haiku about WordPress" + Success: Generated text: + Open source and free + Empowering creators + WordPress shines bright + + # Generate an image from a prompt + $ wp ai generate image "A futuristic WordPress logo" --destination-file=logo.png + Success: Image saved to logo.png + + # Check if a prompt is supported + $ wp ai check "Summarize this text" + Success: Text generation is supported for this prompt. + + diff --git a/commands/ai/check.md b/commands/ai/check.md new file mode 100644 index 00000000..d5b5557a --- /dev/null +++ b/commands/ai/check.md @@ -0,0 +1,51 @@ +# wp ai check + +Checks if a prompt is supported for generation. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<prompt> +: The prompt to check. + +[\--type=<type>] +: Type to check. +\--- +options: + - text + - image +\--- + +### EXAMPLES + + # Check if text generation is supported + $ wp ai check "Write a poem" + + # Check if image generation is supported + $ wp ai check "A sunset" --type=image + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ai/generate.md b/commands/ai/generate.md new file mode 100644 index 00000000..41c055eb --- /dev/null +++ b/commands/ai/generate.md @@ -0,0 +1,99 @@ +# wp ai generate + +Generates AI content. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<type> +: Type of content to generate. +\--- +options: + - text + - image +\--- + +<prompt> +: The prompt to send to the AI. + +[\--model=<models>] +: Comma-separated list of models in order of preference. Format: "provider,model" (e.g., "openai,gpt-4" or "openai,gpt-4,anthropic,claude-3"). + +[\--provider=<provider>] +: Specific AI provider to use (e.g., "openai", "anthropic", "google"). + +[\--temperature=<temperature>] +: Temperature for generation, typically between 0.0 and 1.0. Lower is more deterministic. + +[\--top-p=<top-p>] +: Top-p (nucleus sampling) parameter. Value between 0.0 and 1.0. + +[\--top-k=<top-k>] +: Top-k sampling parameter. Positive integer. + +[\--max-tokens=<tokens>] +: Maximum number of tokens to generate. + +[\--system-instruction=<instruction>] +: System instruction to guide the AI's behavior. + +[\--destination-file=<file>] +: For image generation, path to save the generated image. + +[\--stdout] +: Output the whole image using standard output (incompatible with --destination-file=) + +[\--format=<format>] +: Output format for text. +\--- +default: text +options: + - text + - json +\--- + +### EXAMPLES + + # Generate text + $ wp ai generate text "Explain WordPress in one sentence" + + # Generate text with specific settings + $ wp ai generate text "List 3 WordPress features" --temperature=0.1 --max-tokens=100 + + # Generate with top-p and top-k sampling + $ wp ai generate text "Write a story" --top-p=0.9 --top-k=40 + + # Generate with model preferences + $ wp ai generate text "Write a haiku" --model=openai,gpt-4,anthropic,claude-3 + + # Generate with system instruction + $ wp ai generate text "Explain AI" --system-instruction="Explain as if to a 5-year-old" + + # Generate image + $ wp ai generate image "A minimalist WordPress logo" --destination-file=wp-logo.png + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ai/is-supported.md b/commands/ai/is-supported.md new file mode 100644 index 00000000..0e2e4f23 --- /dev/null +++ b/commands/ai/is-supported.md @@ -0,0 +1,36 @@ +# wp ai is-supported + +Checks whether AI features are supported in the current environment. + +Exits with code 0 if AI features are supported, or code 1 if they are not. + +### EXAMPLES + + # Check if AI is supported + $ wp ai is-supported + Success: AI features are supported. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/ai/status.md b/commands/ai/status.md new file mode 100644 index 00000000..023ad80a --- /dev/null +++ b/commands/ai/status.md @@ -0,0 +1,56 @@ +# wp ai status + +Checks which AI capabilities are currently supported. + +Checks the environment and credentials to determine which AI operations are available. Displays a table showing supported capabilities. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + # Check AI status + $ wp ai status + +------------------+-----------+ + | capability | supported | + +------------------+-----------+ + | Text Generation | Yes | + | Image Generation | No | + +------------------+-----------+ + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/binding/get.md b/commands/block/binding/get.md index a0977b49..644cb79a 100644 --- a/commands/block/binding/get.md +++ b/commands/block/binding/get.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/binding/list.md b/commands/block/binding/list.md index 2309438e..8e673829 100644 --- a/commands/block/binding/list.md +++ b/commands/block/binding/list.md @@ -56,6 +56,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -68,3 +69,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/pattern-category/get.md b/commands/block/pattern-category/get.md index 209619a1..093910e0 100644 --- a/commands/block/pattern-category/get.md +++ b/commands/block/pattern-category/get.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/pattern-category/list.md b/commands/block/pattern-category/list.md index 0899f50c..342c598e 100644 --- a/commands/block/pattern-category/list.md +++ b/commands/block/pattern-category/list.md @@ -53,6 +53,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -65,3 +66,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/pattern/get.md b/commands/block/pattern/get.md index 7bcf6139..28b316f7 100644 --- a/commands/block/pattern/get.md +++ b/commands/block/pattern/get.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/pattern/list.md b/commands/block/pattern/list.md index fa63f172..783789d3 100644 --- a/commands/block/pattern/list.md +++ b/commands/block/pattern/list.md @@ -76,6 +76,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -88,3 +89,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/style/get.md b/commands/block/style/get.md index f83d54fb..34137915 100644 --- a/commands/block/style/get.md +++ b/commands/block/style/get.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/style/list.md b/commands/block/style/list.md index a27025ce..80921c23 100644 --- a/commands/block/style/list.md +++ b/commands/block/style/list.md @@ -61,6 +61,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -73,3 +74,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/synced-pattern/create.md b/commands/block/synced-pattern/create.md index 60039dbb..d0dbc2b0 100644 --- a/commands/block/synced-pattern/create.md +++ b/commands/block/synced-pattern/create.md @@ -59,6 +59,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -71,3 +72,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/synced-pattern/delete.md b/commands/block/synced-pattern/delete.md index 11c93525..99773cb0 100644 --- a/commands/block/synced-pattern/delete.md +++ b/commands/block/synced-pattern/delete.md @@ -32,6 +32,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -44,3 +45,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/synced-pattern/get.md b/commands/block/synced-pattern/get.md index e08a5f3c..972317af 100644 --- a/commands/block/synced-pattern/get.md +++ b/commands/block/synced-pattern/get.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/synced-pattern/list.md b/commands/block/synced-pattern/list.md index db3f14a0..a8f4f204 100644 --- a/commands/block/synced-pattern/list.md +++ b/commands/block/synced-pattern/list.md @@ -74,6 +74,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -86,3 +87,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/synced-pattern/update.md b/commands/block/synced-pattern/update.md index 3494fc2a..957d273c 100644 --- a/commands/block/synced-pattern/update.md +++ b/commands/block/synced-pattern/update.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/template/export.md b/commands/block/template/export.md index 5c85d459..742ef9e5 100644 --- a/commands/block/template/export.md +++ b/commands/block/template/export.md @@ -50,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/template/get.md b/commands/block/template/get.md index 69c79604..3f959c1f 100644 --- a/commands/block/template/get.md +++ b/commands/block/template/get.md @@ -55,6 +55,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -67,3 +68,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/template/list.md b/commands/block/template/list.md index 8a242f8d..06696ed8 100644 --- a/commands/block/template/list.md +++ b/commands/block/template/list.md @@ -97,6 +97,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -109,3 +110,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/type/exists.md b/commands/block/type/exists.md index 2231e4ac..799ff373 100644 --- a/commands/block/type/exists.md +++ b/commands/block/type/exists.md @@ -31,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/type/get.md b/commands/block/type/get.md index 5047a46d..16baeb53 100644 --- a/commands/block/type/get.md +++ b/commands/block/type/get.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/block/type/list.md b/commands/block/type/list.md index 99b5ffca..940bd616 100644 --- a/commands/block/type/list.md +++ b/commands/block/type/list.md @@ -86,6 +86,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -98,3 +99,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache.md b/commands/cache.md index b351dee5..31e137f7 100644 --- a/commands/cache.md +++ b/commands/cache.md @@ -4,7 +4,7 @@ Adds, removes, fetches, and flushes the WP Object Cache object. By default, the WP Object Cache exists in PHP memory for the length of the request (and is emptied at the end). Use a persistent object cache drop-in to persist the object cache between requests. -[Read the codex article](https://developer.wordpress.org/reference/classes/wp_object_cache) for more detail. +[Read the documentation](https://developer.wordpress.org/reference/classes/wp_object_cache) for more detail. ### EXAMPLES diff --git a/commands/cache/add.md b/commands/cache/add.md index 33ef2463..9ba14c67 100644 --- a/commands/cache/add.md +++ b/commands/cache/add.md @@ -29,8 +29,8 @@ default: 0 ### EXAMPLES # Add cache. - $ wp cache add my_key my_group my_value 300 - Success: Added object 'my_key' in group 'my_value'. + $ wp cache add my_key my_value my_group 300 + Success: Added object 'my_key' in group 'my_group'. ### GLOBAL PARAMETERS @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/decr.md b/commands/cache/decr.md index afc5ac7f..78abe0ac 100644 --- a/commands/cache/decr.md +++ b/commands/cache/decr.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/delete.md b/commands/cache/delete.md index 0b0f9ee3..ac6166bd 100644 --- a/commands/cache/delete.md +++ b/commands/cache/delete.md @@ -32,6 +32,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -44,3 +45,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/flush-group.md b/commands/cache/flush-group.md index 204dc84b..5022f4e7 100644 --- a/commands/cache/flush-group.md +++ b/commands/cache/flush-group.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/flush.md b/commands/cache/flush.md index 0804b13d..d4b80940 100644 --- a/commands/cache/flush.md +++ b/commands/cache/flush.md @@ -21,6 +21,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -33,3 +34,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/get.md b/commands/cache/get.md index 72c429a4..371ec64e 100644 --- a/commands/cache/get.md +++ b/commands/cache/get.md @@ -32,6 +32,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -44,3 +45,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/incr.md b/commands/cache/incr.md index 1d30d556..ad2b37cc 100644 --- a/commands/cache/incr.md +++ b/commands/cache/incr.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/patch.md b/commands/cache/patch.md index 522f0330..b13ffc9a 100644 --- a/commands/cache/patch.md +++ b/commands/cache/patch.md @@ -54,6 +54,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -66,3 +67,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/pluck.md b/commands/cache/pluck.md index 5770fc4f..3576f4a5 100644 --- a/commands/cache/pluck.md +++ b/commands/cache/pluck.md @@ -37,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -49,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/replace.md b/commands/cache/replace.md index da3abe13..70da620d 100644 --- a/commands/cache/replace.md +++ b/commands/cache/replace.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/set.md b/commands/cache/set.md index 7f0d2412..9e4d675f 100644 --- a/commands/cache/set.md +++ b/commands/cache/set.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/supports.md b/commands/cache/supports.md index d69af935..a17c532c 100644 --- a/commands/cache/supports.md +++ b/commands/cache/supports.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cache/type.md b/commands/cache/type.md index fc1c781c..8d14d6e9 100644 --- a/commands/cache/type.md +++ b/commands/cache/type.md @@ -19,6 +19,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -31,3 +32,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cap.md b/commands/cap.md index 4d8de3bf..4b520332 100644 --- a/commands/cap.md +++ b/commands/cap.md @@ -2,7 +2,8 @@ Adds, removes, and lists capabilities of a user role. -See references for [Roles and Capabilities](https://wordpress.org/documentation/article/roles-and-capabilities) and [WP User class](https://developer.wordpress.org/reference/classes/wp_user). +See references for [Roles and Capabilities](https://wordpress.org/documentation/article/roles-and-capabilities) and +[WP User class](https://developer.wordpress.org/reference/classes/wp_user). ### EXAMPLES diff --git a/commands/cap/add.md b/commands/cap/add.md index d297ff21..ecae55ea 100644 --- a/commands/cap/add.md +++ b/commands/cap/add.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cap/list.md b/commands/cap/list.md index 6395fbb1..777d3313 100644 --- a/commands/cap/list.md +++ b/commands/cap/list.md @@ -47,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -59,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cap/remove.md b/commands/cap/remove.md index 7df769f4..3b855c8f 100644 --- a/commands/cap/remove.md +++ b/commands/cap/remove.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/alias.md b/commands/cli/alias.md index e597f278..d4f8edfa 100644 --- a/commands/cli/alias.md +++ b/commands/cli/alias.md @@ -4,7 +4,21 @@ Retrieves, sets and updates aliases for WordPress Installations. Unless overridden, these commands run on the `before_wp_load` hook, just before the WP load process begins. -Aliases are shorthand references to WordPress installs. For instance, `@dev` could refer to a development install and `@prod` could refer to a production install. This command gives you and option to add, update and delete, the registered aliases you have available. +Aliases are shorthand references to WordPress installs. For instance, `@dev` could refer to a development install and `@prod` could refer to a production install. This command gives you an option to add, update and delete, the registered aliases you have available. + +Environment variables can be used in alias definitions using the syntax `${env.VARIABLE_NAME}`. This allows you to centralize configuration in environment variables or .env files. + +### SECURITY CONSIDERATIONS + +When environment variables are used in aliases, their interpolated values will appear in command output (e.g., `wp cli alias list` or `wp cli alias get`). If you have sensitive data in environment variables (such as passwords or API keys), be aware that these values may be exposed in: + +- Terminal output when listing or viewing aliases +- Log files if command output is redirected +- Shell history if used in command arguments + +To view aliases without interpolating environment variables, use the `--raw` flag. + +Learn more about [running commands remotely](https://make.wordpress.org/cli/handbook/guides/running-commands-remotely/). ### EXAMPLES @@ -33,6 +47,20 @@ Aliases are shorthand references to WordPress installs. For instance, `@dev` cou $ wp cli alias delete @prod Success: Deleted '@prod' alias. + # Use environment variables in alias definitions. + # In wp-cli.yml: + # @prod: + # ssh: ${env.PROD_USER}@${env.PROD_HOST}:${env.PROD_PATH} + # user: ${env.PROD_WP_USER} + $ export PROD_USER=myuser PROD_HOST=example.com PROD_PATH=/var/www PROD_WP_USER=admin + $ wp @prod option get home + + # View aliases without environment variable interpolation. + $ wp cli alias list --raw + + # Run a command against a group of aliases in parallel. + $ WP_CLI_ALIAS_GROUPS_PARALLEL=1 wp @all plugin status + diff --git a/commands/cli/alias/add.md b/commands/cli/alias/add.md index 7fe87824..12fb8042 100644 --- a/commands/cli/alias/add.md +++ b/commands/cli/alias/add.md @@ -61,6 +61,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -73,3 +74,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/alias/delete.md b/commands/cli/alias/delete.md index b42c53b2..c9e320d8 100644 --- a/commands/cli/alias/delete.md +++ b/commands/cli/alias/delete.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/alias/get.md b/commands/cli/alias/get.md index 7c389284..31ef8bec 100644 --- a/commands/cli/alias/get.md +++ b/commands/cli/alias/get.md @@ -11,12 +11,26 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg <key> : Key for the alias. +[\--field=<field>] +: Get the value of a specific field. + +[\--raw] +: Display alias without interpolating environment variables. + ### EXAMPLES # Get alias. $ wp cli alias get @prod ssh: dev@somedeve.env:12345/home/dev/ + # Get a specific field of an alias. + $ wp cli alias get @prod --field=ssh + dev@somedeve.env:12345/home/dev/ + + # Get alias without environment variable interpolation. + $ wp cli alias get @prod --raw + ssh: ${env.PROD_USER}@${env.PROD_HOST}:${env.PROD_PATH} + ### 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. @@ -26,6 +40,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +53,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/alias/is-group.md b/commands/cli/alias/is-group.md index d4a0508a..fc50b92e 100644 --- a/commands/cli/alias/is-group.md +++ b/commands/cli/alias/is-group.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/alias/list.md b/commands/cli/alias/list.md index 5d3e4678..6ad9502e 100644 --- a/commands/cli/alias/list.md +++ b/commands/cli/alias/list.md @@ -18,6 +18,9 @@ options: - var_export \--- +[\--raw] +: Display aliases without interpolating environment variables. + ### EXAMPLES # List all available aliases. @@ -32,6 +35,9 @@ options: - @prod - @dev + # List aliases without environment variable interpolation. + $ wp cli alias list --raw + ### 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. @@ -41,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/alias/update.md b/commands/cli/alias/update.md index e146aade..906d6e88 100644 --- a/commands/cli/alias/update.md +++ b/commands/cli/alias/update.md @@ -56,6 +56,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -68,3 +69,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/cache.md b/commands/cli/cache.md index cd605e69..b8500187 100644 --- a/commands/cli/cache.md +++ b/commands/cli/cache.md @@ -1,6 +1,6 @@ # wp cli cache -Manages the internal WP-CLI cache,. +Manages the internal WP-CLI cache. Unless overridden, these commands run on the `before_wp_load` hook, just before the WP load process begins. diff --git a/commands/cli/cache/clear.md b/commands/cli/cache/clear.md index 32f952e7..4d65d977 100644 --- a/commands/cli/cache/clear.md +++ b/commands/cli/cache/clear.md @@ -18,6 +18,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -30,3 +31,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/cache/prune.md b/commands/cli/cache/prune.md index 5b9744a8..463fcd86 100644 --- a/commands/cli/cache/prune.md +++ b/commands/cli/cache/prune.md @@ -20,6 +20,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -32,3 +33,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/check-update.md b/commands/cli/check-update.md index 0a91121c..9e150221 100644 --- a/commands/cli/check-update.md +++ b/commands/cli/check-update.md @@ -6,6 +6,8 @@ This command runs on the `before_wp_load` hook, just before the WP load process Queries the GitHub releases API. Returns available versions if there are updates available, or success message if using the latest release. +Unauthenticated requests to the GitHub API are rate limited to 60 per hour per IP address. If you are experiencing rate limit issues, you can generate a GitHub personal access token and set the GITHUB_TOKEN environment variable before running this command. Authenticated requests have a higher rate limit of 5,000 per hour. The token only needs public repository read access (no specific scopes required for public data). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -51,6 +53,10 @@ options: | 0.24.1 | patch | https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar | +---------+-------------+-------------------------------------------------------------------------------+ + # Check for update using a GitHub token to increase rate limit. + $ GITHUB_TOKEN=ghp_... wp cli check-update + Success: WP-CLI is at the latest version. + ### 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. @@ -60,6 +66,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -72,3 +79,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/cmd-dump.md b/commands/cli/cmd-dump.md index 0ef28816..1bc9bcd6 100644 --- a/commands/cli/cmd-dump.md +++ b/commands/cli/cmd-dump.md @@ -17,6 +17,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -29,3 +30,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/completions.md b/commands/cli/completions.md index b4ebcde6..20be5675 100644 --- a/commands/cli/completions.md +++ b/commands/cli/completions.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/has-command.md b/commands/cli/has-command.md index 87d5c559..ba116623 100644 --- a/commands/cli/has-command.md +++ b/commands/cli/has-command.md @@ -39,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -51,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/info.md b/commands/cli/info.md index 2d27d5b5..10167392 100644 --- a/commands/cli/info.md +++ b/commands/cli/info.md @@ -10,6 +10,7 @@ Helpful for diagnostic purposes, this command shares: * Shell information. * PHP binary used. * PHP binary version. +* PHP memory limit. * php.ini configuration file used (which is typically different than web). * WP-CLI root dir: where WP-CLI is installed (if non-Phar install). * WP-CLI global config: where the global config YAML file is located. @@ -39,6 +40,7 @@ options: Shell: /usr/bin/zsh PHP binary: /usr/bin/php PHP version: 7.1.12-1+ubuntu16.04.1+deb.sury.org+1 + PHP memory limit: 512M php.ini used: /etc/php/7.1/cli/php.ini WP-CLI root dir: phar://wp-cli.phar WP-CLI packages dir: /home/person/.wp-cli/packages/ @@ -55,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -67,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/param-dump.md b/commands/cli/param-dump.md index b7cb39d6..4741b675 100644 --- a/commands/cli/param-dump.md +++ b/commands/cli/param-dump.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/update.md b/commands/cli/update.md index cf4713c3..a647440b 100644 --- a/commands/cli/update.md +++ b/commands/cli/update.md @@ -12,6 +12,8 @@ Use `--nightly` to install the latest built version of the master branch. While Only works for the Phar installation mechanism. +Unauthenticated requests to the GitHub API are rate limited to 60 per hour per IP address. If you are experiencing rate limit issues, you can generate a GitHub personal access token and set the GITHUB_TOKEN environment variable before running this command. Authenticated requests have a higher rate limit of 5,000 per hour. The token only needs public repository read access (no specific scopes required for public data). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -46,6 +48,13 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg New version works. Proceeding to replace. Success: Updated WP-CLI to 0.24.1. + # Update CLI using a GitHub token to increase rate limit. + $ GITHUB_TOKEN=ghp_... wp cli update + You are currently using WP-CLI version 0.24.0. Would you like to update to 0.24.1? [y/n] y + Downloading from https://github.com/wp-cli/wp-cli/releases/download/v0.24.1/wp-cli-0.24.1.phar... + New version works. Proceeding to replace. + Success: Updated WP-CLI to 0.24.1. + ### 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. @@ -55,6 +64,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -67,3 +77,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cli/version.md b/commands/cli/version.md index 3cc39bc9..05353208 100644 --- a/commands/cli/version.md +++ b/commands/cli/version.md @@ -19,6 +19,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -31,3 +32,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment.md b/commands/comment.md index 8b169998..2071ef8c 100644 --- a/commands/comment.md +++ b/commands/comment.md @@ -21,4 +21,32 @@ Creates, updates, deletes, and moderates comments. Success: Trashed comment 264. Success: Trashed comment 262. + # Create a note for a block (WordPress 6.9+). + $ wp comment create --comment_post_ID=15 --comment_content="This block needs revision" --comment_author="editor" --comment_type="note" + Success: Created comment 945. + + # List notes for a specific post (WordPress 6.9+). + $ wp comment list --type=note --post_id=15 + +------------+---------------------+----------------------------------+ + | comment_ID | comment_date | comment_content | + +------------+---------------------+----------------------------------+ + | 945 | 2024-11-10 14:30:00 | This block needs revision | + +------------+---------------------+----------------------------------+ + + # Reply to a note (WordPress 6.9+). + $ wp comment create --comment_post_ID=15 --comment_content="Updated per feedback" --comment_author="editor" --comment_type="note" --comment_parent=945 + Success: Created comment 946. + + # Resolve a note by adding a comment with status meta (WordPress 6.9+). + $ wp comment create --comment_post_ID=15 --comment_content="Resolving" --comment_author="editor" --comment_type="note" --comment_parent=945 --porcelain + 947 + $ wp comment meta add 947 _wp_note_status resolved + Success: Added custom field. + + # Reopen a resolved note (WordPress 6.9+). + $ wp comment create --comment_post_ID=15 --comment_content="Reopening for further review" --comment_author="editor" --comment_type="note" --comment_parent=945 --porcelain + 948 + $ wp comment meta add 948 _wp_note_status reopen + Success: Added custom field. + diff --git a/commands/comment/approve.md b/commands/comment/approve.md index 468a1aad..36c90997 100644 --- a/commands/comment/approve.md +++ b/commands/comment/approve.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/count.md b/commands/comment/count.md index 824ac0f9..5ec88f05 100644 --- a/commands/comment/count.md +++ b/commands/comment/count.md @@ -40,6 +40,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -52,3 +53,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/create.md b/commands/comment/create.md index c2408fc9..18d03554 100644 --- a/commands/comment/create.md +++ b/commands/comment/create.md @@ -18,6 +18,10 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg $ wp comment create --comment_post_ID=15 --comment_content="hello blog" --comment_author="wp-cli" Success: Created comment 932. + # Create a note (WordPress 6.9+). + $ wp comment create --comment_post_ID=15 --comment_content="This block needs revision" --comment_author="editor" --comment_type="note" + Success: Created comment 933. + ### 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. @@ -27,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/delete.md b/commands/comment/delete.md index 919319e9..80361b84 100644 --- a/commands/comment/delete.md +++ b/commands/comment/delete.md @@ -32,6 +32,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -44,3 +45,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/exists.md b/commands/comment/exists.md index 2448381f..8e8fef1f 100644 --- a/commands/comment/exists.md +++ b/commands/comment/exists.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/generate.md b/commands/comment/generate.md index 4226865a..d21230e2 100644 --- a/commands/comment/generate.md +++ b/commands/comment/generate.md @@ -47,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -59,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/get.md b/commands/comment/get.md index 92d0e7c0..3831cd1f 100644 --- a/commands/comment/get.md +++ b/commands/comment/get.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/list.md b/commands/comment/list.md index 7350fdcf..ac5ea2de 100644 --- a/commands/comment/list.md +++ b/commands/comment/list.md @@ -107,6 +107,15 @@ These fields are optionally available: | 3 | 2023-11-10 11:22:31 | John Doe | +------------+---------------------+----------------+ + # List notes for a specific post (WordPress 6.9+). + $ wp comment list --type=note --post_id=15 --fields=ID,comment_date,comment_content + +------------+---------------------+----------------------------------+ + | comment_ID | comment_date | comment_content | + +------------+---------------------+----------------------------------+ + | 10 | 2024-11-10 14:30:00 | This block needs revision | + | 11 | 2024-11-10 15:45:00 | Updated per feedback | + +------------+---------------------+----------------------------------+ + ### 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. @@ -116,6 +125,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -128,3 +138,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/add.md b/commands/comment/meta/add.md index 0d0037ae..b957099c 100644 --- a/commands/comment/meta/add.md +++ b/commands/comment/meta/add.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/delete.md b/commands/comment/meta/delete.md index 7cea2456..f5d772bf 100644 --- a/commands/comment/meta/delete.md +++ b/commands/comment/meta/delete.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/get.md b/commands/comment/meta/get.md index 86dad003..4f88604b 100644 --- a/commands/comment/meta/get.md +++ b/commands/comment/meta/get.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/list.md b/commands/comment/meta/list.md index 8674bc18..c6d1f6a0 100644 --- a/commands/comment/meta/list.md +++ b/commands/comment/meta/list.md @@ -58,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -70,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/patch.md b/commands/comment/meta/patch.md index d7dd401c..b588ce99 100644 --- a/commands/comment/meta/patch.md +++ b/commands/comment/meta/patch.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/pluck.md b/commands/comment/meta/pluck.md index 21df837e..76dcbcf4 100644 --- a/commands/comment/meta/pluck.md +++ b/commands/comment/meta/pluck.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/set.md b/commands/comment/meta/set.md index 3a827ae9..7f8101d7 100644 --- a/commands/comment/meta/set.md +++ b/commands/comment/meta/set.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/meta/update.md b/commands/comment/meta/update.md index a114f53b..f2198a44 100644 --- a/commands/comment/meta/update.md +++ b/commands/comment/meta/update.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/recount.md b/commands/comment/recount.md index 53bcc382..07f275a0 100644 --- a/commands/comment/recount.md +++ b/commands/comment/recount.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/spam.md b/commands/comment/spam.md index 3c4ab824..c2469307 100644 --- a/commands/comment/spam.md +++ b/commands/comment/spam.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/status.md b/commands/comment/status.md index 29e66cb8..82bf0fb4 100644 --- a/commands/comment/status.md +++ b/commands/comment/status.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/trash.md b/commands/comment/trash.md index 8566eb29..c3d38a3e 100644 --- a/commands/comment/trash.md +++ b/commands/comment/trash.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/unapprove.md b/commands/comment/unapprove.md index ddd459b6..32039fe1 100644 --- a/commands/comment/unapprove.md +++ b/commands/comment/unapprove.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/unspam.md b/commands/comment/unspam.md index 4f5713fd..d2ef469f 100644 --- a/commands/comment/unspam.md +++ b/commands/comment/unspam.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/untrash.md b/commands/comment/untrash.md index fd56003f..e2ebd552 100644 --- a/commands/comment/untrash.md +++ b/commands/comment/untrash.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/comment/update.md b/commands/comment/update.md index acf0d921..9ac6f004 100644 --- a/commands/comment/update.md +++ b/commands/comment/update.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config.md b/commands/config.md index 10bcfafe..d7206f7a 100644 --- a/commands/config.md +++ b/commands/config.md @@ -29,6 +29,14 @@ Generates and reads the wp-config.php file. $ wp config get table_prefix wp_ + # Add a new constant to the wp-config.php file. + $ wp config add WP_DEBUG true --raw + Success: Added the constant 'WP_DEBUG' to the 'wp-config.php' file with the raw value 'true'. + + # Update or add a constant to the wp-config.php file. + $ wp config update WP_DEBUG false --raw + Success: Updated the constant 'WP_DEBUG' in the 'wp-config.php' file with the raw value 'false'. + # Set the WP_DEBUG constant to true. $ wp config set WP_DEBUG true --raw Success: Updated the constant 'WP_DEBUG' in the 'wp-config.php' file with the raw value 'true'. diff --git a/commands/config/add.md b/commands/config/add.md new file mode 100644 index 00000000..2e40a82f --- /dev/null +++ b/commands/config/add.md @@ -0,0 +1,76 @@ +# wp config add + +Adds a new constant or variable to the wp-config.php file. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<name> +: Name of the wp-config.php constant or variable. + +<value> +: Value to set the wp-config.php constant or variable to. + +[\--raw] +: Place the value into the wp-config.php file as is, instead of as a quoted string. + +[\--anchor=<anchor>] +: Anchor string where additions of new values are anchored around. Defaults to "/* That's all, stop editing!". The special case "EOF" string uses the end of the file as the anchor. + +[\--placement=<placement>] +: Where to place the new values in relation to the anchor string. +\--- +default: 'before' +options: + - before + - after +\--- + +[\--separator=<separator>] +: Separator string to put between an added value and its anchor string. The following escape sequences will be recognized and properly interpreted: '\n' => newline, '\r' => carriage return, '\t' => tab. Defaults to a single EOL ("\n" on *nix and "\r\n" on Windows). + +[\--type=<type>] +: Type of the config value to add. Defaults to 'constant'. +\--- +default: constant +options: + - constant + - variable +\--- + +[\--config-file=<path>] +: Specify the file path to the config file to be modified. Defaults to the root of the WordPress installation and the filename "wp-config.php". + +### EXAMPLES + + # Add the WP_DEBUG constant to the wp-config.php file. + $ wp config add WP_DEBUG true --raw + Success: Added the constant 'WP_DEBUG' to the 'wp-config.php' file with the raw value 'true'. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/create.md b/commands/config/create.md index ca6661ba..f8f20aca 100644 --- a/commands/config/create.md +++ b/commands/config/create.md @@ -8,14 +8,17 @@ Creates a new wp-config.php with database constants, and verifies that the datab See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. -\--dbname=<dbname> -: Set the database name. +[\--dbname=<dbname>] +: Set the database name. Required unless `--skip-check` is used or the SQLite integration drop-in is detected. -\--dbuser=<dbuser> -: Set the database user. +[\--dbuser=<dbuser>] +: Set the database user. Required unless `--skip-check` is used or the SQLite integration drop-in is detected. [\--dbpass=<dbpass>] : Set the database user password. +\--- +sensitive: true +\--- [\--dbhost=<dbhost>] : Set the database host. @@ -92,6 +95,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -104,3 +108,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/delete.md b/commands/config/delete.md index efbabd82..6764fe20 100644 --- a/commands/config/delete.md +++ b/commands/config/delete.md @@ -39,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -51,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/edit.md b/commands/config/edit.md index 67e9b3b1..f6132aee 100644 --- a/commands/config/edit.md +++ b/commands/config/edit.md @@ -28,6 +28,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -40,3 +41,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/get.md b/commands/config/get.md index f140b4f8..78f43aff 100644 --- a/commands/config/get.md +++ b/commands/config/get.md @@ -50,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/has.md b/commands/config/has.md index 3fdebe76..975609a7 100644 --- a/commands/config/has.md +++ b/commands/config/has.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/is-true.md b/commands/config/is-true.md index 818170b3..2d78d489 100644 --- a/commands/config/is-true.md +++ b/commands/config/is-true.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/list.md b/commands/config/list.md index 88d6d37c..1b331a3e 100644 --- a/commands/config/list.md +++ b/commands/config/list.md @@ -76,6 +76,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -88,3 +89,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/path.md b/commands/config/path.md index 58265bce..0f57a14f 100644 --- a/commands/config/path.md +++ b/commands/config/path.md @@ -19,6 +19,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -31,3 +32,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/set.md b/commands/config/set.md index 89bbe7d1..3302d8a1 100644 --- a/commands/config/set.md +++ b/commands/config/set.md @@ -63,6 +63,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -75,3 +76,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/shuffle-salts.md b/commands/config/shuffle-salts.md index 4d9034c0..24e53b0f 100644 --- a/commands/config/shuffle-salts.md +++ b/commands/config/shuffle-salts.md @@ -39,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -51,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/config/update.md b/commands/config/update.md new file mode 100644 index 00000000..69ad7e9c --- /dev/null +++ b/commands/config/update.md @@ -0,0 +1,79 @@ +# wp config update + +Updates or adds a constant or variable in the wp-config.php file. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +This command will add the constant or variable if it doesn't exist, or update it if it does. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<name> +: Name of the wp-config.php constant or variable. + +<value> +: Value to set the wp-config.php constant or variable to. + +[\--raw] +: Place the value into the wp-config.php file as is, instead of as a quoted string. + +[\--anchor=<anchor>] +: Anchor string where additions of new values are anchored around. Defaults to "/* That's all, stop editing!". The special case "EOF" string uses the end of the file as the anchor. + +[\--placement=<placement>] +: Where to place the new values in relation to the anchor string. +\--- +default: 'before' +options: + - before + - after +\--- + +[\--separator=<separator>] +: Separator string to put between an added value and its anchor string. The following escape sequences will be recognized and properly interpreted: '\n' => newline, '\r' => carriage return, '\t' => tab. Defaults to a single EOL ("\n" on *nix and "\r\n" on Windows). + +[\--type=<type>] +: Type of the config value to update. Defaults to 'all'. +\--- +default: all +options: + - constant + - variable + - all +\--- + +[\--config-file=<path>] +: Specify the file path to the config file to be modified. Defaults to the root of the WordPress installation and the filename "wp-config.php". + +### EXAMPLES + + # Update or add the WP_DEBUG constant to the wp-config.php file. + $ wp config update WP_DEBUG true --raw + Success: Updated the constant 'WP_DEBUG' in the 'wp-config.php' file with the raw value 'true'. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/connectors.md b/commands/connectors.md new file mode 100644 index 00000000..18f323bb --- /dev/null +++ b/commands/connectors.md @@ -0,0 +1,13 @@ +# wp connectors + +Lists and retrieves information about AI connectors. + +### EXAMPLES + + # List all available connectors + $ wp connectors list + + # Get details about a specific connector + $ wp connectors get openai + + diff --git a/commands/connectors/get.md b/commands/connectors/get.md new file mode 100644 index 00000000..66fb591c --- /dev/null +++ b/commands/connectors/get.md @@ -0,0 +1,63 @@ +# wp connectors get + +Gets details about a specific AI connector. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<connector> +: The connector ID (e.g., openai, anthropic, google). + +[\--fields=<fields>] +: Comma-separated list of fields to include in the output. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + # Get details for the OpenAI connector + $ wp connectors get openai + +-----------------+-----------------------------------------------+ + | Field | Value | + +-----------------+-----------------------------------------------+ + | name | OpenAI | + | description | Text and image generation with GPT and Dall-E | + | status | connected | + | credentials_url | https://platform.openai.com/api-keys | + | api_key | ••••••••••••6789 | + +-----------------+-----------------------------------------------+ + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/connectors/list.md b/commands/connectors/list.md new file mode 100644 index 00000000..4c6e766b --- /dev/null +++ b/commands/connectors/list.md @@ -0,0 +1,71 @@ +# wp connectors list + +Lists all available AI connectors. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--status=<status>] +: Filter connectors by status. +\--- +options: + - connected + - active + - installed + - not installed +\--- + +[\--fields=<fields>] +: Comma-separated list of fields to include in the output. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + # List all connectors + $ wp connectors list + +-----------+-----------------------------------------------+---------------+ + | name | description | status | + +-----------+-----------------------------------------------+---------------+ + | Anthropic | Text generation with Claude. | not installed | + | Google | Text and image generation with Gemini... | not installed | + | OpenAI | Text and image generation with GPT and Dall-E | connected | + +-----------+-----------------------------------------------+---------------+ + + # List only connected connectors + $ wp connectors list --status=connected + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/check-update-db.md b/commands/core/check-update-db.md new file mode 100644 index 00000000..14266d48 --- /dev/null +++ b/commands/core/check-update-db.md @@ -0,0 +1,47 @@ +# wp core check-update-db + +Checks for the need for WordPress database updates. + +Compares the current database version with the version required by WordPress core to determine if database updates are needed. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--network] +: Check databases for all sites on a network. + +### EXAMPLES + + # Check if database update is needed + $ wp core check-update-db + Success: WordPress database is up to date. + + # Check database update status for all sites on a network + $ wp core check-update-db --network + Success: WordPress databases are up to date on 5/5 sites. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/check-update.md b/commands/core/check-update.md index b94ab54a..a1fb51a7 100644 --- a/commands/core/check-update.md +++ b/commands/core/check-update.md @@ -53,6 +53,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -65,3 +66,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/download.md b/commands/core/download.md index 2d4eeb71..b9c9a25c 100644 --- a/commands/core/download.md +++ b/commands/core/download.md @@ -34,6 +34,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--extract] : Whether to extract the downloaded file. Defaults to true. +[\--skip-locale-check] +: If specified, allows downloading an older version of WordPress when the requested locale is not available for the latest release. + ### EXAMPLES $ wp core download --locale=nl_NL @@ -50,6 +53,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +66,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/install-network.md b/commands/core/install-network.md index c2962d03..89088133 100644 --- a/commands/core/install-network.md +++ b/commands/core/install-network.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/install.md b/commands/core/install.md index 0ab108b2..8bff93c5 100644 --- a/commands/core/install.md +++ b/commands/core/install.md @@ -21,7 +21,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg \--admin_user=<username> : The name of the admin user. -[\--admin_password=<password>] +[\--admin_password|admin_pass=<password>] : The password for the admin user. Defaults to randomly generated string. \--admin_email=<email> @@ -51,6 +51,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -63,3 +64,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/is-installed.md b/commands/core/is-installed.md index 7a0335d6..cacd78e2 100644 --- a/commands/core/is-installed.md +++ b/commands/core/is-installed.md @@ -39,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -51,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/multisite-convert.md b/commands/core/multisite-convert.md index a8a56c77..0e96d6cf 100644 --- a/commands/core/multisite-convert.md +++ b/commands/core/multisite-convert.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/multisite-install.md b/commands/core/multisite-install.md index f59bb94b..20b44afd 100644 --- a/commands/core/multisite-install.md +++ b/commands/core/multisite-install.md @@ -37,6 +37,9 @@ default: admin \--admin_email=<email> : The email address for the admin user. +[\--locale=<locale>] +: The locale/language for the installation (e.g. `de_DE`). Default is `en_US`. + [\--skip-email] : Don't send an email notification to the new admin user. @@ -62,6 +65,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -74,3 +78,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/update-db.md b/commands/core/update-db.md index 9f981ea8..0fd96c43 100644 --- a/commands/core/update-db.md +++ b/commands/core/update-db.md @@ -23,6 +23,11 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg WordPress database upgraded successfully from db version 35700 to 29630 on example.com/ Success: WordPress database upgraded on 123/123 sites. + # Update databases for all sites on a specific network in a multinetwork install. + $ wp core update-db --network --url=network2.example.com + WordPress database upgraded successfully from db version 35700 to 29630 on network2.example.com/ + Success: WordPress database upgraded on 50/50 sites. + ### 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. @@ -32,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -44,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/update.md b/commands/core/update.md index deb8594b..5b6a0606 100644 --- a/commands/core/update.md +++ b/commands/core/update.md @@ -27,6 +27,15 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--locale=<locale>] : Select which language you want to download. +[\--format=<format>] +: Render output in a particular format. +\--- +options: + - table + - csv + - json +\--- + [\--insecure] : Retry download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. @@ -38,7 +47,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg Downloading update from https://downloads.wordpress.org/release/wordpress-4.5.2-no-content.zip... Unpacking the update... Cleaning up files... - No files found that need cleaning up + No old files were removed. Success: WordPress updated successfully. # Update WordPress using zip file. @@ -52,7 +61,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg Updating to version 3.1 (en_US)... Downloading update from https://wordpress.org/wordpress-3.1.zip... Unpacking the update... - Warning: Checksums not available for WordPress 3.1/en_US. Please cleanup files manually. + Cleaning up files... + No old files were removed. + Warning: Could not retrieve WordPress core checksums; skipping checksum-based cleanup. Files listed in $_old_files were still cleaned up. Success: WordPress updated successfully. ### GLOBAL PARAMETERS @@ -64,6 +75,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -76,3 +88,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/upgrade.md b/commands/core/upgrade.md index 473b286f..869f6105 100644 --- a/commands/core/upgrade.md +++ b/commands/core/upgrade.md @@ -27,6 +27,15 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--locale=<locale>] : Select which language you want to download. +[\--format=<format>] +: Render output in a particular format. +\--- +options: + - table + - csv + - json +\--- + [\--insecure] : Retry download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. @@ -38,7 +47,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg Downloading update from https://downloads.wordpress.org/release/wordpress-4.5.2-no-content.zip... Unpacking the update... Cleaning up files... - No files found that need cleaning up + No old files were removed. Success: WordPress updated successfully. # Update WordPress using zip file. @@ -52,7 +61,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg Updating to version 3.1 (en_US)... Downloading update from https://wordpress.org/wordpress-3.1.zip... Unpacking the update... - Warning: Checksums not available for WordPress 3.1/en_US. Please cleanup files manually. + Cleaning up files... + No old files were removed. + Warning: Could not retrieve WordPress core checksums; skipping checksum-based cleanup. Files listed in $_old_files were still cleaned up. Success: WordPress updated successfully. ### GLOBAL PARAMETERS @@ -64,6 +75,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -76,3 +88,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/verify-checksums.md b/commands/core/verify-checksums.md index ecc3b665..afb7b830 100644 --- a/commands/core/verify-checksums.md +++ b/commands/core/verify-checksums.md @@ -81,6 +81,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -93,3 +94,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/core/version.md b/commands/core/version.md index 8730a583..0bc761ae 100644 --- a/commands/core/version.md +++ b/commands/core/version.md @@ -11,6 +11,8 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--extra] : Show extended version information. +Note: In a Multisite installation, `wp core version --extra` reports the expected database revision from `wp-includes/version.php`, not the per-site `db_version` stored in each subsite's options table. To retrieve a subsite's stored database revision, use `wp option get db_version --url=`. See also `wp core check-update-db`. + ### EXAMPLES # Display the WordPress version @@ -33,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cron/event/delete.md b/commands/cron/event/delete.md index 56521e39..c6a52a15 100644 --- a/commands/cron/event/delete.md +++ b/commands/cron/event/delete.md @@ -18,12 +18,19 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--all] : Delete all hooks. +[\--match-args=<args>] +: Only delete events whose arguments match the given JSON-encoded array or scalar value. Argument types must match exactly (for example, `["123"]` vs `[123]`). Requires exactly one hook name. + ### EXAMPLES # Delete all scheduled cron events for the given hook $ wp cron event delete cron_test Success: Deleted a total of 2 cron events. + # Delete a specific cron event by hook and arguments + $ wp cron event delete cron_test --match-args='["123"]' + Success: Deleted a total of 1 cron event. + ### 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. @@ -33,6 +40,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +53,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cron/event/list.md b/commands/cron/event/list.md index 5f991183..5e717216 100644 --- a/commands/cron/event/list.md +++ b/commands/cron/event/list.md @@ -43,6 +43,7 @@ These fields are optionally available: * schedule * interval * next_run +* actions ### EXAMPLES @@ -69,6 +70,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -81,3 +83,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cron/event/run.md b/commands/cron/event/run.md index 776fd96f..75a7200a 100644 --- a/commands/cron/event/run.md +++ b/commands/cron/event/run.md @@ -10,7 +10,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : One or more hooks to run. [\--due-now] -: Run all hooks due right now. +: Run all hooks due right now. Respects the doing_cron transient to prevent overlapping runs. [\--exclude=<hooks>] : Comma-separated list of hooks to exclude. @@ -18,6 +18,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--all] : Run all hooks. +[\--network] +: Run hooks across all sites in a multisite installation. + ### EXAMPLES # Run all cron events due right now @@ -26,6 +29,12 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg Executed the cron event 'cron_test_2' in 0.006s. Success: Executed a total of 2 cron events. + # Run all cron events due right now across all sites in a multisite + $ wp cron event run --due-now --network + Executed the cron event 'cron_test_1' in 0.01s. + Executed the cron event 'cron_test_2' in 0.006s. + Success: Executed a total of 2 cron events across 3 sites. + ### 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. @@ -35,6 +44,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +57,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cron/event/schedule.md b/commands/cron/event/schedule.md index 40855754..d1ece7a8 100644 --- a/commands/cron/event/schedule.md +++ b/commands/cron/event/schedule.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cron/event/unschedule.md b/commands/cron/event/unschedule.md index 42e6a828..12004bc5 100644 --- a/commands/cron/event/unschedule.md +++ b/commands/cron/event/unschedule.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cron/schedule/list.md b/commands/cron/schedule/list.md index cac1976f..2cf78897 100644 --- a/commands/cron/schedule/list.md +++ b/commands/cron/schedule/list.md @@ -59,6 +59,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -71,3 +72,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/cron/test.md b/commands/cron/test.md index 5dae9e6e..ac575684 100644 --- a/commands/cron/test.md +++ b/commands/cron/test.md @@ -23,6 +23,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -35,3 +36,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/check.md b/commands/db/check.md index 43e77e4b..12229697 100644 --- a/commands/db/check.md +++ b/commands/db/check.md @@ -40,6 +40,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -52,3 +53,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/clean.md b/commands/db/clean.md index a07c039a..baf3cab9 100644 --- a/commands/db/clean.md +++ b/commands/db/clean.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/cli.md b/commands/db/cli.md index a223c6d9..950b2aa0 100644 --- a/commands/db/cli.md +++ b/commands/db/cli.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/columns.md b/commands/db/columns.md index afc47406..fabbaa70 100644 --- a/commands/db/columns.md +++ b/commands/db/columns.md @@ -60,6 +60,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -72,3 +73,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/connect.md b/commands/db/connect.md index 936e8980..b2432470 100644 --- a/commands/db/connect.md +++ b/commands/db/connect.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/create.md b/commands/db/create.md index f6b1ebbf..8b1d9d43 100644 --- a/commands/db/create.md +++ b/commands/db/create.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/drop.md b/commands/db/drop.md index 8341a22f..e9e3ad96 100644 --- a/commands/db/drop.md +++ b/commands/db/drop.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/dump.md b/commands/db/dump.md index d651d4bf..3c022490 100644 --- a/commands/db/dump.md +++ b/commands/db/dump.md @@ -36,16 +36,13 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--porcelain] : Output filename for the exported database. -[\--add-drop-table] -: Include a `DROP TABLE IF EXISTS` statement before each `CREATE TABLE` statement. - [\--defaults] : Loads the environment's MySQL option files. Default behavior is to skip loading them to avoid failures due to misconfiguration. ### EXAMPLES - # Export database with drop query included - $ wp db export --add-drop-table + # Export database with `--skip-opt` and `--add-drop-table` mysqldump flags + $ wp db export --skip-opt --add-drop-table Success: Exported to 'wordpress_dbase-db72bb5.sql'. # Export certain tables @@ -98,6 +95,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -110,3 +108,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/export.md b/commands/db/export.md index 5ab0e4ab..7759f1da 100644 --- a/commands/db/export.md +++ b/commands/db/export.md @@ -36,16 +36,13 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--porcelain] : Output filename for the exported database. -[\--add-drop-table] -: Include a `DROP TABLE IF EXISTS` statement before each `CREATE TABLE` statement. - [\--defaults] : Loads the environment's MySQL option files. Default behavior is to skip loading them to avoid failures due to misconfiguration. ### EXAMPLES - # Export database with drop query included - $ wp db export --add-drop-table + # Export database with `--skip-opt` and `--add-drop-table` mysqldump flags + $ wp db export --skip-opt --add-drop-table Success: Exported to 'wordpress_dbase-db72bb5.sql'. # Export certain tables @@ -98,6 +95,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -110,3 +108,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/import.md b/commands/db/import.md index 498b7d84..89e73f48 100644 --- a/commands/db/import.md +++ b/commands/db/import.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/optimize.md b/commands/db/optimize.md index c754f4be..de7fb637 100644 --- a/commands/db/optimize.md +++ b/commands/db/optimize.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/prefix.md b/commands/db/prefix.md index ebb8ba12..709a53fc 100644 --- a/commands/db/prefix.md +++ b/commands/db/prefix.md @@ -18,6 +18,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -30,3 +31,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/query.md b/commands/db/query.md index aafad7b4..daf6517e 100644 --- a/commands/db/query.md +++ b/commands/db/query.md @@ -94,6 +94,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -106,3 +107,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/repair.md b/commands/db/repair.md index 2feff180..450afa2d 100644 --- a/commands/db/repair.md +++ b/commands/db/repair.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/reset.md b/commands/db/reset.md index f757f450..e1c1e291 100644 --- a/commands/db/reset.md +++ b/commands/db/reset.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/search.md b/commands/db/search.md index 13f21a76..38da8ce9 100644 --- a/commands/db/search.md +++ b/commands/db/search.md @@ -184,6 +184,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -196,3 +197,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/size.md b/commands/db/size.md index 0f59aa0a..3a4cc5c1 100644 --- a/commands/db/size.md +++ b/commands/db/size.md @@ -138,6 +138,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -150,3 +151,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/db/tables.md b/commands/db/tables.md index ff372921..abdd602d 100644 --- a/commands/db/tables.md +++ b/commands/db/tables.md @@ -12,7 +12,22 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : List tables based on wildcard search, e.g. 'wp_*_options' or 'wp_post?'. [\--scope=<scope>] -: Can be all, global, ms_global, blog, or old tables. Defaults to all. +: List tables based on the scope. + +- all: returns 'all' and 'global' tables. No old tables are returned. +- blog: returns the blog-level tables for the queried blog. +- global: returns the global tables for the installation, returning multisite tables only on multisite. +- ms_global: returns the multisite global tables, regardless if current installation is multisite. +- old: returns tables which are deprecated. +\--- +default: all +options: + - all + - blog + - global + - ms_global + - old +\--- [\--network] : List all the tables in a multisite install. @@ -59,6 +74,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -71,3 +87,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/dist-archive.md b/commands/dist-archive.md index 7bad6390..dffa87c5 100644 --- a/commands/dist-archive.md +++ b/commands/dist-archive.md @@ -62,6 +62,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -74,3 +75,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/embed/cache/clear.md b/commands/embed/cache/clear.md index e96f4f05..8b9f58c3 100644 --- a/commands/embed/cache/clear.md +++ b/commands/embed/cache/clear.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/embed/cache/find.md b/commands/embed/cache/find.md index c5617cfe..035489c6 100644 --- a/commands/embed/cache/find.md +++ b/commands/embed/cache/find.md @@ -37,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -49,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/embed/cache/trigger.md b/commands/embed/cache/trigger.md index ac71d846..6b7b1881 100644 --- a/commands/embed/cache/trigger.md +++ b/commands/embed/cache/trigger.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/embed/fetch.md b/commands/embed/fetch.md index 258eecb0..e0c99061 100644 --- a/commands/embed/fetch.md +++ b/commands/embed/fetch.md @@ -67,6 +67,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -79,3 +80,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/embed/handler/list.md b/commands/embed/handler/list.md index abdd7742..b55cff1e 100644 --- a/commands/embed/handler/list.md +++ b/commands/embed/handler/list.md @@ -54,6 +54,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -66,3 +67,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/embed/provider/list.md b/commands/embed/provider/list.md index 079847f0..108cf5cc 100644 --- a/commands/embed/provider/list.md +++ b/commands/embed/provider/list.md @@ -56,6 +56,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -68,3 +69,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/embed/provider/match.md b/commands/embed/provider/match.md index f107637e..c30c0be9 100644 --- a/commands/embed/provider/match.md +++ b/commands/embed/provider/match.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/eval-file.md b/commands/eval-file.md index 19eccfd5..a4acb66e 100644 --- a/commands/eval-file.md +++ b/commands/eval-file.md @@ -22,6 +22,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--use-include] : Process the provided file via include instead of evaluating its contents. +[\--hook=<hook>] +: Execute file after a specific WordPress hook has fired. + ### 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. @@ -31,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/eval.md b/commands/eval.md index 0be525d2..3f4fcd74 100644 --- a/commands/eval.md +++ b/commands/eval.md @@ -16,6 +16,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--skip-wordpress] : Execute code without loading WordPress. +[\--hook=<hook>] +: Execute code after a specific WordPress hook has fired. + ### EXAMPLES # Display WordPress content directory. @@ -26,6 +29,10 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg $ wp eval 'echo rand();' --skip-wordpress 479620423 + # Execute code after WordPress is fully loaded. + $ wp eval 'echo "Current user: " . wp_get_current_user()->user_login;' --hook=wp_loaded + Current user: admin + ### 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. @@ -35,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/export.md b/commands/export.md index 06905a8a..bcefcbe5 100644 --- a/commands/export.md +++ b/commands/export.md @@ -17,6 +17,12 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--skip_comments] : Don't include comments in the WXR export file. +[\--skip_authors] +: Don't include authors in the WXR export file. + +[\--skip_terms] +: Don't include terms (categories, tags, custom taxonomy terms and nav menu terms) in the WXR export file. + [\--max_file_size=<MB>] : A single export file should have this many megabytes. -1 for unlimited. \--- @@ -99,6 +105,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -111,3 +118,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/find.md b/commands/find.md index 8f8152bb..36cd1015 100644 --- a/commands/find.md +++ b/commands/find.md @@ -82,6 +82,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -94,3 +95,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/font.md b/commands/font.md new file mode 100644 index 00000000..0b6a3a0b --- /dev/null +++ b/commands/font.md @@ -0,0 +1,19 @@ +# wp font + +Manages WordPress fonts. + +### EXAMPLES + + # List all font collections + $ wp font collection list + + # Install a font family from a collection + $ wp font family install google-fonts inter + + # List installed font families + $ wp post list --post_type=wp_font_family + + # List installed font faces + $ wp post list --post_type=wp_font_face + + diff --git a/commands/font/collection.md b/commands/font/collection.md new file mode 100644 index 00000000..d89b29e2 --- /dev/null +++ b/commands/font/collection.md @@ -0,0 +1,26 @@ +# wp font collection + +Manages font collections. + +Font collections are predefined sets of fonts that can be used in WordPress. Collections are registered by WordPress core or themes and cannot be created or deleted via the command line. + +### EXAMPLES + + # List all font collections + $ wp font collection list + +------------------+-------------------+---------+ + | slug | name | count | + +------------------+-------------------+---------+ + | google-fonts | Google Fonts | 1500 | + +------------------+-------------------+---------+ + + # Get details about a specific font collection + $ wp font collection get google-fonts + +-------+------------------+ + | Field | Value | + +-------+------------------+ + | slug | google-fonts | + | name | Google Fonts | + +-------+------------------+ + + diff --git a/commands/font/collection/get.md b/commands/font/collection/get.md new file mode 100644 index 00000000..b3b89442 --- /dev/null +++ b/commands/font/collection/get.md @@ -0,0 +1,76 @@ +# wp font collection get + +Gets details about a registered font collection. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<slug> +: Font collection slug. + +[\--field=<field>] +: Instead of returning the whole collection, returns the value of a single field. + +[\--fields=<fields>] +: Limit the output to specific fields. Defaults to all fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for the specified collection: + +* slug +* name +* description +* categories + +### EXAMPLES + + # Get details of a specific collection + $ wp font collection get google-fonts + +-------+------------------+ + | Field | Value | + +-------+------------------+ + | slug | google-fonts | + | name | Google Fonts | + +-------+------------------+ + + # Get the name field only + $ wp font collection get google-fonts --field=name + Google Fonts + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/font/collection/is-registered.md b/commands/font/collection/is-registered.md new file mode 100644 index 00000000..9301ec4a --- /dev/null +++ b/commands/font/collection/is-registered.md @@ -0,0 +1,45 @@ +# wp font collection is-registered + +Checks if a font collection is registered. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<slug> +: Font collection slug. + +### EXAMPLES + + # Bash script for checking if a font collection is registered, with fallback. + + if wp font collection is-registered google-fonts 2>/dev/null; then + # Font collection is registered. Do something. + else + # Fallback if collection is not registered. + 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/font/collection/list-categories.md b/commands/font/collection/list-categories.md new file mode 100644 index 00000000..e4fa01c5 --- /dev/null +++ b/commands/font/collection/list-categories.md @@ -0,0 +1,69 @@ +# wp font collection list-categories + +Lists categories in a collection. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<slug> +: Font collection slug. + +[\--field=<field>] +: Prints the value of a single field for each category. + +[\--fields=<fields>] +: Limit the output to specific category fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - count + - yaml +\--- + +### AVAILABLE FIELDS + +* slug +* name + +### EXAMPLES + + # List all categories in a collection + $ wp font collection list-categories google-fonts + +-------------+--------------+ + | slug | name | + +-------------+--------------+ + | sans-serif | Sans Serif | + | display | Display | + +-------------+--------------+ + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/font/collection/list-families.md b/commands/font/collection/list-families.md new file mode 100644 index 00000000..5099dee5 --- /dev/null +++ b/commands/font/collection/list-families.md @@ -0,0 +1,72 @@ +# wp font collection list-families + +Lists font families in a collection. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<slug> +: Font collection slug. + +[\--category=<slug>] +: Filter by category slug. + +[\--field=<field>] +: Prints the value of a single field for each family. + +[\--fields=<fields>] +: Limit the output to specific family fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - count + - yaml +\--- + +### AVAILABLE FIELDS + +* slug +* name +* fontFamily +* categories +* preview + +### EXAMPLES + + # List all font families in a collection + $ wp font collection list-families google-fonts + + # List font families in a specific category + $ wp font collection list-families google-fonts --category=sans-serif + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/font/collection/list.md b/commands/font/collection/list.md new file mode 100644 index 00000000..6d31d602 --- /dev/null +++ b/commands/font/collection/list.md @@ -0,0 +1,73 @@ +# wp font collection list + +Lists registered font collections. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--field=<field>] +: Prints the value of a single field for each collection. + +[\--fields=<fields>] +: Limit the output to specific collection fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - count + - yaml +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for each collection: + +* slug +* name +* description +* categories + +### EXAMPLES + + # List all font collections + $ wp font collection list + +------------------+-------------------+ + | slug | name | + +------------------+-------------------+ + | google-fonts | Google Fonts | + +------------------+-------------------+ + + # List collections in JSON format + $ wp font collection list --format=json + [{"slug":"google-fonts","name":"Google Fonts"}] + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/font/face.md b/commands/font/face.md new file mode 100644 index 00000000..0adfd8d8 --- /dev/null +++ b/commands/font/face.md @@ -0,0 +1,16 @@ +# wp font face + +Manages font faces. + +To list, get, create, update or delete font faces, use `wp post` with `--post_type=wp_font_face`. + +### EXAMPLES + + # Install a font face for an existing family + $ wp font face install 42 --src="https://example.com/font.woff2" --font-weight=700 + Success: Created font face 43. + + # List installed font faces + $ wp post list --post_type=wp_font_face + + diff --git a/commands/font/face/install.md b/commands/font/face/install.md new file mode 100644 index 00000000..4fec3836 --- /dev/null +++ b/commands/font/face/install.md @@ -0,0 +1,71 @@ +# wp font face install + +Installs a font face. + +Creates a new font face post with the specified settings. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<family-id> +: Font family ID. + +\--src=<src> +: Font face source URL or file path. + +[\--font-family=<family>] +: CSS font-family value. + +[\--font-style=<style>] +: CSS font-style value (e.g., normal, italic). +\--- +default: normal +\--- + +[\--font-weight=<weight>] +: CSS font-weight value (e.g., 400, 700). +\--- +default: 400 +\--- + +[\--font-display=<display>] +: CSS font-display value. + +[\--porcelain] +: Output just the new font face ID. + +### EXAMPLES + + # Install a font face + $ wp font face install 42 --src="https://example.com/font.woff2" --font-weight=700 --font-style=normal + Success: Created font face 43. + + # Install a font face with porcelain output + $ wp font face install 42 --src="font.woff2" --porcelain + 44 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/font/family.md b/commands/font/family.md new file mode 100644 index 00000000..7cd1a6aa --- /dev/null +++ b/commands/font/family.md @@ -0,0 +1,16 @@ +# wp font family + +Manages font families. + +To list, get, create, update or delete font families, use `wp post` with `--post_type=wp_font_family`. + +### EXAMPLES + + # Install a font family from a collection + $ wp font family install google-fonts inter + Success: Installed font family "Inter" (ID: 42) with 9 font faces. + + # List installed font families + $ wp post list --post_type=wp_font_family + + diff --git a/commands/font/family/install.md b/commands/font/family/install.md new file mode 100644 index 00000000..d3d4cd98 --- /dev/null +++ b/commands/font/family/install.md @@ -0,0 +1,53 @@ +# wp font family install + +Installs a font family from a collection. + +Retrieves a font family from a collection and creates the wp_font_family post along with all associated font faces. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<collection> +: Font collection slug. + +<family> +: Font family slug from the collection. + +[\--porcelain] +: Output just the new font family ID. + +### EXAMPLES + + # Install a font family from a collection + $ wp font family install google-fonts inter + Success: Installed font family "Inter" (ID: 42) with 9 font faces. + + # Install and get the family ID + $ wp font family install google-fonts roboto --porcelain + 43 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/help.md b/commands/help.md index 8c621879..5ffa0fd8 100644 --- a/commands/help.md +++ b/commands/help.md @@ -9,6 +9,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [<command>...] : Get help on a specific command. +[\--full] +: Show the full help, including help for all subcommands. + ### EXAMPLES # get help for `core` command @@ -17,6 +20,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg # get help for `core download` subcommand wp help core download + # get full help for `core`, including all subcommands + wp help core --full + ### 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. @@ -26,6 +32,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +45,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/i18n/audit.md b/commands/i18n/audit.md new file mode 100644 index 00000000..dafeaf6b --- /dev/null +++ b/commands/i18n/audit.md @@ -0,0 +1,90 @@ +# wp i18n audit + +Audit strings in a project. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +Scans PHP, Blade-PHP and JavaScript files for translatable strings to find possible mistakes. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<source> +: Directory to scan for string extraction. + +[\--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. + +[\--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. + +[\--exclude=<paths>] +: Comma-separated list of files and paths that should be ignored 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, test, tests. + +[\--skip-js] +: Skips JavaScript string extraction. + +[\--skip-php] +: Skips PHP string extraction. + +[\--skip-blade] +: Skips Blade-PHP string extraction. + +[\--skip-block-json] +: Skips string extraction from block.json files. + +[\--skip-theme-json] +: Skips string extraction from theme.json files. + +[\--format=<format>] +: Output format for the audit results. +\--- +default: plaintext +options: + - plaintext + - json + - github-actions +\--- + +### EXAMPLES + + # Audit a plugin for possible translation issues. + $ wp i18n audit wp-content/plugins/hello-world + + # Audit a plugin and output results as JSON. + $ wp i18n audit wp-content/plugins/hello-world --format=json + + # Audit a plugin with GitHub Actions annotations format. + $ wp i18n audit wp-content/plugins/hello-world --format=github-actions + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/i18n/make-json.md b/commands/i18n/make-json.md index af04b3e4..4ceee2af 100644 --- a/commands/i18n/make-json.md +++ b/commands/i18n/make-json.md @@ -24,12 +24,6 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--extensions=<extensions>] : Additional custom JS extensions, comma separated list. By default searches for .min.js and .js extensions. -[\--purge] -: Whether to purge the strings that were extracted from the original source file. Defaults to true, use `--no-purge` to skip the removal. - -[\--update-mo-files] -: Whether MO files should be updated as well after updating PO files. Only has an effect when used in combination with `--purge`. - [\--pretty-print] : Pretty-print resulting JSON files. @@ -41,8 +35,8 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg # Create JSON files for all PO files in the languages directory $ wp i18n make-json languages - # Create JSON files for my-plugin-de_DE.po and leave the PO file untouched. - $ wp i18n make-json my-plugin-de_DE.po /tmp --no-purge + # Create JSON files for my-plugin-de_DE.po + $ wp i18n make-json my-plugin-de_DE.po /tmp # Create JSON files with mapping $ wp i18n make-json languages --use-map=build/map.json @@ -62,6 +56,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -74,3 +69,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/i18n/make-mo.md b/commands/i18n/make-mo.md index 99fa4049..77edee40 100644 --- a/commands/i18n/make-mo.md +++ b/commands/i18n/make-mo.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/i18n/make-php.md b/commands/i18n/make-php.md index 4f091373..876d807f 100644 --- a/commands/i18n/make-php.md +++ b/commands/i18n/make-php.md @@ -14,6 +14,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [<destination>] : Path to the destination directory for the resulting PHP files. Defaults to the source directory. +[\--pretty-print] +: Pretty-print resulting PHP files. + ### EXAMPLES # Create PHP files for all PO files in the current directory. @@ -24,6 +27,10 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg $ wp i18n make-php example-plugin-de_DE.po languages Success: Created 1 file. + # Create a pretty-printed PHP file. + $ wp i18n make-php example-plugin-de_DE.po languages --pretty-print + Success: Created 1 file. + ### 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. @@ -33,6 +40,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +53,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/i18n/make-pot.md b/commands/i18n/make-pot.md index 1444023c..9f7dbd66 100644 --- a/commands/i18n/make-pot.md +++ b/commands/i18n/make-pot.md @@ -35,10 +35,10 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : Whether source code references and comments from the generated POT file should be instead added to the POT file used for subtraction. Warning: this modifies the files passed to `--subtract`! [\--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`. +: 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. +: 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. @@ -103,6 +103,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -115,3 +116,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/i18n/update-po.md b/commands/i18n/update-po.md index 479a319a..152f4b2f 100644 --- a/commands/i18n/update-po.md +++ b/commands/i18n/update-po.md @@ -17,6 +17,11 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : PO file to update or a directory containing multiple PO files. Defaults to all PO files in the source directory. +[\--purge] +: Remove obsolete strings and replace translator comments. Defaults to true. + By default, strings not found in the POT file are removed, and translator comments are replaced with those from the POT file. + Use `--no-purge` to preserve obsolete translations (marked with #~) and existing translator comments like copyright notices. + ### EXAMPLES # Update all PO files from a POT file in the current directory. @@ -31,6 +36,14 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg $ wp i18n update-po example-plugin.pot languages Success: Updated 2 files. + # Update PO files while keeping obsolete strings and translator comments. + $ wp i18n update-po example-plugin.pot --no-purge + Success: Updated 3 files. + + # Shows message when some files don't need updating. + $ wp i18n update-po example-plugin.pot languages + Success: Updated 2 files. 1 file unchanged. + ### 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. @@ -40,6 +53,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -52,3 +66,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/import.md b/commands/import.md index 93b5c4a6..120bdb22 100644 --- a/commands/import.md +++ b/commands/import.md @@ -11,7 +11,7 @@ Use `define( 'IMPORT_DEBUG', true );` for more verbosity during importing. See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. <file>... -: Path to one or more valid WXR files for importing. Directories are also accepted. +: Path to one or more valid WXR files for importing. Directories are also accepted. A URL to a WXR file is also accepted. Use '-' to import from STDIN. \--authors=<authors> : How the author mapping should be handled. Options are 'create', 'mapping.csv', or 'skip'. The first will create any non-existent users from the WXR file. The second will read author mapping associations from a CSV, or create a CSV for editing if the file path doesn't exist. The CSV requires two columns, and a header row like "old_user_login,new_user_login". The last option will skip any author mapping. @@ -22,6 +22,12 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--rewrite_urls] : Change all imported URLs that currently link to the previous site so that they now link to this site Requires WordPress Importer version 0.9.1 or newer. +[\--importer=<importer>] +: Use a custom importer class instead of the default WP_Import. The class must exist and be a subclass of WP_Import. + +[\--source-dir=<dir>] +: A local directory to search for attachment files before downloading them from their original URLs. When specified, the importer matches attachment filenames (by basename only) against files in this directory, and uses any local match instead of fetching the file over the network. Useful when attachment files are already available locally, e.g. from a previous site's uploads directory. + ### EXAMPLES # Import content from a WXR file @@ -33,6 +39,23 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg -- Imported post as post_id #1 Success: Finished importing from 'example.wordpress.2016-06-21.xml' file. + # Import content from a WXR file via HTTP + $ wp import https://raw.githubusercontent.com/WordPress/theme-test-data/refs/heads/master/theme-preview.xml --authors=skip + Starting the import process... + Downloading 'https://raw.githubusercontent.com/WordPress/theme-test-data/refs/heads/master/theme-preview.xml'... + Success: Finished importing from 'https://raw.githubusercontent.com/WordPress/theme-test-data/refs/heads/master/theme-preview.xml' file. + + # Import content from STDIN + $ wp export --stdout | wp import - --authors=skip + Starting the import process... + Success: Finished importing from 'STDIN' file. + + # Import using locally available attachment files to avoid re-downloading + $ wp import export.xml --authors=skip --source-dir=/path/to/uploads + Starting the import process... + -- Using local file for 'https://example.com/wp-content/uploads/2024/01/image.jpg'. + Success: Finished importing from 'export.xml' file. + ### 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. @@ -42,6 +65,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +78,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/core/activate.md b/commands/language/core/activate.md index 6975cd3f..4d57debd 100644 --- a/commands/language/core/activate.md +++ b/commands/language/core/activate.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/core/install.md b/commands/language/core/install.md index 8e5e72bf..12a0a173 100644 --- a/commands/language/core/install.md +++ b/commands/language/core/install.md @@ -14,6 +14,16 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--activate] : If set, the language will be activated immediately after install. +[\--format=<format>] +: Render output in a particular format (for one or more languages). +\--- +options: + - table + - csv + - json + - summary +\--- + ### EXAMPLES # Install the Brazilian Portuguese language. @@ -35,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/core/is-installed.md b/commands/language/core/is-installed.md index d522e928..e60d76bf 100644 --- a/commands/language/core/is-installed.md +++ b/commands/language/core/is-installed.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/core/list.md b/commands/language/core/list.md index f4041d5f..2a25ff47 100644 --- a/commands/language/core/list.md +++ b/commands/language/core/list.md @@ -57,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -69,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/core/uninstall.md b/commands/language/core/uninstall.md index 80dfbc41..c69e596d 100644 --- a/commands/language/core/uninstall.md +++ b/commands/language/core/uninstall.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/core/update.md b/commands/language/core/update.md index 355e7026..9f56b9d7 100644 --- a/commands/language/core/update.md +++ b/commands/language/core/update.md @@ -9,6 +9,18 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--dry-run] : Preview which translations would be updated. +[\--format=<format>] +: Render output in a particular format. When not specified, updates show + progress messages and success/warning/error messages. When specified, + the output format changes based on the selected format. +\--- +options: + - table + - csv + - json + - summary +\--- + ### EXAMPLES # Update installed core languages packs. @@ -27,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/plugin/install.md b/commands/language/plugin/install.md index e342b3db..a2584676 100644 --- a/commands/language/plugin/install.md +++ b/commands/language/plugin/install.md @@ -49,6 +49,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -61,3 +62,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/plugin/is-installed.md b/commands/language/plugin/is-installed.md index 3ed1820e..38da65d9 100644 --- a/commands/language/plugin/is-installed.md +++ b/commands/language/plugin/is-installed.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/plugin/list.md b/commands/language/plugin/list.md index db0ff83b..ba0dc09b 100644 --- a/commands/language/plugin/list.md +++ b/commands/language/plugin/list.md @@ -64,6 +64,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -76,3 +77,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/plugin/uninstall.md b/commands/language/plugin/uninstall.md index 2f5ac944..1be39cc7 100644 --- a/commands/language/plugin/uninstall.md +++ b/commands/language/plugin/uninstall.md @@ -47,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -59,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/plugin/update.md b/commands/language/plugin/update.md index d1fbed18..41f37219 100644 --- a/commands/language/plugin/update.md +++ b/commands/language/plugin/update.md @@ -15,6 +15,18 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--dry-run] : Preview which translations would be updated. +[\--format=<format>] +: Render output in a particular format. When not specified, updates show + progress messages and success/warning/error messages. When specified, + the output format changes based on the selected format. +\--- +options: + - table + - csv + - json + - summary +\--- + ### EXAMPLES # Update all installed language packs for all plugins. @@ -33,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/theme/install.md b/commands/language/theme/install.md index 8272dcf6..00dff0d0 100644 --- a/commands/language/theme/install.md +++ b/commands/language/theme/install.md @@ -48,6 +48,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -60,3 +61,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/theme/is-installed.md b/commands/language/theme/is-installed.md index 55b117e2..045bbf66 100644 --- a/commands/language/theme/is-installed.md +++ b/commands/language/theme/is-installed.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/theme/list.md b/commands/language/theme/list.md index a8e78831..6021372f 100644 --- a/commands/language/theme/list.md +++ b/commands/language/theme/list.md @@ -64,6 +64,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -76,3 +77,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/theme/uninstall.md b/commands/language/theme/uninstall.md index a472cdc9..bb020dde 100644 --- a/commands/language/theme/uninstall.md +++ b/commands/language/theme/uninstall.md @@ -47,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -59,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/language/theme/update.md b/commands/language/theme/update.md index 8a69bf80..dbc411b4 100644 --- a/commands/language/theme/update.md +++ b/commands/language/theme/update.md @@ -15,6 +15,18 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--dry-run] : Preview which translations would be updated. +[\--format=<format>] +: Render output in a particular format. When not specified, updates show + progress messages and success/warning/error messages. When specified, + the output format changes based on the selected format. +\--- +options: + - table + - csv + - json + - summary +\--- + ### EXAMPLES # Update all installed language packs for all themes. @@ -33,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/maintenance-mode/activate.md b/commands/maintenance-mode/activate.md index d8dedf1e..78270aba 100644 --- a/commands/maintenance-mode/activate.md +++ b/commands/maintenance-mode/activate.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/maintenance-mode/deactivate.md b/commands/maintenance-mode/deactivate.md index 88123eb9..2ebcd12b 100644 --- a/commands/maintenance-mode/deactivate.md +++ b/commands/maintenance-mode/deactivate.md @@ -17,6 +17,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -29,3 +30,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/maintenance-mode/is-active.md b/commands/maintenance-mode/is-active.md index 7b64a3e0..2531d709 100644 --- a/commands/maintenance-mode/is-active.md +++ b/commands/maintenance-mode/is-active.md @@ -17,6 +17,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -29,3 +30,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/maintenance-mode/status.md b/commands/maintenance-mode/status.md index 7bc160be..3c442c4f 100644 --- a/commands/maintenance-mode/status.md +++ b/commands/maintenance-mode/status.md @@ -16,6 +16,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -28,3 +29,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/media.md b/commands/media.md index 89166d92..2276d716 100644 --- a/commands/media.md +++ b/commands/media.md @@ -1,6 +1,6 @@ # wp media -Imports files as attachments, regenerates thumbnails, or lists registered image sizes. +Imports files as attachments, regenerates thumbnails, replaces existing attachment files, or lists registered image sizes. ### EXAMPLES @@ -17,6 +17,11 @@ Imports files as attachments, regenerates thumbnails, or lists registered image Imported file '/home/person/Downloads/image.png' as attachment ID 1753 and attached to post 123 as featured image. Success: Imported 1 of 1 images. + # Import an image from STDIN. + $ curl http://example.com/image.jpg | wp media import - + Imported file 'STDIN' as attachment ID 1754. + Success: Imported 1 of 1 items. + # List all registered image sizes $ wp media image-size +---------------------------+-------+--------+-------+ @@ -35,4 +40,12 @@ Imports files as attachments, regenerates thumbnails, or lists registered image 1/1 Fixing orientation for "Portrait_6" (ID 63). Success: Fixed 1 of 1 images. + # Remove all generated thumbnails, without confirmation. + $ wp media prune --yes + Found 3 images to prune. + 1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760). + 2/3 Pruned thumbnails for "Boardwalk" (ID 757). + 3/3 Pruned thumbnails for "Sunburst Over River" (ID 756). + Success: Pruned 3 of 3 images. + diff --git a/commands/media/fix-orientation.md b/commands/media/fix-orientation.md index f9c6e44c..1eab672d 100644 --- a/commands/media/fix-orientation.md +++ b/commands/media/fix-orientation.md @@ -40,6 +40,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -52,3 +53,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/media/image-size.md b/commands/media/image-size.md index b83f6ead..4716b70b 100644 --- a/commands/media/image-size.md +++ b/commands/media/image-size.md @@ -54,6 +54,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -66,3 +67,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/media/import.md b/commands/media/import.md index 0da24bad..252fda60 100644 --- a/commands/media/import.md +++ b/commands/media/import.md @@ -10,6 +10,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : Path to file or files to be imported. Supports the glob(3) capabilities of the current shell. If file is recognized as a URL (for example, with a scheme of http or ftp), the file will be downloaded to a temp file before being sideloaded. + Use '-' to read file data from STDIN. [\--post_id=<post_id>] : ID of the post to attach the imported files to. @@ -33,7 +34,10 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : "Description" field (post content) of attachment post. [\--skip-copy] -: If set, media files (local only) are imported to the library but not moved on disk. File names will not be run through wp_unique_filename() with this set. +: If set, media files (local only) are imported to the library but not moved on disk. File names will not be run through wp_unique_filename() with this set. When used, files will remain at their current location and will not be copied into any destination directory. + +[\--destination-dir=<destination-dir>] +: Path to the destination directory for uploaded imported files. Can be absolute or relative to ABSPATH. Ignored when used together with --skip-copy, as files are not moved on disk in that case. [\--preserve-filetime] : Use the file modified time as the post published & modified dates. Remote files will always use the current time. @@ -41,6 +45,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--featured_image] : If set, set the imported image as the Featured Image of the post it is attached to. +[\--skip-duplicates] +: If set, media files that have already been imported will be skipped. + [\--porcelain[=<field>]] : Output a single field for each imported image. Defaults to attachment ID when used as flag. \--- @@ -78,6 +85,11 @@ options: $ 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/ + # Import an image from STDIN. + $ curl http://example.com/image.jpg | wp media import - --title="From STDIN" + Imported file 'STDIN' as attachment ID 1756. + Success: Imported 1 of 1 items. + ### 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. @@ -87,6 +99,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -99,3 +112,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/media/prune.md b/commands/media/prune.md new file mode 100644 index 00000000..37d9ae5d --- /dev/null +++ b/commands/media/prune.md @@ -0,0 +1,73 @@ +# wp media prune + +Removes all generated image files for one or more attachments. + +Generated image files for registered sizes can be recreated with `wp media regenerate`. Thumbnails for image sizes that are no longer registered are kept by default because they cannot be regenerated; use `--remove-abandoned` to remove them as well. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[<attachment-id>...] +: One or more IDs of the attachments to prune. + +[\--image_size=<image_size>...] +: Name of the image size to remove. Repeat the flag to specify multiple. Only thumbnails of specified image size(s) will be removed, thumbnails of other image sizes will not. + +[\--remove-abandoned] +: Also remove thumbnails for image sizes that are no longer registered. + +[\--yes] +: Answer yes to the confirmation message. Confirmation only shows when no IDs passed as arguments. + +### EXAMPLES + + # Remove all generated thumbnails for all images, without confirmation. + $ wp media prune --yes + Found 3 images to prune. + 1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760). + 2/3 Pruned thumbnails for "Boardwalk" (ID 757). + 3/3 Pruned thumbnails for "Sunburst Over River" (ID 756). + Success: Pruned 3 of 3 images. + + # Remove only the "large" thumbnails for all images. + $ wp media prune --image_size=large + Do you really want to prune the "large" image size for all images? [y/n] y + Found 3 images to prune. + 1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760). + 2/3 Pruned thumbnails for "Boardwalk" (ID 757). + 3/3 Pruned thumbnails for "Sunburst Over River" (ID 756). + Success: Pruned 3 of 3 images. + + # Remove all thumbnails including those for unregistered sizes. + $ wp media prune --remove-abandoned --yes + Found 3 images to prune. + 1/3 Pruned thumbnails for "Sydney Harbor Bridge" (ID 760). + 2/3 Pruned thumbnails for "Boardwalk" (ID 757). + 3/3 Pruned thumbnails for "Sunburst Over River" (ID 756). + Success: Pruned 3 of 3 images. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/media/regenerate.md b/commands/media/regenerate.md index ecafbfbc..88b17921 100644 --- a/commands/media/regenerate.md +++ b/commands/media/regenerate.md @@ -9,8 +9,8 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [<attachment-id>...] : One or more IDs of the attachments to regenerate. -[\--image_size=<image_size>] -: Name of the image size to regenerate. Only thumbnails of this image size will be regenerated, thumbnails of other image sizes will not. +[\--image_size=<image_size>...] +: Name of the image size to regenerate. Repeat the flag to specify multiple. Only thumbnails of specified image size(s) will be regenerated, thumbnails of other image sizes will not. [\--skip-delete] : Skip deletion of the original thumbnails. If your thumbnails are linked from sources outside your control, it's likely best to leave them around. Defaults to false. @@ -21,6 +21,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--delete-unknown] : Only delete thumbnails for old unregistered image sizes. +[\--update-attachment-refs] +: Update references to regenerated thumbnails in post content. + [\--yes] : Answer yes to the confirmation message. Confirmation only shows when no IDs passed as arguments. @@ -60,6 +63,15 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg 3/3 Regenerated "large" thumbnail for "Sunburst Over River" (ID 756). Success: Regenerated 3 of 3 images. + # Re-generate only the thumbnails of "large" and "medium" image sizes for all images. + $ wp media regenerate --image_size=large --image_size=medium + Do you really want to regenerate the "large", "medium" image sizes for all images? [y/n] y + Found 3 images to regenerate. + 1/3 Regenerated "large", "medium" thumbnails for "Sydney Harbor Bridge" (ID 760). + 2/3 No "large", "medium" thumbnail regeneration needed for "Boardwalk" (ID 757). + 3/3 Regenerated "large", "medium" thumbnails for "Sunburst Over River" (ID 756). + Success: Regenerated 3 of 3 images. + ### 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. @@ -69,6 +81,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -81,3 +94,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/media/replace.md b/commands/media/replace.md new file mode 100644 index 00000000..ee9af2bf --- /dev/null +++ b/commands/media/replace.md @@ -0,0 +1,60 @@ +# wp media replace + +Replaces the file for an existing attachment while preserving its identity. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<attachment-id> +: ID of the attachment whose file is to be replaced. + +<file> +: Path to the replacement file. Supports local paths and URLs. + +[\--skip-delete] +: Skip deletion of old thumbnail files after replacement. + +[\--porcelain] +: Output just the attachment ID after replacement. + +### EXAMPLES + + # Replace an attachment file with a local file. + $ wp media replace 123 ~/new-image.jpg + Replaced file for attachment ID 123 with '/home/user/new-image.jpg'. + Success: Replaced 1 of 1 images. + + # Replace an attachment file with a file from a URL. + $ wp media replace 123 'http://example.com/image.jpg' + Replaced file for attachment ID 123 with 'http://example.com/image.jpg'. + Success: Replaced 1 of 1 images. + + # Replace and output just the attachment ID. + $ wp media replace 123 ~/new-image.jpg --porcelain + 123 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/create.md b/commands/menu/create.md index e39ff726..c6dd2a8b 100644 --- a/commands/menu/create.md +++ b/commands/menu/create.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/delete.md b/commands/menu/delete.md index 0be79dc6..6b7b06a9 100644 --- a/commands/menu/delete.md +++ b/commands/menu/delete.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/add-custom.md b/commands/menu/item/add-custom.md index 95001b7b..51a1b365 100644 --- a/commands/menu/item/add-custom.md +++ b/commands/menu/item/add-custom.md @@ -50,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/add-post-type-archive.md b/commands/menu/item/add-post-type-archive.md new file mode 100644 index 00000000..e8eedff3 --- /dev/null +++ b/commands/menu/item/add-post-type-archive.md @@ -0,0 +1,70 @@ +# wp menu item add-post-type-archive + +Adds a post type archive as a menu item. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<menu> +: The name, slug, or term ID for the menu. + +<post-type> +: Post type slug. + +[\--title=<title>] +: Set a custom title for the menu item. + +[\--link=<link>] +: Set a custom url for the menu item. + +[\--description=<description>] +: Set a custom description for the menu item. + +[\--attr-title=<attr-title>] +: Set a custom title attribute for the menu item. + +[\--target=<target>] +: Set a custom link target for the menu item. + +[\--classes=<classes>] +: Set a custom link classes for the menu item. + +[\--position=<position>] +: Specify the position of this menu item. + +[\--parent-id=<parent-id>] +: Make this menu item a child of another menu item. + +[\--porcelain] +: Output just the new menu item id. + +### EXAMPLES + + $ wp menu item add-post-type-archive sidebar-menu post + Success: Menu item added. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/add-post.md b/commands/menu/item/add-post.md index df2bda48..99aa4b23 100644 --- a/commands/menu/item/add-post.md +++ b/commands/menu/item/add-post.md @@ -53,6 +53,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -65,3 +66,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/add-term.md b/commands/menu/item/add-term.md index bbe7369b..690c6bee 100644 --- a/commands/menu/item/add-term.md +++ b/commands/menu/item/add-term.md @@ -56,6 +56,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -68,3 +69,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/delete.md b/commands/menu/item/delete.md index 8b4ba70a..4e59b548 100644 --- a/commands/menu/item/delete.md +++ b/commands/menu/item/delete.md @@ -23,6 +23,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -35,3 +36,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/get.md b/commands/menu/item/get.md new file mode 100644 index 00000000..5e3d4bab --- /dev/null +++ b/commands/menu/item/get.md @@ -0,0 +1,93 @@ +# wp menu item get + +Gets details about a menu item. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<db-id> +: Database ID for the menu item. + +[\--field=<field>] +: Instead of returning the whole menu item, returns the value of a single field. + +[\--fields=<fields>] +: Limit the output to specific fields. Defaults to db_id, type, title, link, position. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### AVAILABLE FIELDS + +These fields are available: + +* db_id +* type +* title +* link +* position +* menu_item_parent +* object_id +* object +* type_label +* target +* attr_title +* description +* classes +* xfn + +### EXAMPLES + + # Get details about a menu item with ID 45 + $ wp menu item get 45 + +-------------+----------------------------------+ + | Field | Value | + +-------------+----------------------------------+ + | db_id | 45 | + | type | custom | + | title | WordPress | + | link | https://wordpress.org | + | position | 1 | + +-------------+----------------------------------+ + + # Get a specific field from a menu item + $ wp menu item get 45 --field=title + WordPress + + # Get menu item data in JSON format + $ wp menu item get 45 --format=json + {"db_id":45,"type":"custom","title":"WordPress","link":"https://wordpress.org","position":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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/list.md b/commands/menu/item/list.md index 84dc4688..054e22ed 100644 --- a/commands/menu/item/list.md +++ b/commands/menu/item/list.md @@ -67,6 +67,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -79,3 +80,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/item/update.md b/commands/menu/item/update.md index d01cf5be..6495f088 100644 --- a/commands/menu/item/update.md +++ b/commands/menu/item/update.md @@ -47,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -59,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/list.md b/commands/menu/list.md index f9e71af5..67b816d9 100644 --- a/commands/menu/list.md +++ b/commands/menu/list.md @@ -59,6 +59,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -71,3 +72,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/location/assign.md b/commands/menu/location/assign.md index 68ae19f6..20b904c1 100644 --- a/commands/menu/location/assign.md +++ b/commands/menu/location/assign.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/location/list.md b/commands/menu/location/list.md index 6bbe6f57..1adcf94d 100644 --- a/commands/menu/location/list.md +++ b/commands/menu/location/list.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/menu/location/remove.md b/commands/menu/location/remove.md index 2981a602..41d83e73 100644 --- a/commands/menu/location/remove.md +++ b/commands/menu/location/remove.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/add.md b/commands/network/meta/add.md index 7ab1cb23..13369ac3 100644 --- a/commands/network/meta/add.md +++ b/commands/network/meta/add.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/delete.md b/commands/network/meta/delete.md index a70c734b..22cbfc71 100644 --- a/commands/network/meta/delete.md +++ b/commands/network/meta/delete.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/get.md b/commands/network/meta/get.md index f525ce97..05a12de8 100644 --- a/commands/network/meta/get.md +++ b/commands/network/meta/get.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/list.md b/commands/network/meta/list.md index 462820b8..02ff828c 100644 --- a/commands/network/meta/list.md +++ b/commands/network/meta/list.md @@ -58,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -70,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/patch.md b/commands/network/meta/patch.md index 09fd3ca7..2e139627 100644 --- a/commands/network/meta/patch.md +++ b/commands/network/meta/patch.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/pluck.md b/commands/network/meta/pluck.md index f4ca1df0..b47d0512 100644 --- a/commands/network/meta/pluck.md +++ b/commands/network/meta/pluck.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/set.md b/commands/network/meta/set.md index 71d4fe0f..a2c7d43f 100644 --- a/commands/network/meta/set.md +++ b/commands/network/meta/set.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/network/meta/update.md b/commands/network/meta/update.md index 8a0c93c7..f5d4f24e 100644 --- a/commands/network/meta/update.md +++ b/commands/network/meta/update.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option.md b/commands/option.md index 2eaa11ad..b77e6319 100644 --- a/commands/option.md +++ b/commands/option.md @@ -4,6 +4,21 @@ Retrieves and sets site options, including plugin and WordPress settings. See the [Plugin Settings API](https://developer.wordpress.org/plugins/settings/settings-api/) and the [Theme Options](https://developer.wordpress.org/themes/customize-api/) for more information on adding customized options. +### COMMON OPTIONS + +These are some of the most commonly used WordPress options: + +* `siteurl` - Site URL, e.g. http://example.com +* `blogname` - Site title +* `blogdescription` - Site tagline +* `admin_email` - Administration email address +* `default_role` - Default role for new users +* `timezone_string` - Local timezone, e.g. "America/New_York" +* `home` - Home URL, e.g. http://example.com +* `blog_public` - Discourage search engines when set to 0 + +For the full list of available options, see the [Option Reference](https://developer.wordpress.org/apis/options/). + ### EXAMPLES # Get site URL. diff --git a/commands/option/add.md b/commands/option/add.md index 7b0f8b5b..ee5ff302 100644 --- a/commands/option/add.md +++ b/commands/option/add.md @@ -48,6 +48,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -60,3 +61,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/delete.md b/commands/option/delete.md index a3e32c88..f413403f 100644 --- a/commands/option/delete.md +++ b/commands/option/delete.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/get-autoload.md b/commands/option/get-autoload.md index 1adf69ac..417935b1 100644 --- a/commands/option/get-autoload.md +++ b/commands/option/get-autoload.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/get.md b/commands/option/get.md index 25ff7764..fb72f5f7 100644 --- a/commands/option/get.md +++ b/commands/option/get.md @@ -50,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/list.md b/commands/option/list.md index 6609d6ee..1d7ba15a 100644 --- a/commands/option/list.md +++ b/commands/option/list.md @@ -109,6 +109,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -121,3 +122,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/patch.md b/commands/option/patch.md index 77aed496..bf0678ab 100644 --- a/commands/option/patch.md +++ b/commands/option/patch.md @@ -68,6 +68,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -80,3 +81,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/pluck.md b/commands/option/pluck.md index 2523e729..e0568a90 100644 --- a/commands/option/pluck.md +++ b/commands/option/pluck.md @@ -31,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/set-autoload.md b/commands/option/set-autoload.md index 6acd1632..ea746c3b 100644 --- a/commands/option/set-autoload.md +++ b/commands/option/set-autoload.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/set.md b/commands/option/set.md index 6e19bd99..507599f2 100644 --- a/commands/option/set.md +++ b/commands/option/set.md @@ -73,6 +73,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -85,3 +86,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/option/update.md b/commands/option/update.md index 63e5382e..5139381b 100644 --- a/commands/option/update.md +++ b/commands/option/update.md @@ -73,6 +73,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -85,3 +86,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package.md b/commands/package.md index 45bd52f5..4949a874 100644 --- a/commands/package.md +++ b/commands/package.md @@ -19,9 +19,9 @@ Learn how to create your own command from the | wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev | +-----------------------+------------------+----------+-----------+----------------+ - # Install the latest development version of the package. + # Install the latest stable version of the package. $ wp package install wp-cli/server-command - Installing package wp-cli/server-command (dev-main) + Installing package wp-cli/server-command (^2.0) Updating /home/person/.wp-cli/packages/composer.json to require the package... Using Composer to install the package... --- diff --git a/commands/package/browse.md b/commands/package/browse.md index b3fb1bdf..8dd58c94 100644 --- a/commands/package/browse.md +++ b/commands/package/browse.md @@ -65,6 +65,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -77,3 +78,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package/get.md b/commands/package/get.md new file mode 100644 index 00000000..7b7e81be --- /dev/null +++ b/commands/package/get.md @@ -0,0 +1,86 @@ +# wp package get + +Gets information about an installed WP-CLI package. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<name> +: Name of the package to get information for. + +[\--fields=<fields>] +: Limit the output to specific fields. Defaults to all fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +[\--skip-update-check] +: Skip checking for updates. This is faster and avoids authentication issues with GitHub or Composer repositories. + +### AVAILABLE FIELDS + +These fields will be displayed by default for each package: + +* name +* authors +* version +* update +* update_version + +These fields are optionally available: + +* description + +### EXAMPLES + + # Get information about an installed package. + $ wp package get wp-cli/scaffold-package-command + +----------------+---------------------------------+ + | Field | Value | + +----------------+---------------------------------+ + | name | wp-cli/scaffold-package-command | + | authors | Daniel Bachhuber | + | version | dev-main | + | update | available | + | update_version | 2.x-dev | + +----------------+---------------------------------+ + + # Get the version of a package. + $ wp package get wp-cli/server-command --fields=version --format=json + {"version":"dev-main"} + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package/install.md b/commands/package/install.md index 19cade35..b111d2ec 100644 --- a/commands/package/install.md +++ b/commands/package/install.md @@ -30,14 +30,29 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--interaction] +: Control interactive mode. Use `--no-interaction` to disable prompts (interactive by default). Useful for scripting. + ### EXAMPLES - # Install a package hosted at a git URL. + # Install the latest stable version of a package. $ wp package install runcommand/hook - # Install the latest stable version. + # Install a specific version. + $ wp package install wp-cli/server-command:2.0.0 + + # Install with caret operator (allows non-breaking updates). + $ wp package install wp-cli/server-command:^1.0 + + # Install with tilde operator (allows patch-level updates). + $ wp package install wp-cli/server-command:~1.2 + + # Install the latest stable version (explicitly specified). $ wp package install wp-cli/server-command:@stable + # Install from a development branch. + $ wp package install wp-cli/server-command:dev-main + # Install a package hosted at a GitLab.com URL. $ wp package install https://gitlab.com/foo/wp-cli-bar-command.git @@ -53,6 +68,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -65,3 +81,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package/is-installed.md b/commands/package/is-installed.md new file mode 100644 index 00000000..f65b1cb4 --- /dev/null +++ b/commands/package/is-installed.md @@ -0,0 +1,46 @@ +# wp package is-installed + +Checks if a given package is installed. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +Returns exit code 0 when installed, 1 when uninstalled. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<name> +: The package to check. + +### EXAMPLES + + # Check whether "foo/bar" is installed; exit status 0 if installed, otherwise 1 + $ wp package is-installed foo/bar + $ 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package/list.md b/commands/package/list.md index 57f30c79..7d1af080 100644 --- a/commands/package/list.md +++ b/commands/package/list.md @@ -23,6 +23,9 @@ options: - yaml \--- +[\--skip-update-check] +: Skip checking for updates. This is faster and avoids authentication issues with GitHub or Composer repositories. + ### AVAILABLE FIELDS These fields will be displayed by default for each package: @@ -47,6 +50,14 @@ These fields are optionally available: | wp-cli/server-command | Daniel Bachhuber | dev-main | available | 2.x-dev | +-----------------------+------------------+----------+-----------+----------------+ + # List installed packages without checking for updates. + $ wp package list --skip-update-check + +-----------------------+------------------+----------+--------+----------------+ + | name | authors | version | update | update_version | + +-----------------------+------------------+----------+--------+----------------+ + | wp-cli/server-command | Daniel Bachhuber | dev-main | none | | + +-----------------------+------------------+----------+--------+----------------+ + ### 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. @@ -56,6 +67,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -68,3 +80,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package/path.md b/commands/package/path.md index 5ae9c114..994877f6 100644 --- a/commands/package/path.md +++ b/commands/package/path.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package/uninstall.md b/commands/package/uninstall.md index e90f6127..f4e07b9c 100644 --- a/commands/package/uninstall.md +++ b/commands/package/uninstall.md @@ -14,6 +14,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--interaction] +: Control interactive prompts. Use `--no-interaction` to disable interactive questions (useful for scripting). + ### EXAMPLES # Uninstall package. @@ -32,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -44,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/package/update.md b/commands/package/update.md index f649e270..71b7a75f 100644 --- a/commands/package/update.md +++ b/commands/package/update.md @@ -1,11 +1,18 @@ # wp package update -Updates all installed WP-CLI packages to their latest version. +Updates installed WP-CLI packages to their latest version. This command runs on the `before_wp_load` hook, just before the WP load process begins. +[<package-name>...] +: One or more package names to update. If not specified, all packages will be updated. + +[\--interaction] +: Control interactive mode. Use `--no-interaction` to disable prompts (interactive by default). Useful for scripting. + ### EXAMPLES + # Update all packages. $ wp package update Using Composer to update packages... --- @@ -20,6 +27,17 @@ This command runs on the `before_wp_load` hook, just before the WP load process --- Success: Packages updated. + # Update a specific package. + $ wp package update wp-cli/server-command + Using Composer to update packages... + --- + Loading composer repositories with package information + Updating dependencies + Writing lock file + Generating autoload files + --- + Success: Package updated successfully. + ### 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. @@ -29,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/activate.md b/commands/plugin/activate.md index f6d76cf8..4ab7055a 100644 --- a/commands/plugin/activate.md +++ b/commands/plugin/activate.md @@ -18,6 +18,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--network] : If set, the plugin will be activated for the entire multisite network. +[\--force] +: If set, deactivates and reactivates the plugin to re-run activation hooks, even if already active. + ### EXAMPLES # Activate plugin @@ -42,6 +45,11 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg Plugin 'buddypress' network activated. Success: Activated 2 of 2 plugins. + # Force re-running activation hooks for an already active plugin. + $ wp plugin activate hello --force + Plugin 'hello' activated. + Success: Activated 1 of 1 plugins. + ### 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. @@ -51,6 +59,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -63,3 +72,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/auto-updates/disable.md b/commands/plugin/auto-updates/disable.md index 69cb85f5..3ac58e98 100644 --- a/commands/plugin/auto-updates/disable.md +++ b/commands/plugin/auto-updates/disable.md @@ -31,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/auto-updates/enable.md b/commands/plugin/auto-updates/enable.md index 841c670f..915bb94b 100644 --- a/commands/plugin/auto-updates/enable.md +++ b/commands/plugin/auto-updates/enable.md @@ -31,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/auto-updates/status.md b/commands/plugin/auto-updates/status.md index e377b461..a734c151 100644 --- a/commands/plugin/auto-updates/status.md +++ b/commands/plugin/auto-updates/status.md @@ -57,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -69,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/check-update.md b/commands/plugin/check-update.md new file mode 100644 index 00000000..c7d9de72 --- /dev/null +++ b/commands/plugin/check-update.md @@ -0,0 +1,71 @@ +# wp plugin check-update + +Checks for plugin updates without performing them. + +Lists the available plugin updates. Similar to `wp core check-update`. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[<plugin>...] +: One or more plugins to check for updates. + +[\--all] +: If set, all plugins will be checked for updates. + +[\--field=<field>] +: Prints the value of a single field for each update. + +[\--fields=<fields>] +: Limit the output to specific object fields. Defaults to name,status,version,update_version. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + # Check for plugin updates + $ wp plugin check-update + +-----------+--------+---------+----------------+ + | name | status | version | update_version | + +-----------+--------+---------+----------------+ + | akismet | active | 4.1.0 | 4.1.1 | + +-----------+--------+---------+----------------+ + + # List plugins with available updates in JSON format + $ wp plugin check-update --format=json + [{"name":"akismet","status":"active","version":"4.1.0","update_version":"4.1.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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/deactivate.md b/commands/plugin/deactivate.md index 3fedf217..63fecb73 100644 --- a/commands/plugin/deactivate.md +++ b/commands/plugin/deactivate.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/delete.md b/commands/plugin/delete.md index dcfa9dc8..f190295a 100644 --- a/commands/plugin/delete.md +++ b/commands/plugin/delete.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/download.md b/commands/plugin/download.md new file mode 100644 index 00000000..0482ebb6 --- /dev/null +++ b/commands/plugin/download.md @@ -0,0 +1,55 @@ +# wp plugin download + +Downloads a plugin zip package without loading WordPress. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<slug> +: Slug of the plugin to download. + +[\--target-path=<path>] +: Directory to store the downloaded zip file. Defaults to the current directory. + +[\--version=<version>] +: Version to download. Accepts a version number or `dev`. + +[\--force] +: Overwrite destination file if it already exists. + +[\--insecure] +: Retry download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. + +### EXAMPLES + + $ wp plugin download bbpress + Downloading bbpress (2.5.9)... + Success: Downloaded plugin package to /path/to/bbpress.2.5.9.zip + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/get.md b/commands/plugin/get.md index 78619b5d..24ccf1cf 100644 --- a/commands/plugin/get.md +++ b/commands/plugin/get.md @@ -58,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -70,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/install-dependencies.md b/commands/plugin/install-dependencies.md new file mode 100644 index 00000000..d18bc97a --- /dev/null +++ b/commands/plugin/install-dependencies.md @@ -0,0 +1,56 @@ +# wp plugin install-dependencies + +Installs all dependencies of an installed plugin. + +This command is useful when you have a plugin installed that depends on other plugins, and you want to install those dependencies without activating the main plugin. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<plugin> +: The installed plugin to get dependencies for. + +[\--activate] +: If set, dependencies will be activated immediately after install. + +[\--activate-network] +: If set, dependencies will be network activated immediately after install. + +[\--force] +: If set, the command will overwrite any installed version of the plugin, without prompting for confirmation. + +### EXAMPLES + + # Install all dependencies of an installed plugin + $ wp plugin install-dependencies my-plugin + Installing Required Plugin 1 (1.2.3) + Plugin installed successfully. + Installing Required Plugin 2 (2.0.0) + Plugin installed successfully. + Success: Installed 2 of 2 plugins. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/install.md b/commands/plugin/install.md index afde5dbb..c66f0d6c 100644 --- a/commands/plugin/install.md +++ b/commands/plugin/install.md @@ -7,7 +7,7 @@ Installs one or more plugins. See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. <plugin|zip|url>... -: One or more plugins to install. Accepts a plugin slug, the path to a local zip file, or a URL to a remote zip file. +: One or more plugins to install. Accepts a plugin slug, the path to a local zip file, a URL to a remote zip file or PHP file, or a URL to a WordPress.org plugin directory. [\--version=<version>] : If set, get that particular version from wordpress.org, instead of the stable version. @@ -27,6 +27,12 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--with-dependencies] +: If set, the command will also install all required dependencies of the plugin as specified in the 'Requires Plugins' header. + +[\--slug=<slug>] +: Use this as the target directory name when installing from a zip file. Cannot be used when installing multiple plugins. + ### EXAMPLES # Install the latest version from wordpress.org and activate @@ -84,6 +90,31 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg Plugin updated successfully Success: Installed 1 of 1 plugins. + # Install from a remote PHP file + $ wp plugin install https://example.com/my-plugin.php + Installing My Plugin (1.0.0) + Downloading plugin file from https://example.com/my-plugin.php... + + # Install a plugin with all its dependencies + $ wp plugin install my-plugin --with-dependencies + Installing Required Plugin 1 (1.2.3) + Plugin installed successfully. + Installing Required Plugin 2 (2.0.0) + Plugin installed successfully. + Installing My Plugin (3.5.0) + Plugin installed successfully. + Success: Installed 3 of 3 plugins. + + # Install from a WordPress.org plugin directory URL + $ wp plugin install https://wordpress.org/plugins/akismet/ + Detected WordPress.org plugins directory URL, using slug: akismet + Installing Akismet Anti-spam: Spam Protection (3.1.11) + Downloading install package from https://downloads.wordpress.org/plugin/akismet.3.1.11.zip... + Unpacking the package... + Installing the plugin... + Plugin installed successfully. + Success: Installed 1 of 1 plugins. + ### 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. @@ -93,6 +124,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -105,3 +137,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/is-active.md b/commands/plugin/is-active.md index 960c8bfb..2ebc9462 100644 --- a/commands/plugin/is-active.md +++ b/commands/plugin/is-active.md @@ -4,6 +4,8 @@ Checks if a given plugin is active. Returns exit code 0 when active, 1 when not active. +If the plugin does not exist but is still in WordPress's active plugins storage (such as the active plugins option or the sitewide plugins option for network-activated plugins), a warning will be emitted. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -30,6 +32,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +45,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/is-installed.md b/commands/plugin/is-installed.md index 6868383a..49ac9e37 100644 --- a/commands/plugin/is-installed.md +++ b/commands/plugin/is-installed.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/list.md b/commands/plugin/list.md index 9fff95c2..a1ca1dfe 100644 --- a/commands/plugin/list.md +++ b/commands/plugin/list.md @@ -31,7 +31,7 @@ options: - yaml \--- -[\--status=<status>] +[\--status=<status>...] : Filter the output by plugin status. \--- options: @@ -72,6 +72,7 @@ These fields are optionally available: * requires_php * wporg_status * wporg_last_updated +* auto_update_indicated ### EXAMPLES @@ -118,6 +119,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -130,3 +132,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/path.md b/commands/plugin/path.md index bb780f0f..06bd067c 100644 --- a/commands/plugin/path.md +++ b/commands/plugin/path.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/search.md b/commands/plugin/search.md index 0453680e..bfa2737a 100644 --- a/commands/plugin/search.md +++ b/commands/plugin/search.md @@ -94,6 +94,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -106,3 +107,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/status.md b/commands/plugin/status.md index 3ad85909..42119dfd 100644 --- a/commands/plugin/status.md +++ b/commands/plugin/status.md @@ -39,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -51,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/toggle.md b/commands/plugin/toggle.md index a4642bae..ce575ea2 100644 --- a/commands/plugin/toggle.md +++ b/commands/plugin/toggle.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/uninstall.md b/commands/plugin/uninstall.md index d4508b06..1fff21f2 100644 --- a/commands/plugin/uninstall.md +++ b/commands/plugin/uninstall.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/update.md b/commands/plugin/update.md index e29858b8..619c9be9 100644 --- a/commands/plugin/update.md +++ b/commands/plugin/update.md @@ -43,6 +43,12 @@ options: [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--auto-update-indicated] +: Only update plugins where the server response indicates an automatic update. Updates to the version indicated by the server, not necessarily the latest version. Cannot be used with `--version`, `--minor`, or `--patch`. + +[\--include-vcs] +: Include plugins that are version-controlled with a VCS (e.g. git, svn, hg). Skipped by default. + ### EXAMPLES $ wp plugin update bbpress --version=dev @@ -98,6 +104,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -110,3 +117,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/upgrade.md b/commands/plugin/upgrade.md index bd9edbf8..ce5cfe7f 100644 --- a/commands/plugin/upgrade.md +++ b/commands/plugin/upgrade.md @@ -43,6 +43,12 @@ options: [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--auto-update-indicated] +: Only update plugins where the server response indicates an automatic update. Updates to the version indicated by the server, not necessarily the latest version. Cannot be used with `--version`, `--minor`, or `--patch`. + +[\--include-vcs] +: Include plugins that are version-controlled with a VCS (e.g. git, svn, hg). Skipped by default. + ### EXAMPLES $ wp plugin update bbpress --version=dev @@ -98,6 +104,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -110,3 +117,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/plugin/verify-checksums.md b/commands/plugin/verify-checksums.md index 2b30e4c0..17aba9c4 100644 --- a/commands/plugin/verify-checksums.md +++ b/commands/plugin/verify-checksums.md @@ -36,6 +36,9 @@ options: [\--exclude=<name>] : Comma separated list of plugin names that should be excluded from verifying. +[\--exclude-mu-plugins] +: Exclude must-use plugins from verification. + ### EXAMPLES # Verify the checksums of all installed plugins @@ -55,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -67,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post-type/get.md b/commands/post-type/get.md index 3c14d540..371bb439 100644 --- a/commands/post-type/get.md +++ b/commands/post-type/get.md @@ -59,6 +59,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -71,3 +72,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post-type/list.md b/commands/post-type/list.md index bddf5c01..b1b97840 100644 --- a/commands/post-type/list.md +++ b/commands/post-type/list.md @@ -73,6 +73,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -85,3 +86,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block.md b/commands/post/block.md new file mode 100644 index 00000000..61595bf3 --- /dev/null +++ b/commands/post/block.md @@ -0,0 +1,26 @@ +# wp post block + +Manages blocks within post content. + +Provides commands for inspecting, manipulating, and managing Gutenberg blocks in post content. + +### EXAMPLES + + # List all blocks in a post. + $ wp post block list 123 + +------------------+-------+ + | blockName | count | + +------------------+-------+ + | core/paragraph | 2 | + | core/heading | 1 | + +------------------+-------+ + + # Parse blocks in a post to JSON. + $ wp post block parse 123 --format=json + + # Insert a paragraph block. + $ wp post block insert 123 core/paragraph --content="Hello World" + + + + diff --git a/commands/post/block/clone.md b/commands/post/block/clone.md new file mode 100644 index 00000000..f281ec36 --- /dev/null +++ b/commands/post/block/clone.md @@ -0,0 +1,75 @@ +# wp post block clone + +Clones a block within a post. + +Duplicates an existing block and inserts it at a specified position. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post. + +<source-index> +: Index of the block to clone (0-indexed). + +[\--position=<position>] +: Where to insert the cloned block. Accepts 'after', 'before', 'start', 'end', or a numeric index. +\--- +default: after +\--- + +[\--porcelain] +: Output just the new block index. + +### EXAMPLES + + # Clone a block and insert immediately after it (default). + $ wp post block clone 123 2 + Success: Cloned block to index 3 in post 123. + + # Clone the first block and insert immediately before it. + $ wp post block clone 123 0 --position=before + Success: Cloned block to index 0 in post 123. + + # Clone a block and insert at the end of the post. + $ wp post block clone 123 0 --position=end + Success: Cloned block to index 5 in post 123. + + # Clone a block and insert at the start of the post. + $ wp post block clone 123 3 --position=start + Success: Cloned block to index 0 in post 123. + + # Clone and get just the new block index for scripting. + $ wp post block clone 123 1 --porcelain + 2 + + # Duplicate the hero section (first block) at the end for a footer. + $ wp post block clone 123 0 --position=end + Success: Cloned block to index 10 in post 123. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/count.md b/commands/post/block/count.md new file mode 100644 index 00000000..c5ee31b7 --- /dev/null +++ b/commands/post/block/count.md @@ -0,0 +1,106 @@ +# wp post block count + +Counts blocks across multiple posts. + +Analyzes block usage across posts for site-wide reporting. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[<id>...] +: Optional post IDs. If not specified, queries all posts. + +[\--block=<block-name>] +: Only count specific block type. + +[\--post-type=<type>] +: Limit to specific post type(s). Comma-separated. +\--- +default: post,page +\--- + +[\--post-status=<status>] +: Post status to include. +\--- +default: publish +\--- + +[\--format=<format>] +: Output format. +\--- +default: table +options: + - table + - json + - csv + - yaml + - count +\--- + +### EXAMPLES + + # Count all blocks across published posts and pages. + $ wp post block count + +------------------+-------+-------+ + | blockName | count | posts | + +------------------+-------+-------+ + | core/paragraph | 1542 | 234 | + | core/heading | 523 | 198 | + | core/image | 312 | 156 | + +------------------+-------+-------+ + + # Count blocks in specific posts only. + $ wp post block count 123 456 789 + +------------------+-------+-------+ + | blockName | count | posts | + +------------------+-------+-------+ + | core/paragraph | 8 | 3 | + | core/heading | 3 | 2 | + +------------------+-------+-------+ + + # Count only paragraph blocks across the site. + $ wp post block count --block=core/paragraph --format=count + 1542 + + # Count blocks in a custom post type. + $ wp post block count --post-type=product + + # Count blocks in multiple post types. + $ wp post block count --post-type=post,page,product + + # Count blocks including drafts. + $ wp post block count --post-status=draft + + # Get count as JSON for further processing. + $ wp post block count --format=json + [{"blockName":"core/paragraph","count":1542,"posts":234}] + + # Get total number of unique block types used. + $ wp post block count --format=count + 15 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/export.md b/commands/post/block/export.md new file mode 100644 index 00000000..e457fb12 --- /dev/null +++ b/commands/post/block/export.md @@ -0,0 +1,88 @@ +# wp post block export + +Exports block content to a file. + +Exports blocks from a post to a file for backup or migration. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to export blocks from. + +[\--file=<file>] +: Output file path. If not specified, outputs to STDOUT. + +[\--format=<format>] +: Export format. +\--- +default: json +options: + - json + - yaml + - html +\--- + +[\--raw] +: Include innerHTML in JSON/YAML output. + +### EXAMPLES + + # Export blocks to a JSON file for backup. + $ wp post block export 123 --file=blocks.json + Success: Exported 5 blocks to blocks.json + + # Export blocks to STDOUT as JSON. + $ wp post block export 123 + { + "version": "1.0", + "generator": "wp-cli/entity-command", + "post_id": 123, + "exported_at": "2024-12-10T12:00:00+00:00", + "blocks": [...] + } + + # Export as YAML format. + $ wp post block export 123 --format=yaml + version: "1.0" + generator: wp-cli/entity-command + blocks: + - blockName: core/paragraph + attrs: [] + + # Export rendered HTML (final output, not block structure). + $ wp post block export 123 --format=html --file=content.html + Success: Exported 5 blocks to content.html + + # Export with raw innerHTML included for complete backup. + $ wp post block export 123 --raw --file=blocks-full.json + Success: Exported 5 blocks to blocks-full.json + + # Pipe export to another command. + $ wp post block export 123 | jq '.blocks[].blockName' + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/extract.md b/commands/post/block/extract.md new file mode 100644 index 00000000..8444ecd2 --- /dev/null +++ b/commands/post/block/extract.md @@ -0,0 +1,99 @@ +# wp post block extract + +Extracts data from blocks. + +Extracts specific attribute values or content from blocks for scripting. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post. + +[\--block=<block-name>] +: Filter by block type. + +[\--index=<index>] +: Get from specific block index. + +[\--attr=<attr>] +: Extract specific attribute value. + +[\--content] +: Extract innerHTML content. + +[\--format=<format>] +: Output format. +\--- +default: json +options: + - json + - yaml + - csv + - ids +\--- + +### EXAMPLES + + # Extract all image IDs from the post (one per line). + $ wp post block extract 123 --block=core/image --attr=id --format=ids + 456 + 789 + 1024 + + # Extract all image URLs as JSON array. + $ wp post block extract 123 --block=core/image --attr=url --format=json + ["https://example.com/img1.jpg","https://example.com/img2.jpg"] + + # Extract text content from all headings. + $ wp post block extract 123 --block=core/heading --content --format=ids + Introduction + Getting Started + Conclusion + + # Get the heading level from the first block. + $ wp post block extract 123 --index=0 --attr=level --format=ids + 2 + + # Extract all heading levels as CSV. + $ wp post block extract 123 --block=core/heading --attr=level --format=csv + 2,3,3,2 + + # Extract paragraph content as YAML. + $ wp post block extract 123 --block=core/paragraph --content --format=yaml + - "First paragraph text" + - "Second paragraph text" + + # Get all button URLs for link checking. + $ wp post block extract 123 --block=core/button --attr=url --format=ids + https://example.com/signup + https://example.com/learn-more + + # Extract cover block image IDs for media audit. + $ wp post block extract 123 --block=core/cover --attr=id --format=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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/get.md b/commands/post/block/get.md new file mode 100644 index 00000000..da76ede7 --- /dev/null +++ b/commands/post/block/get.md @@ -0,0 +1,90 @@ +# wp post block get + +Gets a single block by index. + +Retrieves the full structure of a block at the specified position. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post. + +<index> +: The block index (0-indexed). + +[\--raw] +: Include innerHTML in output. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: json +options: + - json + - yaml +\--- + +### EXAMPLES + + # Get the first block in a post. + $ wp post block get 123 0 + { + "blockName": "core/paragraph", + "attrs": {}, + "innerBlocks": [] + } + + # Get the third block (index 2) with attributes. + $ wp post block get 123 2 + { + "blockName": "core/heading", + "attrs": { + "level": 2 + }, + "innerBlocks": [] + } + + # Get block as YAML format. + $ wp post block get 123 1 --format=yaml + blockName: core/image + attrs: + id: 456 + sizeSlug: large + innerBlocks: [] + + # Get block with raw HTML content included. + $ wp post block get 123 0 --raw + { + "blockName": "core/paragraph", + "attrs": {}, + "innerBlocks": [], + "innerHTML": "<p>Hello World</p>", + "innerContent": ["<p>Hello World</p>"] + } + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/import.md b/commands/post/block/import.md new file mode 100644 index 00000000..f7cfc913 --- /dev/null +++ b/commands/post/block/import.md @@ -0,0 +1,82 @@ +# wp post block import + +Imports blocks from a file into a post. + +Imports blocks from a JSON or YAML file into a post's content. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to import blocks into. + +[\--file=<file>] +: Input file path. If not specified, reads from STDIN. + +[\--position=<position>] +: Where to insert imported blocks. Accepts 'start', 'end', or a numeric index. +\--- +default: end +\--- + +[\--replace] +: Replace all existing blocks instead of appending. + +[\--porcelain] +: Output just the number of blocks imported. + +### EXAMPLES + + # Import blocks from a JSON file, append to end of post. + $ wp post block import 123 --file=blocks.json + Success: Imported 5 blocks into post 123. + + # Import blocks at the beginning of the post. + $ wp post block import 123 --file=blocks.json --position=start + Success: Imported 5 blocks into post 123. + + # Replace all existing content with imported blocks. + $ wp post block import 123 --file=blocks.json --replace + Success: Imported 5 blocks into post 123. + + # Import from STDIN (piped from another command). + $ cat blocks.json | wp post block import 123 + Success: Imported 5 blocks into post 123. + + # Copy blocks from one post to another. + $ wp post block export 123 | wp post block import 456 + Success: Imported 5 blocks into post 456. + + # Import YAML format. + $ wp post block import 123 --file=blocks.yaml + Success: Imported 3 blocks into post 123. + + # Get just the count of imported blocks for scripting. + $ wp post block import 123 --file=blocks.json --porcelain + 5 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/insert.md b/commands/post/block/insert.md new file mode 100644 index 00000000..4bc5551d --- /dev/null +++ b/commands/post/block/insert.md @@ -0,0 +1,71 @@ +# wp post block insert + +Inserts a block into a post at a specified position. + +Adds a new block to the post content. By default, the block is appended to the end of the post. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to modify. + +<block-name> +: The block type name (e.g., 'core/paragraph'). + +[\--content=<content>] +: The inner content/HTML for the block. + +[\--attrs=<attrs>] +: Block attributes as JSON. + +[\--position=<position>] +: Position to insert the block (0-indexed). Use 'start' or 'end'. +\--- +default: end +\--- + +[\--porcelain] +: Output just the post ID. + +### EXAMPLES + + # Insert a paragraph block at the end of the post. + $ wp post block insert 123 core/paragraph --content="Hello World" + Success: Inserted block into post 123. + + # Insert a level-2 heading at the start. + $ wp post block insert 123 core/heading --content="My Title" --attrs='{"level":2}' --position=start + Success: Inserted block into post 123. + + # Insert an image block at position 2. + $ wp post block insert 123 core/image --attrs='{"id":456,"url":"https://example.com/image.jpg"}' --position=2 + + # Insert a separator block. + $ wp post block insert 123 core/separator + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/list.md b/commands/post/block/list.md new file mode 100644 index 00000000..ae55fd8e --- /dev/null +++ b/commands/post/block/list.md @@ -0,0 +1,75 @@ +# wp post block list + +Lists blocks in a post with counts. + +Displays a summary of block types used in the post and how many times each block type appears. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to analyze. + +[\--nested] +: Include nested/inner blocks in the list. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml + - count +\--- + +### EXAMPLES + + # List blocks with counts. + $ wp post block list 123 + +------------------+-------+ + | blockName | count | + +------------------+-------+ + | core/paragraph | 5 | + | core/heading | 2 | + | core/image | 1 | + +------------------+-------+ + + # List blocks as JSON. + $ wp post block list 123 --format=json + [{"blockName":"core/paragraph","count":5}] + + # Include nested blocks (e.g., blocks inside columns or groups). + $ wp post block list 123 --nested + + # Get the number of unique block types. + $ wp post block list 123 --format=count + 3 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/move.md b/commands/post/block/move.md new file mode 100644 index 00000000..be42fe6c --- /dev/null +++ b/commands/post/block/move.md @@ -0,0 +1,64 @@ +# wp post block move + +Moves a block from one position to another. + +Reorders blocks within the post by moving a block from one index to another. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post. + +<from-index> +: Current block index (0-indexed). + +<to-index> +: Target position index (0-indexed). + +[\--porcelain] +: Output just the post ID. + +### EXAMPLES + + # Move the first block to the third position. + $ wp post block move 123 0 2 + Success: Moved block from index 0 to index 2 in post 123. + + # Move the last block (index 4) to the beginning. + $ wp post block move 123 4 0 + Success: Moved block from index 4 to index 0 in post 123. + + # Move a heading block from position 3 to position 1. + $ wp post block move 123 3 1 + Success: Moved block from index 3 to index 1 in post 123. + + # Move block and get post ID for scripting. + $ wp post block move 123 2 0 --porcelain + 123 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/parse.md b/commands/post/block/parse.md new file mode 100644 index 00000000..63935c80 --- /dev/null +++ b/commands/post/block/parse.md @@ -0,0 +1,69 @@ +# wp post block parse + +Parses and displays the block structure of a post. + +Outputs the parsed block structure as JSON or YAML. By default, innerHTML is stripped from the output for readability. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to parse. + +[\--raw] +: Include raw innerHTML in output. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: json +options: + - json + - yaml +\--- + +### EXAMPLES + + # Parse blocks to JSON. + $ wp post block parse 123 + [ + { + "blockName": "core/paragraph", + "attrs": {} + } + ] + + # Parse blocks to YAML format. + $ wp post block parse 123 --format=yaml + - + blockName: core/paragraph + attrs: { } + + # Parse blocks including raw HTML content. + $ wp post block parse 123 --raw + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/remove.md b/commands/post/block/remove.md new file mode 100644 index 00000000..454a5b6e --- /dev/null +++ b/commands/post/block/remove.md @@ -0,0 +1,71 @@ +# wp post block remove + +Removes blocks from a post by name or index. + +Removes one or more blocks from the post content. Blocks can be removed by their type name or by their position index. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to modify. + +[<block-name>] +: The block type name to remove (e.g., 'core/paragraph'). + +[\--index=<index>] +: Remove block at specific index (0-indexed). Can be comma-separated for multiple indices. + +[\--all] +: Remove all blocks of the specified type. + +[\--porcelain] +: Output just the number of blocks removed. + +### EXAMPLES + + # Remove the first block (index 0). + $ wp post block remove 123 --index=0 + Success: Removed 1 block from post 123. + + # Remove the first paragraph block found. + $ wp post block remove 123 core/paragraph + Success: Removed 1 block from post 123. + + # Remove all paragraph blocks. + $ wp post block remove 123 core/paragraph --all + Success: Removed 5 blocks from post 123. + + # Remove blocks at multiple indices. + $ wp post block remove 123 --index=0,2,4 + Success: Removed 3 blocks from post 123. + + # Remove all image blocks and get count. + $ wp post block remove 123 core/image --all --porcelain + 2 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/render.md b/commands/post/block/render.md new file mode 100644 index 00000000..e819496e --- /dev/null +++ b/commands/post/block/render.md @@ -0,0 +1,54 @@ +# wp post block render + +Renders blocks from a post to HTML. + +Outputs the rendered HTML of blocks in a post. This uses WordPress's block rendering system to produce the final HTML output. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to render. + +[\--block=<block-name>] +: Only render blocks of this type. + +### EXAMPLES + + # Render all blocks to HTML. + $ wp post block render 123 + <p>Hello World</p> + <h2>My Heading</h2> + + # Render only paragraph blocks. + $ wp post block render 123 --block=core/paragraph + <p>Hello World</p> + + # Render only heading blocks. + $ wp post block render 123 --block=core/heading + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/replace.md b/commands/post/block/replace.md new file mode 100644 index 00000000..8589ff84 --- /dev/null +++ b/commands/post/block/replace.md @@ -0,0 +1,72 @@ +# wp post block replace + +Replaces blocks in a post. + +Replaces blocks of one type with blocks of another type. Can also be used to update block attributes without changing the block type. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to modify. + +<old-block-name> +: The block type name to replace. + +<new-block-name> +: The new block type name. + +[\--attrs=<attrs>] +: New block attributes as JSON. + +[\--content=<content>] +: New block content. Use '{content}' to preserve original content. + +[\--all] +: Replace all matching blocks. By default, only the first match is replaced. + +[\--porcelain] +: Output just the number of blocks replaced. + +### EXAMPLES + + # Replace the first paragraph block with a heading. + $ wp post block replace 123 core/paragraph core/heading + Success: Replaced 1 block in post 123. + + # Replace all paragraphs with preformatted blocks, keeping content. + $ wp post block replace 123 core/paragraph core/preformatted --content='{content}' --all + Success: Replaced 3 blocks in post 123. + + # Change all h2 headings to h3. + $ wp post block replace 123 core/heading core/heading --attrs='{"level":3}' --all + + # Replace and get count for scripting. + $ wp post block replace 123 core/quote core/pullquote --all --porcelain + 2 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/block/update.md b/commands/post/block/update.md new file mode 100644 index 00000000..114e1700 --- /dev/null +++ b/commands/post/block/update.md @@ -0,0 +1,83 @@ +# wp post block update + +Updates a block's attributes or content by index. + +Modifies a specific block without changing its type. For blocks where attributes are reflected in HTML (like heading levels), the HTML is automatically updated to match the new attributes. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post. + +<index> +: The block index to update (0-indexed). + +[\--attrs=<attrs>] +: Block attributes as JSON. Merges with existing attributes by default. + +[\--content=<content>] +: New innerHTML content for the block. + +[\--replace-attrs] +: Replace all attributes instead of merging. + +[\--porcelain] +: Output just the post ID. + +### EXAMPLES + + # Change a heading from h2 to h3. + $ wp post block update 123 0 --attrs='{"level":3}' + Success: Updated block at index 0 in post 123. + + # Add alignment to an existing paragraph (merges with existing attrs). + $ wp post block update 123 1 --attrs='{"align":"center"}' + Success: Updated block at index 1 in post 123. + + # Update the text content of a paragraph block. + $ wp post block update 123 2 --content="<p>Updated paragraph text</p>" + Success: Updated block at index 2 in post 123. + + # Update both attributes and content at once. + $ wp post block update 123 0 --attrs='{"level":2}' --content="<h2>New Heading</h2>" + Success: Updated block at index 0 in post 123. + + # Replace all attributes instead of merging (removes existing attrs). + $ wp post block update 123 0 --attrs='{"level":4}' --replace-attrs + Success: Updated block at index 0 in post 123. + + # Get just the post ID for scripting. + $ wp post block update 123 0 --attrs='{"level":2}' --porcelain + 123 + + # Use custom HTML sync logic via the wp_cli_post_block_update_html filter. + # Use WP_CLI::add_wp_hook() in a file loaded with --require. + $ wp post block update 123 0 --attrs='{"url":"https://example.com"}' --require=my-sync-filters.php + Success: Updated block at index 0 in post 123. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/create.md b/commands/post/create.md index 7561fcdd..5f9cd4ec 100644 --- a/commands/post/create.md +++ b/commands/post/create.md @@ -81,6 +81,8 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--tax_input=<tax_input>] : Array of taxonomy terms keyed by their taxonomy name. Default empty. + Note: In WordPress core, this normally requires a user context to satisfy capability checks. WP-CLI bypasses this for convenience. See https://core.trac.wordpress.org/ticket/19373 + [\--meta_input=<meta_input>] : Array in JSON format of post meta values keyed by their post meta key. Default empty. @@ -131,6 +133,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -143,3 +146,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/delete.md b/commands/post/delete.md index 17c59210..49a9baf0 100644 --- a/commands/post/delete.md +++ b/commands/post/delete.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/edit.md b/commands/post/edit.md index 3bcc83a2..b697873d 100644 --- a/commands/post/edit.md +++ b/commands/post/edit.md @@ -23,6 +23,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -35,3 +36,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/exists.md b/commands/post/exists.md index 5c4cc93b..70734925 100644 --- a/commands/post/exists.md +++ b/commands/post/exists.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/generate.md b/commands/post/generate.md index 1096ff55..8cc028f0 100644 --- a/commands/post/generate.md +++ b/commands/post/generate.md @@ -90,6 +90,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -102,3 +103,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/get.md b/commands/post/get.md index a021003c..a8a85d58 100644 --- a/commands/post/get.md +++ b/commands/post/get.md @@ -31,6 +31,11 @@ options: # Save the post content to a file $ wp post get 123 --field=content > file.txt + # Get the block version of a post (1 = has blocks, 0 = no blocks) + # Requires WordPress 5.0+. + $ wp post get 123 --field=block_version + 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. @@ -40,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -52,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/has-block.md b/commands/post/has-block.md new file mode 100644 index 00000000..6493202b --- /dev/null +++ b/commands/post/has-block.md @@ -0,0 +1,57 @@ +# wp post has-block + +Checks if a post contains a specific block type. + +Exits with return code 0 if the post contains the specified block, or return code 1 if it does not. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to check. + +<block-name> +: The block type name to check for (e.g., 'core/paragraph'). + +### EXAMPLES + + # Check if post contains a paragraph block. + $ wp post has-block 123 core/paragraph + Success: Post 123 contains block 'core/paragraph'. + + # Check for a heading block. + $ wp post has-block 123 core/heading + Success: Post 123 contains block 'core/heading'. + + # Check for a block that doesn't exist. + $ wp post has-block 123 core/gallery + Error: Post 123 does not contain block 'core/gallery'. + + # Check for a custom block from a plugin. + $ wp post has-block 123 my-plugin/custom-block + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/has-blocks.md b/commands/post/has-blocks.md new file mode 100644 index 00000000..a834acd3 --- /dev/null +++ b/commands/post/has-blocks.md @@ -0,0 +1,52 @@ +# wp post has-blocks + +Checks if a post contains any blocks. + +Exits with return code 0 if the post contains blocks, or return code 1 if it does not. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The ID of the post to check. + +### EXAMPLES + + # Check if post contains blocks. + $ wp post has-blocks 123 + Success: Post 123 contains blocks. + + # Check a classic (non-block) post. + $ wp post has-blocks 456 + Error: Post 456 does not contain blocks. + + # Use in a shell conditional. + $ if wp post has-blocks 123 2>/dev/null; then + > echo "Post uses blocks" + > 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/list.md b/commands/post/list.md index c45701aa..3c7b1ea4 100644 --- a/commands/post/list.md +++ b/commands/post/list.md @@ -114,6 +114,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -126,3 +127,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/add.md b/commands/post/meta/add.md index af9fc105..20143c79 100644 --- a/commands/post/meta/add.md +++ b/commands/post/meta/add.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/clean-duplicates.md b/commands/post/meta/clean-duplicates.md index aceab8f5..c30066b0 100644 --- a/commands/post/meta/clean-duplicates.md +++ b/commands/post/meta/clean-duplicates.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/delete.md b/commands/post/meta/delete.md index ec81508b..d3723f88 100644 --- a/commands/post/meta/delete.md +++ b/commands/post/meta/delete.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/get.md b/commands/post/meta/get.md index 0a29f6aa..387d94e4 100644 --- a/commands/post/meta/get.md +++ b/commands/post/meta/get.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/list.md b/commands/post/meta/list.md index 92111d80..66382d1a 100644 --- a/commands/post/meta/list.md +++ b/commands/post/meta/list.md @@ -58,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -70,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/patch.md b/commands/post/meta/patch.md index 7e5d0873..06b044f2 100644 --- a/commands/post/meta/patch.md +++ b/commands/post/meta/patch.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/pluck.md b/commands/post/meta/pluck.md index 487eab61..2a28c4a6 100644 --- a/commands/post/meta/pluck.md +++ b/commands/post/meta/pluck.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/set.md b/commands/post/meta/set.md index abcde18d..0838aceb 100644 --- a/commands/post/meta/set.md +++ b/commands/post/meta/set.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/meta/update.md b/commands/post/meta/update.md index 6213f01d..8fc3af69 100644 --- a/commands/post/meta/update.md +++ b/commands/post/meta/update.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/revision.md b/commands/post/revision.md new file mode 100644 index 00000000..1767de1c --- /dev/null +++ b/commands/post/revision.md @@ -0,0 +1,16 @@ +# wp post revision + +Manages post revisions. + +### EXAMPLES + + # Restore a post revision + $ wp post revision restore 123 + Success: Restored revision 123. + + # Show diff between two revisions + $ wp post revision diff 123 456 + + + + diff --git a/commands/post/revision/diff.md b/commands/post/revision/diff.md new file mode 100644 index 00000000..a5d1f72f --- /dev/null +++ b/commands/post/revision/diff.md @@ -0,0 +1,49 @@ +# wp post revision diff + +Shows the difference between two revisions. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<from> +: The 'from' revision ID or post ID. + +[<to>] +: The 'to' revision ID or post ID. If not provided, compares with the current post. + +[\--field=<field>] +: Compare specific field(s). Default: post_content + +### EXAMPLES + + # Show diff between two revisions + $ wp post revision diff 123 456 + + # Show diff between a revision and the current post + $ wp post revision diff 123 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/revision/prune.md b/commands/post/revision/prune.md new file mode 100644 index 00000000..0b3d9d30 --- /dev/null +++ b/commands/post/revision/prune.md @@ -0,0 +1,59 @@ +# wp post revision prune + +Deletes old post revisions. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[<post-id>...] +: One or more post IDs to prune revisions for. If not provided, prunes revisions for all posts. + +[\--latest=<limit>] +: Keep only the latest N revisions per post. Older revisions will be deleted. + +[\--earliest=<limit>] +: Keep only the earliest N revisions per post. Newer revisions will be deleted. + +[\--yes] +: Skip confirmation prompt. + +### EXAMPLES + + # Delete all but the latest 5 revisions for post 123 + $ wp post revision prune 123 --latest=5 + Success: Deleted 3 revisions for post 123. + + # Delete all but the latest 5 revisions for all posts + $ wp post revision prune --latest=5 + Success: Deleted 150 revisions across 30 posts. + + # Delete all but the earliest 2 revisions for posts 123 and 456 + $ wp post revision prune 123 456 --earliest=2 + Success: Deleted 5 revisions for post 123. + Success: Deleted 3 revisions for post 456. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/revision/restore.md b/commands/post/revision/restore.md new file mode 100644 index 00000000..67c1cf15 --- /dev/null +++ b/commands/post/revision/restore.md @@ -0,0 +1,41 @@ +# wp post revision restore + +Restores a post revision. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<revision_id> +: The revision ID to restore. + +### EXAMPLES + + # Restore a post revision + $ wp post revision restore 123 + Success: Restored revision 123. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/term/add.md b/commands/post/term/add.md index a90af398..85975bfa 100644 --- a/commands/post/term/add.md +++ b/commands/post/term/add.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/term/list.md b/commands/post/term/list.md index da984fa9..76a8c3a2 100644 --- a/commands/post/term/list.md +++ b/commands/post/term/list.md @@ -57,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -69,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/term/remove.md b/commands/post/term/remove.md index 25242220..daacad9a 100644 --- a/commands/post/term/remove.md +++ b/commands/post/term/remove.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/term/set.md b/commands/post/term/set.md index 6a1bc4d8..1d4641ba 100644 --- a/commands/post/term/set.md +++ b/commands/post/term/set.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/update.md b/commands/post/update.md index d69e0a19..6bd33fac 100644 --- a/commands/post/update.md +++ b/commands/post/update.md @@ -81,6 +81,8 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--tax_input=<tax_input>] : Array of taxonomy terms keyed by their taxonomy name. Default empty. + Note: In WordPress core, this normally requires a user context to satisfy capability checks. WP-CLI bypasses this for convenience. See https://core.trac.wordpress.org/ticket/19373 + [\--meta_input=<meta_input>] : Array in JSON format of post meta values keyed by their post meta key. Default empty. @@ -125,6 +127,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -137,3 +140,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/post/url-to-id.md b/commands/post/url-to-id.md index dd124bde..4f2f2887 100644 --- a/commands/post/url-to-id.md +++ b/commands/post/url-to-id.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/profile/eval-file.md b/commands/profile/eval-file.md index a99f39b4..8498811e 100644 --- a/commands/profile/eval-file.md +++ b/commands/profile/eval-file.md @@ -59,6 +59,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -71,3 +72,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/profile/eval.md b/commands/profile/eval.md index 03e01189..f9e5bde5 100644 --- a/commands/profile/eval.md +++ b/commands/profile/eval.md @@ -59,6 +59,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -71,3 +72,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/profile/hook.md b/commands/profile/hook.md index e6fdddf5..2109edea 100644 --- a/commands/profile/hook.md +++ b/commands/profile/hook.md @@ -48,6 +48,9 @@ options: [\--orderby=<fields>] : Set orderby which field. +[\--search=<pattern>] +: Filter callbacks to those matching the given search pattern (case-insensitive). + ### EXAMPLES # Profile a hook. @@ -75,6 +78,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -87,3 +91,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/profile/queries.md b/commands/profile/queries.md new file mode 100644 index 00000000..30a25c36 --- /dev/null +++ b/commands/profile/queries.md @@ -0,0 +1,88 @@ +# wp profile queries + +Profile database queries and their execution time. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +Displays all database queries executed during a WordPress request, along with their execution time and caller information. You can filter queries to only show those executed during a specific hook or by a specific callback. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--url=<url>] +: Execute a request against a specified URL. Defaults to the home URL. + +[\--hook=<hook>] +: Filter queries to only show those executed during a specific hook. + +[\--callback=<callback>] +: Filter queries to only show those executed by a specific callback. + +[\--time_threshold=<seconds>] +: Filter queries to only show those that took longer than or equal to a certain number of seconds. + +[\--fields=<fields>] +: Limit the output to specific fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - json + - yaml + - csv +\--- + +[\--order=<order>] +: Ascending or Descending order. +\--- +default: ASC +options: + - ASC + - DESC +\--- + +[\--orderby=<fields>] +: Set orderby which field. + +### EXAMPLES + + # Show all queries with their execution time + $ wp profile queries --fields=query,time + + # Show queries executed during the 'init' hook + $ wp profile queries --hook=init --fields=query,time,caller + + # Show queries executed by a specific callback + $ wp profile queries --callback='WP_Query->get_posts()' --fields=query,time + + # Show queries ordered by execution time + $ wp profile queries --fields=query,time --orderby=time --order=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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/profile/stage.md b/commands/profile/stage.md index 8c554c19..488b96d0 100644 --- a/commands/profile/stage.md +++ b/commands/profile/stage.md @@ -91,6 +91,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -103,3 +104,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/rewrite/flush.md b/commands/rewrite/flush.md index 8d6637a1..65d748ea 100644 --- a/commands/rewrite/flush.md +++ b/commands/rewrite/flush.md @@ -32,6 +32,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -44,3 +45,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/rewrite/list.md b/commands/rewrite/list.md index 36047b4e..528d247f 100644 --- a/commands/rewrite/list.md +++ b/commands/rewrite/list.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/rewrite/structure.md b/commands/rewrite/structure.md index b38ccbd0..c4026bc7 100644 --- a/commands/rewrite/structure.md +++ b/commands/rewrite/structure.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/role.md b/commands/role.md index 9a4832e4..afec797b 100644 --- a/commands/role.md +++ b/commands/role.md @@ -2,7 +2,8 @@ Manages user roles, including creating new roles and resetting to defaults. -See references for [Roles and Capabilities](https://wordpress.org/documentation/article/roles-and-capabilities) and [WP User class](https://developer.wordpress.org/reference/classes/wp_user). +See references for [Roles and Capabilities](https://wordpress.org/documentation/article/roles-and-capabilities) and +[WP User class](https://developer.wordpress.org/reference/classes/wp_user). ### EXAMPLES diff --git a/commands/role/create.md b/commands/role/create.md index 324dcc45..bd147766 100644 --- a/commands/role/create.md +++ b/commands/role/create.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/role/delete.md b/commands/role/delete.md index e0ac4155..c5105ac8 100644 --- a/commands/role/delete.md +++ b/commands/role/delete.md @@ -28,6 +28,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -40,3 +41,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/role/exists.md b/commands/role/exists.md index 0334ec57..03e9e920 100644 --- a/commands/role/exists.md +++ b/commands/role/exists.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/role/list.md b/commands/role/list.md index 958549cd..a1720281 100644 --- a/commands/role/list.md +++ b/commands/role/list.md @@ -53,6 +53,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -65,3 +66,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/role/reset.md b/commands/role/reset.md index abab54d6..50313858 100644 --- a/commands/role/reset.md +++ b/commands/role/reset.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/_s.md b/commands/scaffold/_s.md index 9c87a191..9f4b29e1 100644 --- a/commands/scaffold/_s.md +++ b/commands/scaffold/_s.md @@ -52,6 +52,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -64,3 +65,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/block.md b/commands/scaffold/block.md index 70e60b86..0be29ff9 100644 --- a/commands/scaffold/block.md +++ b/commands/scaffold/block.md @@ -51,6 +51,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -63,3 +64,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/child-theme.md b/commands/scaffold/child-theme.md index 3c38e0e8..c91db5b0 100644 --- a/commands/scaffold/child-theme.md +++ b/commands/scaffold/child-theme.md @@ -50,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/cpt.md b/commands/scaffold/cpt.md index cb75cfa7..2131dd0f 100644 --- a/commands/scaffold/cpt.md +++ b/commands/scaffold/cpt.md @@ -47,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -59,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/plugin-tests.md b/commands/scaffold/plugin-tests.md index fdd600a5..30f78e61 100644 --- a/commands/scaffold/plugin-tests.md +++ b/commands/scaffold/plugin-tests.md @@ -56,6 +56,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -68,3 +69,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/plugin.md b/commands/scaffold/plugin.md index 98b0348d..161b6e40 100644 --- a/commands/scaffold/plugin.md +++ b/commands/scaffold/plugin.md @@ -84,6 +84,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -96,3 +97,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/post-type.md b/commands/scaffold/post-type.md index 46802cdc..b9abbffc 100644 --- a/commands/scaffold/post-type.md +++ b/commands/scaffold/post-type.md @@ -47,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -59,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/tax.md b/commands/scaffold/tax.md index 00e3970a..5d0cadd2 100644 --- a/commands/scaffold/tax.md +++ b/commands/scaffold/tax.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/taxonomy.md b/commands/scaffold/taxonomy.md index bba3d466..b279f5bb 100644 --- a/commands/scaffold/taxonomy.md +++ b/commands/scaffold/taxonomy.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/theme-tests.md b/commands/scaffold/theme-tests.md index 7fa41a6d..d42ab92e 100644 --- a/commands/scaffold/theme-tests.md +++ b/commands/scaffold/theme-tests.md @@ -56,6 +56,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -68,3 +69,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/scaffold/underscores.md b/commands/scaffold/underscores.md index df3a8094..e370af27 100644 --- a/commands/scaffold/underscores.md +++ b/commands/scaffold/underscores.md @@ -52,6 +52,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -64,3 +65,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/search-replace.md b/commands/search-replace.md index a2410a99..f34ebecb 100644 --- a/commands/search-replace.md +++ b/commands/search-replace.md @@ -8,19 +8,27 @@ By default, the command uses tables registered to the `$wpdb` object. On multisi Search/replace intelligently handles PHP serialized data, and does not change primary key values. +Tables without a primary key are skipped. To check whether a table has a primary key, run `wp db query 'DESCRIBE '` and look for 'PRI' in the Key column. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. -<old> +[<old>] : A string to search for within the database. -<new> +[<new>] : Replace instances of the first string with this new string. [<table>...] : List of database tables to restrict the replacement to. Wildcards are supported, e.g. `'wp_*options'` or `'wp_post*'`. +[\--old=<value>] +: An alternative way to specify the search string. Use this when the search string starts with '--' (e.g., --old='--some-text'). + +[\--new=<value>] +: An alternative way to specify the replacement string. Use this when the replacement string starts with '--' (e.g., --new='--other-text') or is empty. + [\--dry-run] : Run the entire search/replace operation and show report, but don't save changes to the database. @@ -43,13 +51,13 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : Do not perform the replacement on specific tables. Use commas to specify multiple tables. Wildcards are supported, e.g. `'wp_*options'` or `'wp_post*'`. [\--skip-columns=<columns>] -: Do not perform the replacement on specific columns. Use commas to specify multiple columns. +: Do not perform the replacement on specific columns. Use commas to specify multiple columns. Table-qualified column names ("table.column") are supported to apply the skip to a specific table only. [\--include-columns=<columns>] -: Perform the replacement on specific columns. Use commas to specify multiple columns. +: Perform the replacement on specific columns. Use commas to specify multiple columns. Table-qualified column names ("table.column") are supported to apply the inclusion to a specific table only. [\--precise] -: Force the use of PHP (instead of SQL) which is more thorough, but slower. +: Force the use of PHP (instead of SQL) for all columns. By default, the command uses fast SQL queries, but automatically switches to PHP for columns containing serialized data. Use this flag to ensure PHP processes all columns, which is slower but handles complex serialized data structures more reliably. [\--recurse-objects] : Enable recursing into objects to replace strings. Defaults to true; pass --no-recurse-objects to disable. @@ -110,6 +118,15 @@ options: # Search/replace to a SQL file without transforming the database $ wp search-replace foo bar --export=database.sql + # Search/replace string containing hyphens + $ wp search-replace --old='--old-string' --new='new-string' + + # Remove a string by replacing it with an empty value + $ wp search-replace --old='remove-me' --new='' + + # Use precise mode for complex serialized data + $ wp search-replace 'oldurl.com' 'newurl.com' --precise + # Bash script: Search/replace production to development url (multisite compatible) #!/bin/bash if $(wp --url=http://example.com core is-installed --network); then @@ -127,6 +144,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -139,3 +157,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/server.md b/commands/server.md index bc5a4ef9..fc68dabd 100644 --- a/commands/server.md +++ b/commands/server.md @@ -31,6 +31,12 @@ default: 8080 [\--config=<file>] : Configure the server with a specific .ini file. +[\--adapt-scheme] +: Replace HTTPS URLs matching the original site URL with HTTP in server responses. Useful when the site is configured with HTTPS but the development server runs on HTTP. + +[<passthrough>...] +: Optional arguments to pass to the PHP binary. Any arguments after `--` will be passed through to the `php` command. + ### EXAMPLES # Make the instance available on any address (with port 8080) @@ -54,6 +60,20 @@ default: 8080 Document root is / Press Ctrl-C to quit. + # Pass extra parameters to the PHP binary + $ wp server --docroot=public -- -dzend_extension=xdebug.so + PHP 7.4.0 Development Server started at Wed Nov 10 18:00:00 2025 + Listening on http://localhost:8080 + Document root is /var/www/public + Press Ctrl-C to quit. + + # Adapt HTTPS links when the site is configured with HTTPS + $ wp server --adapt-scheme + PHP 8.0.0 Development Server started at Wed Nov 10 18:00:00 2025 + Listening on http://localhost:8080 + Document root is /var/www/html + Press Ctrl-C to quit. + ### 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. @@ -63,6 +83,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -75,3 +96,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/shell.md b/commands/shell.md index 5ecc5c20..bccfcb6e 100644 --- a/commands/shell.md +++ b/commands/shell.md @@ -4,6 +4,8 @@ Opens an interactive PHP console for running and testing PHP code. `wp shell` allows you to evaluate PHP statements and expressions interactively, from within a WordPress environment. Type a bit of code, hit enter, and see the code execute right before you. Because WordPress is loaded, you have access to all the functions, classes and globals that you can use within a WordPress plugin, for example. +The `restart` command reloads the shell by spawning a new PHP process, allowing modified code to be fully reloaded. Note that this requires the `pcntl_exec()` function. If not available, the shell restarts in-process, which resets variables but doesn't reload PHP files. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -11,6 +13,15 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--basic] : Force the use of WP-CLI's built-in PHP REPL, even if the Boris or PsySH PHP REPLs are available. +[\--watch=<path>] +: Watch a file or directory for changes and automatically restart the shell. Only works with the built-in REPL (--basic). + +[\--hook=<hook>] +: Ensure that a specific WordPress action hook has fired before starting the shell. This validates that the preconditions associated with that hook are met. Only hooks that have already been triggered can be used (e.g., init, plugins_loaded, wp_loaded). +\--- +default: '' +\--- + ### EXAMPLES # Call get_bloginfo() to get the name of the site. @@ -18,6 +29,26 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg wp> get_bloginfo( 'name' ); => string(6) "WP-CLI" + # Restart the shell to reload code changes. + $ wp shell + wp> restart + Restarting shell in new process... + wp> + + # Watch a directory for changes and auto-restart. + $ wp shell --watch=wp-content/plugins/my-plugin + wp> // Make changes to files in the plugin directory + Detected changes in wp-content/plugins/my-plugin, restarting shell... + wp> + + # Start a shell, ensuring the 'init' hook has already fired. + $ wp shell --hook=init + + # Start a shell in quiet mode, suppressing return value output. + $ wp shell --quiet + wp> $a = "hello"; + wp> + ### 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. @@ -27,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/sidebar/exists.md b/commands/sidebar/exists.md new file mode 100644 index 00000000..ea469f0d --- /dev/null +++ b/commands/sidebar/exists.md @@ -0,0 +1,40 @@ +# wp sidebar exists + +Check if a sidebar exists. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The sidebar ID. + +### EXAMPLES + + $ wp sidebar exists sidebar-1 + $ wp sidebar exists wp_inactive_widgets && echo "exists" + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/sidebar/get.md b/commands/sidebar/get.md new file mode 100644 index 00000000..7f8e8aff --- /dev/null +++ b/commands/sidebar/get.md @@ -0,0 +1,56 @@ +# wp sidebar get + +Get details about a specific sidebar. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<id> +: The sidebar ID. + +[\--fields=<fields>] +: Limit the output to specific object fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - ids + - count + - yaml +\--- + +### EXAMPLES + + $ wp sidebar get sidebar-1 + $ wp sidebar get wp_inactive_widgets --format=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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/sidebar/list.md b/commands/sidebar/list.md index e153e6d3..9816987c 100644 --- a/commands/sidebar/list.md +++ b/commands/sidebar/list.md @@ -6,6 +6,9 @@ Lists registered sidebars. See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. +[\--inactive] +: If set, only inactive sidebars will be listed. + [\--fields=<fields>] : Limit the output to specific object fields. @@ -45,6 +48,10 @@ These fields are optionally available: "Widget Area",sidebar-1 "Inactive Widgets",wp_inactive_widgets + $ wp sidebar list --inactive --fields=id --format=csv + id + old-sidebar-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. @@ -54,6 +61,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -66,3 +74,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site-health.md b/commands/site-health.md new file mode 100644 index 00000000..96565622 --- /dev/null +++ b/commands/site-health.md @@ -0,0 +1,7 @@ +# wp site-health + +Manage Site Health + + + + diff --git a/commands/site-health/check.md b/commands/site-health/check.md new file mode 100644 index 00000000..537c4b4f --- /dev/null +++ b/commands/site-health/check.md @@ -0,0 +1,61 @@ +# wp site-health check + +Run site health checks. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--<field>=<value>] +: Filter results based on the value of a field. + +[\--fields=<fields>] +: Limit the output to specific fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + # Run site health checks. + $ wp site-health check + +-------------------+-------------+-------------+----------------------------------------------------------+ + | check | type | status | label | + +-------------------+-------------+-------------+----------------------------------------------------------+ + | WordPress Version | Performance | good | Your version of WordPress (6.5.2) is up to date | + | Plugin Versions | Security | recommended | You should remove inactive plugins | + | Theme Versions | Security | recommended | You should remove inactive themes | + | PHP Version | Performance | good | Your site is running the current version of PHP (8.2.18) | + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site-health/info.md b/commands/site-health/info.md new file mode 100644 index 00000000..36e819f2 --- /dev/null +++ b/commands/site-health/info.md @@ -0,0 +1,67 @@ +# wp site-health info + +Displays site health info. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[<section>] +: Section slug. + +[\--all] +: Displays info for all sections. + +[\--fields=<fields>] +: Limit the output to specific fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +[\--private] +: Display private fields. Disabled by default. + +### EXAMPLES + + # List site health info. + $ wp site-health info wp-constants + +---------------------+---------------------+-----------+-----------+ + | field | label | value | debug | + +---------------------+---------------------+-----------+-----------+ + | WP_HOME | WP_HOME | Undefined | undefined | + | WP_SITEURL | WP_SITEURL | Undefined | undefined | + | WP_MEMORY_LIMIT | WP_MEMORY_LIMIT | 40M | | + | WP_MAX_MEMORY_LIMIT | WP_MAX_MEMORY_LIMIT | 256M | | + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site-health/list-info-sections.md b/commands/site-health/list-info-sections.md new file mode 100644 index 00000000..05853898 --- /dev/null +++ b/commands/site-health/list-info-sections.md @@ -0,0 +1,69 @@ +# wp site-health list-info-sections + +List site health info sections. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--fields=<fields>] +: Limit the output to specific fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + # List site health info sections. + $ wp site-health list-info-sections + +------------------------+---------------------+ + | label | section | + +------------------------+---------------------+ + | WordPress | wp-core | + | Directories and Sizes | wp-paths-sizes | + | Drop-ins | wp-dropins | + | Active Theme | wp-active-theme | + | Parent Theme | wp-parent-theme | + | Inactive Themes | wp-themes-inactive | + | Must Use Plugins | wp-mu-plugins | + | Active Plugins | wp-plugins-active | + | Inactive Plugins | wp-plugins-inactive | + | Media Handling | wp-media | + | Server | wp-server | + | Database | wp-database | + | WordPress Constants | wp-constants | + | Filesystem Permissions | wp-filesystem | + +------------------------+---------------------+ + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site-health/status.md b/commands/site-health/status.md new file mode 100644 index 00000000..bffdf8ce --- /dev/null +++ b/commands/site-health/status.md @@ -0,0 +1,34 @@ +# wp site-health status + +Check site health status. + +### EXAMPLES + + # Check site health status. + $ wp site-health status + good + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/activate.md b/commands/site/activate.md index 714df061..03603ef7 100644 --- a/commands/site/activate.md +++ b/commands/site/activate.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/archive.md b/commands/site/archive.md index 2f9d71e4..5e34c673 100644 --- a/commands/site/archive.md +++ b/commands/site/archive.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/create.md b/commands/site/create.md index 682eb49a..d520dd4a 100644 --- a/commands/site/create.md +++ b/commands/site/create.md @@ -6,8 +6,11 @@ Creates a site in a multisite installation. See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. -\--slug=<slug> -: Path for the new site. Subdomain on subdomain installs, directory on subdirectory installs. +[\--slug=<slug>] +: Path for the new site. Subdomain on subdomain installs, directory on subdirectory installs. Required if --site-url is not provided. + +[\--site-url=<url>] +: Full URL for the new site. Use this to specify a custom domain instead of the auto-generated one. For subdomain installs, this allows you to use a different base domain (e.g., 'http://site.example.com' instead of 'http://site.main.example.com'). For subdirectory installs, this allows you to use a different path. If provided, --slug is optional and will be derived from the URL. If both --slug and --site-url are provided, --slug will be used as the base for internal operations (like user creation), while the domain/path from --site-url will be used for the actual site URL. [\--title=<title>] : Title of the new site. Default: prettified slug. @@ -26,9 +29,18 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg ### EXAMPLES + # Create a site with auto-generated domain $ wp site create --slug=example Success: Site 3 created: http://www.example.com/example/ + # Create a site with a custom domain (subdomain multisite) + $ wp site create --site-url=http://site.example.com + Success: Site 4 created: http://site.example.com/ + + # Create a site with a custom subdirectory (subdirectory multisite) + $ wp site create --site-url=http://example.com/custom/path/ + Success: Site 5 created: http://example.com/custom/path/ + ### 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. @@ -38,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/deactivate.md b/commands/site/deactivate.md index 13c1444b..b9eba939 100644 --- a/commands/site/deactivate.md +++ b/commands/site/deactivate.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/delete.md b/commands/site/delete.md index 73da1f05..90c8ff38 100644 --- a/commands/site/delete.md +++ b/commands/site/delete.md @@ -18,6 +18,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--keep-tables] : Delete the blog from the list, but don't drop its tables. +[\--delete-tables-with-prefix] +: Delete all tables with the site's database table prefix after deleting the site. + ### EXAMPLES $ wp site delete 123 @@ -33,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/empty.md b/commands/site/empty.md index e838b7aa..3552397a 100644 --- a/commands/site/empty.md +++ b/commands/site/empty.md @@ -1,10 +1,10 @@ # wp site empty -Empties a site of its content (posts, comments, terms, and meta). +Empties a site of its content (posts, comments, terms, links, and meta). -Truncates posts, comments, and terms tables to empty a site of its content. Doesn't affect site configuration (options) or users. +Truncates posts, comments, terms, and links tables to empty a site of its content. Doesn't affect site configuration (options) or users. -If running a persistent object cache, make sure to flush the cache after emptying the site, as the cache values will be invalid otherwise. +Flushes the object cache after emptying the site to ensure stale data is not served. On a Multisite installation, this will flush the cache for all sites. To also empty custom database tables, you'll need to hook into command execution: @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/generate.md b/commands/site/generate.md index bdc93a67..633ba7f2 100644 --- a/commands/site/generate.md +++ b/commands/site/generate.md @@ -50,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/get.md b/commands/site/get.md new file mode 100644 index 00000000..64527a49 --- /dev/null +++ b/commands/site/get.md @@ -0,0 +1,95 @@ +# wp site get + +Gets details about a site in a multisite installation. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<site> +: Site ID or URL of the site to get. For subdirectory sites, use the full URL (e.g., http://example.com/subdir/). + +[\--field=<field>] +: Instead of returning the whole site, returns the value of a single field. + +[\--fields=<fields>] +: Limit the output to specific fields. Defaults to all fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for the site: + +* blog_id +* url +* last_updated +* registered + +These fields are optionally available: + +* site_id +* domain +* path +* public +* archived +* mature +* spam +* deleted +* lang_id + +### EXAMPLES + + # Get site by ID + $ wp site get 1 + +---------+-------------------------+---------------------+---------------------+ + | blog_id | url | last_updated | registered | + +---------+-------------------------+---------------------+---------------------+ + | 1 | http://example.com/ | 2025-01-01 12:00:00 | 2025-01-01 12:00:00 | + +---------+-------------------------+---------------------+---------------------+ + + # Get site URL by site ID + $ wp site get 1 --field=url + http://example.com/ + + # Get site ID by URL + $ wp site get http://example.com/subdir/ --field=blog_id + 2 + + # Delete a site by URL + $ wp site delete $(wp site get http://example.com/subdir/ --field=blog_id) --yes + Success: The site at 'http://example.com/subdir/' was deleted. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/list.md b/commands/site/list.md index fe0f53e7..32cd354b 100644 --- a/commands/site/list.md +++ b/commands/site/list.md @@ -11,7 +11,8 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--<field>=<value>] : Filter by one or more fields (see "Available Fields" section). However, -'url' isn't an available filter, as it comes from 'home' in wp_options. +'url' isn't an available filter, as it comes from 'home' in wp_options. Note: '--path' conflicts with the global parameter of the same name; use +'--site-path' to filter by path instead. [\--site__in=<value>] : Only list the sites with these blog_id values (comma-separated). @@ -19,6 +20,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--site_user=<value>] : Only list the sites with this user. +[\--site-path=<path>] +: Filter by path. Avoids conflict with the global `--path` parameter. + [\--field=<field>] : Prints the value of a single field for each site. @@ -75,6 +79,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -87,3 +92,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/mature.md b/commands/site/mature.md index 553442cb..58c6d7c0 100644 --- a/commands/site/mature.md +++ b/commands/site/mature.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/add.md b/commands/site/meta/add.md index a6e4a779..9d663abf 100644 --- a/commands/site/meta/add.md +++ b/commands/site/meta/add.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/delete.md b/commands/site/meta/delete.md index eab65ebc..a235c600 100644 --- a/commands/site/meta/delete.md +++ b/commands/site/meta/delete.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/get.md b/commands/site/meta/get.md index fad17b90..bbe7cc69 100644 --- a/commands/site/meta/get.md +++ b/commands/site/meta/get.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/list.md b/commands/site/meta/list.md index 9fd48391..60039bcf 100644 --- a/commands/site/meta/list.md +++ b/commands/site/meta/list.md @@ -58,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -70,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/patch.md b/commands/site/meta/patch.md index 437637d3..7c79a997 100644 --- a/commands/site/meta/patch.md +++ b/commands/site/meta/patch.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/pluck.md b/commands/site/meta/pluck.md index a6dd9bb6..cf4c21f6 100644 --- a/commands/site/meta/pluck.md +++ b/commands/site/meta/pluck.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/set.md b/commands/site/meta/set.md index 5bdc7718..057fe5a6 100644 --- a/commands/site/meta/set.md +++ b/commands/site/meta/set.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/meta/update.md b/commands/site/meta/update.md index 5b16aacb..8eba7e56 100644 --- a/commands/site/meta/update.md +++ b/commands/site/meta/update.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/add.md b/commands/site/option/add.md index 403ab196..dbcd9486 100644 --- a/commands/site/option/add.md +++ b/commands/site/option/add.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/delete.md b/commands/site/option/delete.md index 6d42b3e4..6de121b5 100644 --- a/commands/site/option/delete.md +++ b/commands/site/option/delete.md @@ -23,6 +23,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -35,3 +36,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/get.md b/commands/site/option/get.md index 106ad002..5777ad74 100644 --- a/commands/site/option/get.md +++ b/commands/site/option/get.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/list.md b/commands/site/option/list.md index 80d872bd..82115ad5 100644 --- a/commands/site/option/list.md +++ b/commands/site/option/list.md @@ -63,6 +63,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -75,3 +76,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/patch.md b/commands/site/option/patch.md index a8556ec6..745ef31b 100644 --- a/commands/site/option/patch.md +++ b/commands/site/option/patch.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/pluck.md b/commands/site/option/pluck.md index a7651cf2..395b0acb 100644 --- a/commands/site/option/pluck.md +++ b/commands/site/option/pluck.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/set.md b/commands/site/option/set.md index 41f9ed8d..b4bb1751 100644 --- a/commands/site/option/set.md +++ b/commands/site/option/set.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/option/update.md b/commands/site/option/update.md index f140bad2..af210327 100644 --- a/commands/site/option/update.md +++ b/commands/site/option/update.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/private.md b/commands/site/private.md index a201896f..c6ea5c3a 100644 --- a/commands/site/private.md +++ b/commands/site/private.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/public.md b/commands/site/public.md index 6d7b08c9..dec101dd 100644 --- a/commands/site/public.md +++ b/commands/site/public.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/spam.md b/commands/site/spam.md index 49392f55..73edb733 100644 --- a/commands/site/spam.md +++ b/commands/site/spam.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/switch-language.md b/commands/site/switch-language.md index b3c44b90..3c370765 100644 --- a/commands/site/switch-language.md +++ b/commands/site/switch-language.md @@ -23,6 +23,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -35,3 +36,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/unarchive.md b/commands/site/unarchive.md index e1c3bf83..afb5c567 100644 --- a/commands/site/unarchive.md +++ b/commands/site/unarchive.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/unmature.md b/commands/site/unmature.md index 974c5399..3c8cc101 100644 --- a/commands/site/unmature.md +++ b/commands/site/unmature.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/site/unspam.md b/commands/site/unspam.md index adde5f6d..bf1026a3 100644 --- a/commands/site/unspam.md +++ b/commands/site/unspam.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/super-admin/add.md b/commands/super-admin/add.md index ff131782..dfc9a491 100644 --- a/commands/super-admin/add.md +++ b/commands/super-admin/add.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/super-admin/list.md b/commands/super-admin/list.md index 4170b80f..9c979d5f 100644 --- a/commands/super-admin/list.md +++ b/commands/super-admin/list.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/super-admin/remove.md b/commands/super-admin/remove.md index 42c0a5d2..5d7250f9 100644 --- a/commands/super-admin/remove.md +++ b/commands/super-admin/remove.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/taxonomy/get.md b/commands/taxonomy/get.md index e077cd7c..cd6d8615 100644 --- a/commands/taxonomy/get.md +++ b/commands/taxonomy/get.md @@ -69,6 +69,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -81,3 +82,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/taxonomy/list.md b/commands/taxonomy/list.md index 5214995b..000d2150 100644 --- a/commands/taxonomy/list.md +++ b/commands/taxonomy/list.md @@ -73,6 +73,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -85,3 +86,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term.md b/commands/term.md index 4ffb4829..1ff5611c 100644 --- a/commands/term.md +++ b/commands/term.md @@ -31,4 +31,9 @@ See reference for [taxonomies and their terms](https://wordpress.org/documentati Success: Updated category term count Success: Updated post_tag term count + # Prune terms with 0 or 1 published posts + $ wp term prune post_tag + Deleted post_tag 15. + Success: Pruned 1 of 5 terms. + diff --git a/commands/term/create.md b/commands/term/create.md index d3fe797b..8117d687 100644 --- a/commands/term/create.md +++ b/commands/term/create.md @@ -39,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -51,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/delete.md b/commands/term/delete.md index c4c46878..78463044 100644 --- a/commands/term/delete.md +++ b/commands/term/delete.md @@ -51,6 +51,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -63,3 +64,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/generate.md b/commands/term/generate.md index 10ad4dea..b92e90b2 100644 --- a/commands/term/generate.md +++ b/commands/term/generate.md @@ -53,6 +53,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -65,3 +66,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/get.md b/commands/term/get.md index 001eb9f5..82dd7b7b 100644 --- a/commands/term/get.md +++ b/commands/term/get.md @@ -57,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -69,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/list.md b/commands/term/list.md index 512fdfd7..00ab7b94 100644 --- a/commands/term/list.md +++ b/commands/term/list.md @@ -45,6 +45,7 @@ These fields will be displayed by default for each term: These fields are optionally available: +* term_group * url ### EXAMPLES @@ -77,6 +78,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -89,3 +91,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/add.md b/commands/term/meta/add.md index 1397a6b0..280f0e4c 100644 --- a/commands/term/meta/add.md +++ b/commands/term/meta/add.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/delete.md b/commands/term/meta/delete.md index 266a71ee..865c1918 100644 --- a/commands/term/meta/delete.md +++ b/commands/term/meta/delete.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/get.md b/commands/term/meta/get.md index 5acef1ff..86838305 100644 --- a/commands/term/meta/get.md +++ b/commands/term/meta/get.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/list.md b/commands/term/meta/list.md index 676917e5..3a844212 100644 --- a/commands/term/meta/list.md +++ b/commands/term/meta/list.md @@ -58,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -70,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/patch.md b/commands/term/meta/patch.md index 7fac4d0e..c5573b05 100644 --- a/commands/term/meta/patch.md +++ b/commands/term/meta/patch.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/pluck.md b/commands/term/meta/pluck.md index 03a78d6b..c23e443f 100644 --- a/commands/term/meta/pluck.md +++ b/commands/term/meta/pluck.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/set.md b/commands/term/meta/set.md index 5603dbb9..75221091 100644 --- a/commands/term/meta/set.md +++ b/commands/term/meta/set.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/meta/update.md b/commands/term/meta/update.md index 8767c3b0..63179f9d 100644 --- a/commands/term/meta/update.md +++ b/commands/term/meta/update.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/migrate.md b/commands/term/migrate.md index 72cb13a2..b96e0d9c 100644 --- a/commands/term/migrate.md +++ b/commands/term/migrate.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/prune.md b/commands/term/prune.md new file mode 100644 index 00000000..f2e7c2ef --- /dev/null +++ b/commands/term/prune.md @@ -0,0 +1,59 @@ +# wp term prune + +Removes terms with 0 or 1 published posts from one or more taxonomies. + +Useful for cleaning up large sites with many unused or barely-used terms. The term count is based on the number of published posts assigned to each term. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<taxonomy>... +: One or more taxonomies to prune. + +[\--dry-run] +: Preview the terms to be pruned, without actually deleting them. + +### EXAMPLES + + # Prune post tags with 0 or 1 published posts. + $ wp term prune post_tag + Deleted post_tag 15. + Success: Pruned 1 of 5 terms. + + # Dry run to preview which terms would be pruned. + $ wp term prune post_tag --dry-run + Would delete post_tag 15. + Success: 1 post_tag term would be pruned. + + # Prune multiple taxonomies at once. + $ wp term prune category post_tag + Deleted category 8. + Success: Pruned 1 of 3 terms. + Deleted post_tag 15. + Success: Pruned 1 of 5 terms. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/recount.md b/commands/term/recount.md index 830d3c60..d430181f 100644 --- a/commands/term/recount.md +++ b/commands/term/recount.md @@ -37,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -49,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/term/update.md b/commands/term/update.md index f3fc3f80..2c68078b 100644 --- a/commands/term/update.md +++ b/commands/term/update.md @@ -52,6 +52,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -64,3 +65,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/activate.md b/commands/theme/activate.md index 4ec67f84..80b3c935 100644 --- a/commands/theme/activate.md +++ b/commands/theme/activate.md @@ -23,6 +23,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -35,3 +36,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/auto-updates/disable.md b/commands/theme/auto-updates/disable.md index 1842ea80..11c896f7 100644 --- a/commands/theme/auto-updates/disable.md +++ b/commands/theme/auto-updates/disable.md @@ -31,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/auto-updates/enable.md b/commands/theme/auto-updates/enable.md index cfd173c4..778220cb 100644 --- a/commands/theme/auto-updates/enable.md +++ b/commands/theme/auto-updates/enable.md @@ -31,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/auto-updates/status.md b/commands/theme/auto-updates/status.md index f6c8ab13..cd650924 100644 --- a/commands/theme/auto-updates/status.md +++ b/commands/theme/auto-updates/status.md @@ -57,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -69,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/check-update.md b/commands/theme/check-update.md new file mode 100644 index 00000000..deee07bd --- /dev/null +++ b/commands/theme/check-update.md @@ -0,0 +1,71 @@ +# wp theme check-update + +Checks for theme updates without performing them. + +Lists the available theme updates. Similar to `wp core check-update`. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[<theme>...] +: One or more themes to check for updates. + +[\--all] +: If set, all themes will be checked for updates. + +[\--field=<field>] +: Prints the value of a single field for each update. + +[\--fields=<fields>] +: Limit the output to specific object fields. Defaults to name,status,version,update_version. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - yaml +\--- + +### EXAMPLES + + # Check for theme updates + $ wp theme check-update + +------------+----------+---------+----------------+ + | name | status | version | update_version | + +------------+----------+---------+----------------+ + | twentytwelve | inactive | 2.0 | 2.1 | + +------------+----------+---------+----------------+ + + # List themes with available updates in JSON format + $ wp theme check-update --format=json + [{"name":"twentytwelve","status":"inactive","version":"2.0","update_version":"2.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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/delete.md b/commands/theme/delete.md index 43c0dce9..f7c02857 100644 --- a/commands/theme/delete.md +++ b/commands/theme/delete.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/disable.md b/commands/theme/disable.md index 22e5fcdb..e1819708 100644 --- a/commands/theme/disable.md +++ b/commands/theme/disable.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/download.md b/commands/theme/download.md new file mode 100644 index 00000000..f775ff8d --- /dev/null +++ b/commands/theme/download.md @@ -0,0 +1,55 @@ +# wp theme download + +Downloads a theme zip package without loading WordPress. + +This command runs on the `before_wp_load` hook, just before the WP load process begins. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<slug> +: Slug of the theme to download. + +[\--target-path=<path>] +: Directory to store the downloaded zip file. Defaults to the current directory. + +[\--version=<version>] +: Version to download. Accepts a version number or `dev`. + +[\--force] +: Overwrite destination file if it already exists. + +[\--insecure] +: Retry download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. + +### EXAMPLES + + $ wp theme download twentytwelve + Downloading twentytwelve (1.3)... + Success: Downloaded theme package to /path/to/twentytwelve.1.3.zip + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/enable.md b/commands/theme/enable.md index e23816b3..5de10b3d 100644 --- a/commands/theme/enable.md +++ b/commands/theme/enable.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/get.md b/commands/theme/get.md index 29d305bf..f23d616e 100644 --- a/commands/theme/get.md +++ b/commands/theme/get.md @@ -46,6 +46,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -58,3 +59,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/install.md b/commands/theme/install.md index 0f6d297b..e449f164 100644 --- a/commands/theme/install.md +++ b/commands/theme/install.md @@ -7,7 +7,7 @@ Installs one or more themes. See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. <theme|zip|url>... -: One or more themes to install. Accepts a theme slug, the path to a local zip file, or a URL to a remote zip file. +: One or more themes to install. Accepts a theme slug, the path to a local zip file, a URL to a remote zip file, or a URL to a WordPress.org theme directory. [\--version=<version>] : If set, get that particular version from wordpress.org, instead of the stable version. @@ -24,6 +24,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--slug=<slug>] +: Use this as the target directory name when installing from a zip file. Cannot be used when installing multiple themes. + ### EXAMPLES # Install the latest version from wordpress.org and activate @@ -43,6 +46,16 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg # Install from a remote zip file $ wp theme install http://s3.amazonaws.com/bucketname/my-theme.zip?AWSAccessKeyId=123&Expires=456&Signature=abcdef + # Install from a WordPress.org theme directory URL + $ wp theme install https://wordpress.org/themes/twentysixteen/ + Detected WordPress.org themes directory URL, using slug: twentysixteen + Installing Twenty Sixteen (1.2) + Downloading install package from http://downloads.wordpress.org/theme/twentysixteen.1.2.zip... + Unpacking the package... + Installing the theme... + Theme installed successfully. + Success: Installed 1 of 1 themes. + ### 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. @@ -52,6 +65,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -64,3 +78,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/is-active.md b/commands/theme/is-active.md index 78854dcf..ec42ab7a 100644 --- a/commands/theme/is-active.md +++ b/commands/theme/is-active.md @@ -9,7 +9,7 @@ Returns exit code 0 when active, 1 when not active. See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. <theme> -: The plugin to check. +: The theme to check. ### EXAMPLES @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/is-installed.md b/commands/theme/is-installed.md index 7f759de5..3d6bfcd2 100644 --- a/commands/theme/is-installed.md +++ b/commands/theme/is-installed.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/list.md b/commands/theme/list.md index 9b458202..28dac137 100644 --- a/commands/theme/list.md +++ b/commands/theme/list.md @@ -27,7 +27,7 @@ options: - yaml \--- -[\--status=<status>] +[\--status=<status>...] : Filter the output by theme status. \--- options: @@ -49,6 +49,7 @@ These fields will be displayed by default for each theme: * version * update_version * auto_update +* type These fields are optionally available: @@ -56,14 +57,15 @@ These fields are optionally available: * update_id * title * description +* auto_update_indicated ### EXAMPLES # List inactive themes. $ wp theme list --status=inactive --format=csv - name,status,update,version,update_version,auto_update - twentyfourteen,inactive,none,3.8,,off - twentysixteen,inactive,available,3.0,3.1,off + name,status,update,version,update_version,auto_update,type + twentyfourteen,inactive,none,3.8,,off,classic + twentysixteen,inactive,available,3.0,3.1,off,classic ### GLOBAL PARAMETERS @@ -74,6 +76,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -86,3 +89,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/mod/get.md b/commands/theme/mod/get.md index e22bfa05..871d72c2 100644 --- a/commands/theme/mod/get.md +++ b/commands/theme/mod/get.md @@ -64,6 +64,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -76,3 +77,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/mod/list.md b/commands/theme/mod/list.md index d35afe2f..5021a860 100644 --- a/commands/theme/mod/list.md +++ b/commands/theme/mod/list.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/mod/remove.md b/commands/theme/mod/remove.md index 4e5a7565..2c65f4cb 100644 --- a/commands/theme/mod/remove.md +++ b/commands/theme/mod/remove.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/mod/set.md b/commands/theme/mod/set.md index 5a7d63d0..c5541dc6 100644 --- a/commands/theme/mod/set.md +++ b/commands/theme/mod/set.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/path.md b/commands/theme/path.md index b3c47ccc..9b5cda0c 100644 --- a/commands/theme/path.md +++ b/commands/theme/path.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/search.md b/commands/theme/search.md index 295e592c..5b0d87fb 100644 --- a/commands/theme/search.md +++ b/commands/theme/search.md @@ -74,6 +74,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -86,3 +87,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/status.md b/commands/theme/status.md index 123a49e9..1eb34b06 100644 --- a/commands/theme/status.md +++ b/commands/theme/status.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/uninstall.md b/commands/theme/uninstall.md index aeb40495..492883b0 100644 --- a/commands/theme/uninstall.md +++ b/commands/theme/uninstall.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/update.md b/commands/theme/update.md index d9d1e7aa..15729ab9 100644 --- a/commands/theme/update.md +++ b/commands/theme/update.md @@ -43,6 +43,12 @@ options: [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--auto-update-indicated] +: Only update themes where the server response indicates an automatic update. Updates to the version indicated by the server, not necessarily the latest version. Cannot be used with `--version`, `--minor`, or `--patch`. + +[\--include-vcs] +: Include themes that are version-controlled with a VCS (e.g. git, svn, hg). Skipped by default. + ### EXAMPLES # Update multiple themes @@ -97,6 +103,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -109,3 +116,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/theme/upgrade.md b/commands/theme/upgrade.md index 111f9f04..2719599d 100644 --- a/commands/theme/upgrade.md +++ b/commands/theme/upgrade.md @@ -43,6 +43,12 @@ options: [\--insecure] : Retry downloads without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack. +[\--auto-update-indicated] +: Only update themes where the server response indicates an automatic update. Updates to the version indicated by the server, not necessarily the latest version. Cannot be used with `--version`, `--minor`, or `--patch`. + +[\--include-vcs] +: Include themes that are version-controlled with a VCS (e.g. git, svn, hg). Skipped by default. + ### EXAMPLES # Update multiple themes @@ -97,6 +103,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -109,3 +116,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/transient/delete.md b/commands/transient/delete.md index b064f039..8eb17c4f 100644 --- a/commands/transient/delete.md +++ b/commands/transient/delete.md @@ -54,6 +54,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -66,3 +67,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/transient/get.md b/commands/transient/get.md index c7a314db..06320da8 100644 --- a/commands/transient/get.md +++ b/commands/transient/get.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/transient/list.md b/commands/transient/list.md index 064dee29..f116d843 100644 --- a/commands/transient/list.md +++ b/commands/transient/list.md @@ -66,6 +66,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -78,3 +79,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/transient/patch.md b/commands/transient/patch.md index bde287fc..dded1bb6 100644 --- a/commands/transient/patch.md +++ b/commands/transient/patch.md @@ -51,6 +51,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -63,3 +64,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/transient/pluck.md b/commands/transient/pluck.md index 3af524b7..c5e16a97 100644 --- a/commands/transient/pluck.md +++ b/commands/transient/pluck.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/transient/set.md b/commands/transient/set.md index 50ed0562..45fc35e0 100644 --- a/commands/transient/set.md +++ b/commands/transient/set.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/transient/type.md b/commands/transient/type.md index 1f480b2e..c11602fb 100644 --- a/commands/transient/type.md +++ b/commands/transient/type.md @@ -20,6 +20,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -32,3 +33,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/add-cap.md b/commands/user/add-cap.md index 3d1f7046..9963864b 100644 --- a/commands/user/add-cap.md +++ b/commands/user/add-cap.md @@ -31,6 +31,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -43,3 +44,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/add-role.md b/commands/user/add-role.md index 4b4ead51..43b12185 100644 --- a/commands/user/add-role.md +++ b/commands/user/add-role.md @@ -29,6 +29,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +42,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/application-password/create.md b/commands/user/application-password/create.md index 5e2bed53..91090471 100644 --- a/commands/user/application-password/create.md +++ b/commands/user/application-password/create.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/application-password/delete.md b/commands/user/application-password/delete.md index 537dc8c1..8426c169 100644 --- a/commands/user/application-password/delete.md +++ b/commands/user/application-password/delete.md @@ -34,6 +34,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -46,3 +47,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/application-password/exists.md b/commands/user/application-password/exists.md index 84f2be9d..7cae9079 100644 --- a/commands/user/application-password/exists.md +++ b/commands/user/application-password/exists.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/application-password/get.md b/commands/user/application-password/get.md index 4590752d..126bc2c0 100644 --- a/commands/user/application-password/get.md +++ b/commands/user/application-password/get.md @@ -48,6 +48,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -60,3 +61,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/application-password/list.md b/commands/user/application-password/list.md index aae5d839..51533690 100644 --- a/commands/user/application-password/list.md +++ b/commands/user/application-password/list.md @@ -73,6 +73,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -85,3 +86,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/application-password/record-usage.md b/commands/user/application-password/record-usage.md index a16afcfd..fcba73d9 100644 --- a/commands/user/application-password/record-usage.md +++ b/commands/user/application-password/record-usage.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/application-password/update.md b/commands/user/application-password/update.md index 92dbbf8a..8c5b61fb 100644 --- a/commands/user/application-password/update.md +++ b/commands/user/application-password/update.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/check-password.md b/commands/user/check-password.md index 80cb64ff..ade1d136 100644 --- a/commands/user/check-password.md +++ b/commands/user/check-password.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/create.md b/commands/user/create.md index e65a3448..70de9c75 100644 --- a/commands/user/create.md +++ b/commands/user/create.md @@ -71,6 +71,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -83,3 +84,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/delete.md b/commands/user/delete.md index 6d557ae3..93a34b90 100644 --- a/commands/user/delete.md +++ b/commands/user/delete.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/exists.md b/commands/user/exists.md index d408395d..6eff5dfe 100644 --- a/commands/user/exists.md +++ b/commands/user/exists.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/generate.md b/commands/user/generate.md index c07695fb..510774e3 100644 --- a/commands/user/generate.md +++ b/commands/user/generate.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/get.md b/commands/user/get.md index 5a0525dc..d4d0d7d9 100644 --- a/commands/user/get.md +++ b/commands/user/get.md @@ -44,6 +44,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -56,3 +57,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/import-csv.md b/commands/user/import-csv.md index e6582148..04045133 100644 --- a/commands/user/import-csv.md +++ b/commands/user/import-csv.md @@ -44,6 +44,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -56,3 +57,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/list-caps.md b/commands/user/list-caps.md index c875dac0..cb75c73c 100644 --- a/commands/user/list-caps.md +++ b/commands/user/list-caps.md @@ -50,6 +50,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -62,3 +63,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/list.md b/commands/user/list.md index 8c4a5566..8eae39ff 100644 --- a/commands/user/list.md +++ b/commands/user/list.md @@ -16,7 +16,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : Control output by one or more arguments of WP_User_Query(). [\--network] -: List all users in the network for multisite. +: List all users in the network for multisite. Roles are not included when using this flag, as users can have different roles on different sites in a multisite network. [\--field=<field>] : Prints the value of a single field for each user. @@ -90,6 +90,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -102,3 +103,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/add.md b/commands/user/meta/add.md index e9b99a33..11a43a2c 100644 --- a/commands/user/meta/add.md +++ b/commands/user/meta/add.md @@ -39,6 +39,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -51,3 +52,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/delete.md b/commands/user/meta/delete.md index a5cf57c8..66e5639c 100644 --- a/commands/user/meta/delete.md +++ b/commands/user/meta/delete.md @@ -30,6 +30,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -42,3 +43,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/get.md b/commands/user/meta/get.md index 5ab779ef..53377008 100644 --- a/commands/user/meta/get.md +++ b/commands/user/meta/get.md @@ -42,6 +42,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -54,3 +55,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/list.md b/commands/user/meta/list.md index 1e352bf5..7ddd21e1 100644 --- a/commands/user/meta/list.md +++ b/commands/user/meta/list.md @@ -70,6 +70,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -82,3 +83,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/patch.md b/commands/user/meta/patch.md index de5f71af..b1782a91 100644 --- a/commands/user/meta/patch.md +++ b/commands/user/meta/patch.md @@ -45,6 +45,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -57,3 +58,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/pluck.md b/commands/user/meta/pluck.md index 1d5b1818..4cce9f25 100644 --- a/commands/user/meta/pluck.md +++ b/commands/user/meta/pluck.md @@ -33,6 +33,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -45,3 +46,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/set.md b/commands/user/meta/set.md index 9f7ef42c..fb00da1f 100644 --- a/commands/user/meta/set.md +++ b/commands/user/meta/set.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/meta/update.md b/commands/user/meta/update.md index f4a7ff43..e10a1432 100644 --- a/commands/user/meta/update.md +++ b/commands/user/meta/update.md @@ -41,6 +41,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -53,3 +54,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/privacy-request.md b/commands/user/privacy-request.md new file mode 100644 index 00000000..dabe4115 --- /dev/null +++ b/commands/user/privacy-request.md @@ -0,0 +1,37 @@ +# wp user privacy-request + +Manages user privacy requests (GDPR personal data export and erasure). + +### EXAMPLES + + # List all privacy requests. + $ wp user privacy-request list + +----+-------------------+----------------------+-------------------+--------------------+ + | ID | user_email | action_name | status | created_timestamp | + +----+-------------------+----------------------+-------------------+--------------------+ + | 1 | bob@example.com | export_personal_data | request-pending | 1713779524 | + +----+-------------------+----------------------+-------------------+--------------------+ + + # Create a new data export request. + $ wp user privacy-request create bob@example.com export_personal_data + Success: Created privacy request 1. + + # Erase personal data for request 1. + $ wp user privacy-request erase 1 + Success: Erased personal data for request 1. + + # Export personal data for request 1. + $ wp user privacy-request export 1 + Success: Exported personal data to: /var/www/html/wp-content/uploads/wp-personal-data-exports/wp-personal-data-export-bob-example-com-1.zip + + # Mark request 1 as complete. + $ wp user privacy-request complete 1 + Success: Completed 1 of 1 privacy requests. + + # Delete request 1. + $ wp user privacy-request delete 1 + Success: Deleted 1 of 1 privacy requests. + + + + diff --git a/commands/user/privacy-request/complete.md b/commands/user/privacy-request/complete.md new file mode 100644 index 00000000..c6549bbb --- /dev/null +++ b/commands/user/privacy-request/complete.md @@ -0,0 +1,48 @@ +# wp user privacy-request complete + +Marks one or more privacy requests as completed. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<request-id>... +: One or more IDs of the privacy requests to complete. + +### EXAMPLES + + # Mark request 1 as completed. + $ wp user privacy-request complete 1 + Privacy request 1 completed. + Success: Completed 1 of 1 privacy requests. + + # Mark multiple requests as completed. + $ wp user privacy-request complete 1 2 + Privacy request 1 completed. + Privacy request 2 completed. + Success: Completed 2 of 2 privacy requests. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/privacy-request/create.md b/commands/user/privacy-request/create.md new file mode 100644 index 00000000..2fea653d --- /dev/null +++ b/commands/user/privacy-request/create.md @@ -0,0 +1,72 @@ +# wp user privacy-request create + +Creates a privacy request for a user. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<email> +: The email address of the user to create the request for. + +<action-type> +: The type of personal data request. +\--- +options: + - export_personal_data + - remove_personal_data +\--- + +[\--status=<status>] +: The initial status of the request. +\--- +default: pending +options: + - pending + - confirmed +\--- + +[\--send-email] +: If set, sends a confirmation email to the user. + +[\--porcelain] +: Output just the new request ID. + +### EXAMPLES + + # Create a new data export request with pending status. + $ wp user privacy-request create bob@example.com export_personal_data + Success: Created privacy request 1. + + # Create a confirmed data erasure request. + $ wp user privacy-request create bob@example.com remove_personal_data --status=confirmed + Success: Created privacy request 2. + + # Get just the new request ID. + $ wp user privacy-request create bob@example.com export_personal_data --porcelain + 3 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/privacy-request/delete.md b/commands/user/privacy-request/delete.md new file mode 100644 index 00000000..3b893b8c --- /dev/null +++ b/commands/user/privacy-request/delete.md @@ -0,0 +1,49 @@ +# wp user privacy-request delete + +Deletes one or more privacy requests. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<request-id>... +: One or more IDs of the privacy requests to delete. + +### EXAMPLES + + # Delete privacy request 1. + $ wp user privacy-request delete 1 + Privacy request 1 deleted. + Success: Deleted 1 of 1 privacy requests. + + # Delete multiple privacy requests. + $ wp user privacy-request delete 1 2 3 + Privacy request 1 deleted. + Privacy request 2 deleted. + Privacy request 3 deleted. + Success: Deleted 3 of 3 privacy requests. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/privacy-request/erase.md b/commands/user/privacy-request/erase.md new file mode 100644 index 00000000..feb25331 --- /dev/null +++ b/commands/user/privacy-request/erase.md @@ -0,0 +1,43 @@ +# wp user privacy-request erase + +Erases personal data for a given privacy request. + +Runs all registered data erasers for the email address associated with the request, then marks the request as completed. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<request-id> +: The ID of the remove_personal_data privacy request to process. + +### EXAMPLES + + # Erase personal data for request 1. + $ wp user privacy-request erase 1 + Success: Erased personal data for request 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/privacy-request/export.md b/commands/user/privacy-request/export.md new file mode 100644 index 00000000..7ee21725 --- /dev/null +++ b/commands/user/privacy-request/export.md @@ -0,0 +1,43 @@ +# wp user privacy-request export + +Exports personal data for a given privacy request. + +Runs all registered data exporters for the email address associated with the request, generates a ZIP file containing the data, then marks the request as completed. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<request-id> +: The ID of the export_personal_data privacy request to process. + +### EXAMPLES + + # Export personal data for request 1. + $ wp user privacy-request export 1 + Success: Exported personal data to: /var/www/html/wp-content/uploads/wp-personal-data-exports/wp-personal-data-export-bob-example-com-1.zip + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/privacy-request/list.md b/commands/user/privacy-request/list.md new file mode 100644 index 00000000..4757c412 --- /dev/null +++ b/commands/user/privacy-request/list.md @@ -0,0 +1,105 @@ +# wp user privacy-request list + +Lists privacy requests. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +[\--action-type=<action-type>] +: Filter the list by action type. +\--- +options: + - export_personal_data + - remove_personal_data +\--- + +[\--status=<status>] +: Filter the list by request status. +\--- +options: + - request-pending + - request-confirmed + - request-failed + - request-completed +\--- + +[\--field=<field>] +: Prints the value of a single field for each request. + +[\--fields=<fields>] +: Limit the output to specific object fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - ids + - json + - count + - yaml +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for each request: + +* ID +* user_email +* action_name +* status +* created_timestamp + +These fields are optionally available: + +* user_id +* confirmed_timestamp +* completed_timestamp + +### EXAMPLES + + # List all privacy requests. + $ wp user privacy-request list + +----+-------------------+----------------------+-------------------+--------------------+ + | ID | user_email | action_name | status | created_timestamp | + +----+-------------------+----------------------+-------------------+--------------------+ + | 1 | bob@example.com | export_personal_data | request-pending | 1713779524 | + +----+-------------------+----------------------+-------------------+--------------------+ + + # List only export requests. + $ wp user privacy-request list --action-type=export_personal_data + + # List only completed requests. + $ wp user privacy-request list --status=request-completed + + # List request IDs only. + $ wp user privacy-request list --format=ids + 1 2 + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/remove-cap.md b/commands/user/remove-cap.md index 77cb4a35..120da503 100644 --- a/commands/user/remove-cap.md +++ b/commands/user/remove-cap.md @@ -38,6 +38,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -50,3 +51,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/remove-role.md b/commands/user/remove-role.md index 7fa6d246..c1df4229 100644 --- a/commands/user/remove-role.md +++ b/commands/user/remove-role.md @@ -10,15 +10,23 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : User ID, user email, or user login. [<role>...] -: Remove the specified role(s) from the user. +: Remove the specified role(s) from the user. If not passed, all roles are removed from the user; on multisite, this removes the user from the current site/blog. ### EXAMPLES $ wp user remove-role 12 author - Success: Removed 'author' role for johndoe (12). + Success: Removed 'author' role from johndoe (12). $ wp user remove-role 12 author editor - Success: Removed 'author', 'editor' roles for johndoe (12). + Success: Removed 'author', 'editor' roles from johndoe (12). + + # On single-site: removes all roles from the user + $ wp user remove-role 12 + Success: Removed all roles from johndoe (12) on http://example.com. + + # On multisite: removes the user from the current site/blog + $ wp user remove-role 12 + Success: Removed johndoe (12) from http://example.com. ### GLOBAL PARAMETERS @@ -29,6 +37,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -41,3 +50,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/reset-password.md b/commands/user/reset-password.md index 7657ecc0..bb98b440 100644 --- a/commands/user/reset-password.md +++ b/commands/user/reset-password.md @@ -57,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -69,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/session/destroy.md b/commands/user/session/destroy.md index 12efe718..5e12d76c 100644 --- a/commands/user/session/destroy.md +++ b/commands/user/session/destroy.md @@ -43,6 +43,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -55,3 +56,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/session/list.md b/commands/user/session/list.md index 09bb1a04..7f743f94 100644 --- a/commands/user/session/list.md +++ b/commands/user/session/list.md @@ -58,6 +58,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -70,3 +71,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/set-role.md b/commands/user/set-role.md index d09425a4..cc551a5f 100644 --- a/commands/user/set-role.md +++ b/commands/user/set-role.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/signup/activate.md b/commands/user/signup/activate.md index 61c3ef3d..0ab5ba10 100644 --- a/commands/user/signup/activate.md +++ b/commands/user/signup/activate.md @@ -25,6 +25,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -37,3 +38,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/signup/delete.md b/commands/user/signup/delete.md index b93b90d1..a11b2f1d 100644 --- a/commands/user/signup/delete.md +++ b/commands/user/signup/delete.md @@ -28,6 +28,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -40,3 +41,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/signup/get.md b/commands/user/signup/get.md index 9ab5cdde..8a8530de 100644 --- a/commands/user/signup/get.md +++ b/commands/user/signup/get.md @@ -44,6 +44,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -56,3 +57,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/signup/list.md b/commands/user/signup/list.md index f8d36f58..0672f34c 100644 --- a/commands/user/signup/list.md +++ b/commands/user/signup/list.md @@ -74,6 +74,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -86,3 +87,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/spam.md b/commands/user/spam.md index 5cef02ae..22047c45 100644 --- a/commands/user/spam.md +++ b/commands/user/spam.md @@ -25,6 +25,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -37,3 +38,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/term/add.md b/commands/user/term/add.md index 978937f9..823ccd7d 100644 --- a/commands/user/term/add.md +++ b/commands/user/term/add.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/term/list.md b/commands/user/term/list.md index c5660670..fc30ba80 100644 --- a/commands/user/term/list.md +++ b/commands/user/term/list.md @@ -57,6 +57,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -69,3 +70,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/term/remove.md b/commands/user/term/remove.md index 72166707..454fda98 100644 --- a/commands/user/term/remove.md +++ b/commands/user/term/remove.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/term/set.md b/commands/user/term/set.md index 09e0f83e..2646ae35 100644 --- a/commands/user/term/set.md +++ b/commands/user/term/set.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/unspam.md b/commands/user/unspam.md index 270e25e9..bebb59e9 100644 --- a/commands/user/unspam.md +++ b/commands/user/unspam.md @@ -25,6 +25,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -37,3 +38,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/user/update.md b/commands/user/update.md index cd988c54..8dcccb93 100644 --- a/commands/user/update.md +++ b/commands/user/update.md @@ -66,6 +66,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -78,3 +79,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/add.md b/commands/widget/add.md index f600aad1..2bf43f86 100644 --- a/commands/widget/add.md +++ b/commands/widget/add.md @@ -35,6 +35,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -47,3 +48,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/deactivate.md b/commands/widget/deactivate.md index c77f6144..0c17cdaa 100644 --- a/commands/widget/deactivate.md +++ b/commands/widget/deactivate.md @@ -26,6 +26,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -38,3 +39,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/delete.md b/commands/widget/delete.md index a7f93b34..a9851f30 100644 --- a/commands/widget/delete.md +++ b/commands/widget/delete.md @@ -24,6 +24,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -36,3 +37,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/list.md b/commands/widget/list.md index 967fed76..2ed2b0f2 100644 --- a/commands/widget/list.md +++ b/commands/widget/list.md @@ -52,6 +52,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -64,3 +65,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/move.md b/commands/widget/move.md index ebeeade6..1544d677 100644 --- a/commands/widget/move.md +++ b/commands/widget/move.md @@ -36,6 +36,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -48,3 +49,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/patch.md b/commands/widget/patch.md new file mode 100644 index 00000000..8fbd06a9 --- /dev/null +++ b/commands/widget/patch.md @@ -0,0 +1,73 @@ +# wp widget patch + +Updates a nested value in a widget's options. + +### OPTIONS + +See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. + +<action> +: Patch action to perform. +\--- +options: + - insert + - update + - delete +\--- + +<widget-id> +: Unique ID for the widget. + +<key-path>... +: The name(s) of the keys within the value to locate the value to patch. + +[<value>] +: The new value. If omitted, the value is read from STDIN. + +[\--format=<format>] +: The serialization format for the value. +\--- +default: plaintext +options: + - plaintext + - json +\--- + +### EXAMPLES + + # Update a nested value in the options of the archives-1 widget + $ wp widget patch update archives-1 title "My Archives" + Success: Widget updated. + + # Insert a new nested value into the options of the archives-1 widget + $ wp widget patch insert archives-1 new_key "New Value" + Success: Widget updated. + + # Delete a nested value from the options of the archives-1 widget + $ wp widget patch delete archives-1 title + Success: Widget updated. + +### 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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | +| `--http=` | Perform operation against a remote WordPress installation 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). | +| `--exec=` | Execute PHP code before running the command (may be used more than once). | +| `--context=` | Load WordPress in a given context. | +| `--[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. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/reset.md b/commands/widget/reset.md index cc1cc63e..6f3b1bae 100644 --- a/commands/widget/reset.md +++ b/commands/widget/reset.md @@ -14,22 +14,29 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--all] : If set, all sidebars will be reset. +[\--inactive] +: If set, all inactive sidebars will also be reset, in addition to any sidebars specified via <sidebar-id>... or selected with --all. + ### EXAMPLES # Reset a sidebar $ wp widget reset sidebar-1 - Success: Sidebar 'sidebar-1' reset. + Sidebar 'sidebar-1' reset. # Reset multiple sidebars $ wp widget reset sidebar-1 sidebar-2 - Success: Sidebar 'sidebar-1' reset. - Success: Sidebar 'sidebar-2' reset. + Sidebar 'sidebar-1' reset. + Sidebar 'sidebar-2' reset. # Reset all sidebars $ wp widget reset --all - Success: Sidebar 'sidebar-1' reset. - Success: Sidebar 'sidebar-2' reset. - Success: Sidebar 'sidebar-3' reset. + Sidebar 'sidebar-1' reset. + Sidebar 'sidebar-2' reset. + Sidebar 'sidebar-3' reset. + + # Reset all inactive sidebars + $ wp widget reset --inactive + Sidebar 'old-sidebar-1' reset. ### GLOBAL PARAMETERS @@ -40,6 +47,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -52,3 +60,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/commands/widget/update.md b/commands/widget/update.md index 32e43a1b..fad7f480 100644 --- a/commands/widget/update.md +++ b/commands/widget/update.md @@ -27,6 +27,7 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--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", "docker-compose-run", "vagrant"). | +| `--ssh-args=` | Pass additional arguments to SSH (or other tools specified by --ssh scheme). | | `--http=` | Perform operation against a remote WordPress installation 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. | @@ -39,3 +40,5 @@ These [global parameters](https://make.wordpress.org/cli/handbook/config/) have | `--debug[=]` | Show all PHP errors and add verbosity to WP-CLI output. Built-in groups include: bootstrap, commandfactory, and help. | | `--prompt[=]` | Prompt the user to enter values for all command arguments, or a subset specified as comma-separated values. | | `--quiet` | Suppress informational messages. | +| `--alias=` | Name of the alias to use. Aliases can reference local WordPress installations or remote SSH connections. Aliases are defined in the wp-cli.yml file. | +| `--assume-https` | Set $_SERVER['HTTPS'] to make WordPress treat the site as HTTPS. Use when WordPress is behind an HTTPS proxy or load balancer. | diff --git a/internal-api.md b/internal-api.md index c42b3347..f850b516 100644 --- a/internal-api.md +++ b/internal-api.md @@ -131,6 +131,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\is_stream() - Check if a path is a PHP stream URL.
    • + +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • diff --git a/internal-api/wp-cli-error-multi-line.md b/internal-api/wp-cli-error-multi-line.md index f5437cf1..256a75e4 100644 --- a/internal-api/wp-cli-error-multi-line.md +++ b/internal-api/wp-cli-error-multi-line.md @@ -9,7 +9,7 @@ Display a multi-line error message in a red box. Doesn't exit script. WP_CLI::error_multi_line( $message_lines )
    -$message_lines (array) Multi-line error message to be displayed.
    +$message_lines (array<string|\WP_Error|\Exception|\Throwable>) Multi-line error message to be displayed.
    diff --git a/internal-api/wp-cli-error.md b/internal-api/wp-cli-error.md index 9c379cff..b80523fc 100644 --- a/internal-api/wp-cli-error.md +++ b/internal-api/wp-cli-error.md @@ -10,7 +10,7 @@ Display error message prefixed with "Error: " and exit script.
    $message (string|WP_Error|Exception|Throwable) Message to write to STDERR.
    -$exit (boolean|integer) True defaults to exit(1).
    +$exit (boolean|int) True defaults to exit(1).
    @return (null)
    diff --git a/internal-api/wp-cli-get-php-binary.md b/internal-api/wp-cli-get-php-binary.md index e9edb746..cc6e03f0 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\is_stream() - Check if a path is a PHP stream URL.
    • + +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • diff --git a/internal-api/wp-cli-line.md b/internal-api/wp-cli-line.md index f7a081ee..4c01cc09 100644 --- a/internal-api/wp-cli-line.md +++ b/internal-api/wp-cli-line.md @@ -6,10 +6,11 @@ Display informational message without prefix, and ignore `--quiet`. ## Usage - WP_CLI::line( $message = '' ) + WP_CLI::line( $message = '', $newline = true )
    $message (string) Message to display to the end user.
    +$newline (bool) Optional. Whether to append a newline to the end of the message. Default true.
    @return (void)
    diff --git a/internal-api/wp-cli-log.md b/internal-api/wp-cli-log.md index 256275c3..8c7d5b3a 100644 --- a/internal-api/wp-cli-log.md +++ b/internal-api/wp-cli-log.md @@ -6,10 +6,11 @@ Display informational message without prefix. ## Usage - WP_CLI::log( $message ) + WP_CLI::log( $message, $newline = true )
    $message (string) Message to write to STDOUT.
    +$newline (bool) Optional. Whether to append a newline to the end of the message. Default true.
    diff --git a/internal-api/wp-cli-utils-get-home-dir.md b/internal-api/wp-cli-utils-get-home-dir.md index 43baf242..7351d880 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\is_stream() - Check if a path is a PHP stream URL.
    • + +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • diff --git a/internal-api/wp-cli-utils-get-php-binary.md b/internal-api/wp-cli-utils-get-php-binary.md index a16dc3b6..edaf258a 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\is_stream() - Check if a path is a PHP stream URL.
    • + +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • diff --git a/internal-api/wp-cli-utils-get-temp-dir.md b/internal-api/wp-cli-utils-get-temp-dir.md index 38f05cce..729b086a 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\is_stream() - Check if a path is a PHP stream URL.
    • + +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.
    • diff --git a/internal-api/wp-cli-utils-http-request.md b/internal-api/wp-cli-utils-http-request.md index 44909c53..65f5b71c 100644 --- a/internal-api/wp-cli-utils-http-request.md +++ b/internal-api/wp-cli-utils-http-request.md @@ -13,7 +13,7 @@ Make a HTTP request to a remote URL. $url (string) URL to make the HTTP request to.
    $data (array|null) Data to send either as a query string for GET/HEAD requests,
    or in the body for POST requests.
    $headers (array) Add specific headers to the request.
    -$options (array) {
    Optional. An associative array of additional request options.
    @type bool $halt_on_error Whether or not command execution should be halted on error. Default: true
    @type bool|string $verify A boolean to use enable/disable SSL verification
    or string absolute path to CA cert to use.
    Defaults to detected CA cert bundled with the Requests library.
    @type bool $insecure Whether to retry automatically without certificate validation.
    }
    +$options (array) {
    Optional. An associative array of additional request options.
    @type bool $halt_on_error Whether or not command execution should be halted on error. Default: true
    @type bool|string $verify A boolean to use enable/disable SSL verification
    or string absolute path to CA cert to use.
    Defaults to detected CA cert bundled with the Requests library.
    @type bool $insecure Whether to retry automatically without certificate validation.
    @type int $max_retries Maximum number of retries of failed requests. Default 3.
    }
    @return (\Requests_Response|Response)
    diff --git a/internal-api/wp-cli-utils-is-stream.md b/internal-api/wp-cli-utils-is-stream.md new file mode 100644 index 00000000..7d548042 --- /dev/null +++ b/internal-api/wp-cli-utils-is-stream.md @@ -0,0 +1,49 @@ +# WP_CLI\Utils\is_stream() + +Check if a path is a PHP stream URL. + +*** + +## Usage + + WP_CLI\Utils\is_stream( $path ) + +
    +$path (string) The resource path or URL.
    +@return (bool) if the path is a PHP stream URL, false otherwise.
    +
    + + +*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-normalize-path.md b/internal-api/wp-cli-utils-normalize-path.md index f0a88103..fea3743c 100644 --- a/internal-api/wp-cli-utils-normalize-path.md +++ b/internal-api/wp-cli-utils-normalize-path.md @@ -23,6 +23,7 @@ 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. +Allows for PHP file wrappers. *Internal API documentation is generated from the WP-CLI codebase on every release. To suggest improvements, please submit a pull request.* @@ -42,6 +43,9 @@ Ensures upper-case drive letters on Windows systems.
  • WP_CLI\Utils\trailingslashit() - Appends a trailing slash.
    • +
  • WP_CLI\Utils\is_stream() - Check if a path is a PHP stream URL.
    • + +
  • 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-proc-open-compat.md b/internal-api/wp-cli-utils-proc-open-compat.md index b65723f5..a4492a6e 100644 --- a/internal-api/wp-cli-utils-proc-open-compat.md +++ b/internal-api/wp-cli-utils-proc-open-compat.md @@ -14,7 +14,7 @@ Windows compatible `proc_open()`. Works around bug in PHP, and also deals with * resource> (array<int,) &$pipes Indexed array of file pointers that correspond to PHP's end of any pipes that are created.
    $cwd (string) Initial working directory for the command.
    string> (array<string,) $env Array of environment variables.
    -$other_options (array<string>) Array of additional options (Windows only).
    +bool>|null (array<string,) $other_options Array of additional options (Windows only).
    array<int, (@param-out) resource> $pipes
    @return (resource|false) stripped of any environment variable settings, or false on failure.
    diff --git a/internal-api/wp-cli-utils-trailingslashit.md b/internal-api/wp-cli-utils-trailingslashit.md index 0e2a2c0e..2d09eb94 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\is_stream() - Check if a path is a PHP stream URL.
    • + +
  • WP_CLI\Utils\normalize_path() - Normalize a filesystem path.