diff --git a/bin/commands-manifest.json b/bin/commands-manifest.json index 00077b5e..03e8e709 100644 --- a/bin/commands-manifest.json +++ b/bin/commands-manifest.json @@ -5,7 +5,8 @@ "cmd_path": "ability", "parent": null, "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "admin": { "title": "admin", @@ -21,7 +22,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "block": { "title": "block", @@ -29,7 +31,8 @@ "cmd_path": "block", "parent": null, "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "cache": { "title": "cache", @@ -77,7 +80,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "core": { "title": "core", @@ -157,7 +161,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "help": { "title": "help", @@ -175,6 +180,15 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/i18n.md", "repo_url": "https:\/\/github.com\/wp-cli\/i18n-command" }, + "icon": { + "title": "icon", + "slug": "icon", + "cmd_path": "icon", + "parent": null, + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, "import": { "title": "import", "slug": "import", @@ -333,7 +347,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command", + "unreleased": true }, "site": { "title": "site", @@ -405,7 +420,8 @@ "cmd_path": "ability\/can-run", "parent": "ability", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/can-run.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/category": { "title": "ability category", @@ -413,7 +429,8 @@ "cmd_path": "ability\/category", "parent": "ability", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/category.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/exists": { "title": "ability exists", @@ -421,7 +438,8 @@ "cmd_path": "ability\/exists", "parent": "ability", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/exists.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/get": { "title": "ability get", @@ -429,7 +447,8 @@ "cmd_path": "ability\/get", "parent": "ability", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/list": { "title": "ability list", @@ -437,7 +456,8 @@ "cmd_path": "ability\/list", "parent": "ability", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/run": { "title": "ability run", @@ -445,7 +465,8 @@ "cmd_path": "ability\/run", "parent": "ability", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/run.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/validate": { "title": "ability validate", @@ -453,7 +474,8 @@ "cmd_path": "ability\/validate", "parent": "ability", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/validate.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ai\/check": { "title": "ai check", @@ -461,7 +483,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "ai\/generate": { "title": "ai generate", @@ -469,7 +492,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "ai\/is-supported": { "title": "ai is-supported", @@ -477,7 +501,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "ai\/status": { "title": "ai status", @@ -485,7 +510,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "block\/binding": { "title": "block binding", @@ -493,7 +519,8 @@ "cmd_path": "block\/binding", "parent": "block", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/binding.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/pattern-category": { "title": "block pattern-category", @@ -501,7 +528,8 @@ "cmd_path": "block\/pattern-category", "parent": "block", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/pattern-category.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/pattern": { "title": "block pattern", @@ -509,7 +537,8 @@ "cmd_path": "block\/pattern", "parent": "block", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/pattern.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/style": { "title": "block style", @@ -517,7 +546,8 @@ "cmd_path": "block\/style", "parent": "block", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/style.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/synced-pattern": { "title": "block synced-pattern", @@ -525,7 +555,8 @@ "cmd_path": "block\/synced-pattern", "parent": "block", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/synced-pattern.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/template": { "title": "block template", @@ -533,7 +564,8 @@ "cmd_path": "block\/template", "parent": "block", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/template.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/type": { "title": "block type", @@ -541,7 +573,8 @@ "cmd_path": "block\/type", "parent": "block", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/type.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "cache\/add": { "title": "cache add", @@ -893,7 +926,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/config-command", + "unreleased": true }, "config\/create": { "title": "config create", @@ -981,7 +1015,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/config-command", + "unreleased": true }, "connectors\/get": { "title": "connectors get", @@ -989,7 +1024,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "connectors\/list": { "title": "connectors list", @@ -997,7 +1033,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/ai-command", + "unreleased": true }, "core\/check-update-db": { "title": "core check-update-db", @@ -1005,7 +1042,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/core-command", + "unreleased": true }, "core\/check-update": { "title": "core check-update", @@ -1305,7 +1343,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/face": { "title": "font face", @@ -1313,7 +1352,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/family": { "title": "font family", @@ -1321,7 +1361,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "i18n\/audit": { "title": "i18n audit", @@ -1329,7 +1370,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/i18n-command", + "unreleased": true }, "i18n\/make-json": { "title": "i18n make-json", @@ -1371,6 +1413,51 @@ "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/i18n\/update-po.md", "repo_url": "https:\/\/github.com\/wp-cli\/i18n-command" }, + "icon\/collection": { + "title": "icon collection", + "slug": "collection", + "cmd_path": "icon\/collection", + "parent": "icon", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/collection.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, + "icon\/get": { + "title": "icon get", + "slug": "get", + "cmd_path": "icon\/get", + "parent": "icon", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, + "icon\/is-registered": { + "title": "icon is-registered", + "slug": "is-registered", + "cmd_path": "icon\/is-registered", + "parent": "icon", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/is-registered.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, + "icon\/list": { + "title": "icon list", + "slug": "list", + "cmd_path": "icon\/list", + "parent": "icon", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, + "icon\/render": { + "title": "icon render", + "slug": "render", + "cmd_path": "icon\/render", + "parent": "icon", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/render.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, "language\/core": { "title": "language core", "slug": "core", @@ -1457,7 +1544,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/media-command", + "unreleased": true }, "media\/regenerate": { "title": "media regenerate", @@ -1473,7 +1561,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/media-command", + "unreleased": true }, "menu\/create": { "title": "menu create", @@ -1616,7 +1705,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/package-command", + "unreleased": true }, "package\/install": { "title": "package install", @@ -1632,7 +1722,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/package-command", + "unreleased": true }, "package\/list": { "title": "package list", @@ -1688,7 +1779,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command", + "unreleased": true }, "plugin\/deactivate": { "title": "plugin deactivate", @@ -1712,7 +1804,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command", + "unreleased": true }, "plugin\/get": { "title": "plugin get", @@ -1728,7 +1821,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command", + "unreleased": true }, "plugin\/install": { "title": "plugin install", @@ -1847,7 +1941,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/create": { "title": "post create", @@ -1903,7 +1998,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/has-blocks": { "title": "post has-blocks", @@ -1911,7 +2007,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/list": { "title": "post list", @@ -1935,7 +2032,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/term": { "title": "post term", @@ -2156,7 +2254,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/widget-command", + "unreleased": true }, "sidebar\/get": { "title": "sidebar get", @@ -2164,7 +2263,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/widget-command", + "unreleased": true }, "sidebar\/list": { "title": "sidebar list", @@ -2180,7 +2280,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command", + "unreleased": true }, "site-health\/info": { "title": "site-health info", @@ -2188,7 +2289,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command", + "unreleased": true }, "site-health\/list-info-sections": { "title": "site-health list-info-sections", @@ -2196,7 +2298,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command", + "unreleased": true }, "site-health\/status": { "title": "site-health status", @@ -2204,7 +2307,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/site-health-command", + "unreleased": true }, "site\/activate": { "title": "site activate", @@ -2268,7 +2372,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "site\/list": { "title": "site list", @@ -2460,7 +2565,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "term\/recount": { "title": "term recount", @@ -2500,7 +2606,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command", + "unreleased": true }, "theme\/delete": { "title": "theme delete", @@ -2524,7 +2631,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/extension-command", + "unreleased": true }, "theme\/enable": { "title": "theme enable", @@ -2794,7 +2902,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "user\/remove-cap": { "title": "user remove-cap", @@ -2922,7 +3031,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/widget-command", + "unreleased": true }, "widget\/reset": { "title": "widget reset", @@ -2946,7 +3056,8 @@ "cmd_path": "ability\/category\/exists", "parent": "ability\/category", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/category\/exists.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/category\/get": { "title": "ability category get", @@ -2954,7 +3065,8 @@ "cmd_path": "ability\/category\/get", "parent": "ability\/category", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/category\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "ability\/category\/list": { "title": "ability category list", @@ -2962,7 +3074,8 @@ "cmd_path": "ability\/category\/list", "parent": "ability\/category", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/ability\/category\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/ability-command" + "repo_url": "https:\/\/github.com\/wp-cli\/ability-command", + "unreleased": true }, "block\/binding\/get": { "title": "block binding get", @@ -2970,7 +3083,8 @@ "cmd_path": "block\/binding\/get", "parent": "block\/binding", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/binding\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/binding\/list": { "title": "block binding list", @@ -2978,7 +3092,8 @@ "cmd_path": "block\/binding\/list", "parent": "block\/binding", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/binding\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/pattern-category\/get": { "title": "block pattern-category get", @@ -2986,7 +3101,8 @@ "cmd_path": "block\/pattern-category\/get", "parent": "block\/pattern-category", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/pattern-category\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/pattern-category\/list": { "title": "block pattern-category list", @@ -2994,7 +3110,8 @@ "cmd_path": "block\/pattern-category\/list", "parent": "block\/pattern-category", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/pattern-category\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/pattern\/get": { "title": "block pattern get", @@ -3002,7 +3119,8 @@ "cmd_path": "block\/pattern\/get", "parent": "block\/pattern", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/pattern\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/pattern\/list": { "title": "block pattern list", @@ -3010,7 +3128,8 @@ "cmd_path": "block\/pattern\/list", "parent": "block\/pattern", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/pattern\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/style\/get": { "title": "block style get", @@ -3018,7 +3137,8 @@ "cmd_path": "block\/style\/get", "parent": "block\/style", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/style\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/style\/list": { "title": "block style list", @@ -3026,7 +3146,8 @@ "cmd_path": "block\/style\/list", "parent": "block\/style", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/style\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/synced-pattern\/create": { "title": "block synced-pattern create", @@ -3034,7 +3155,8 @@ "cmd_path": "block\/synced-pattern\/create", "parent": "block\/synced-pattern", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/synced-pattern\/create.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/synced-pattern\/delete": { "title": "block synced-pattern delete", @@ -3042,7 +3164,8 @@ "cmd_path": "block\/synced-pattern\/delete", "parent": "block\/synced-pattern", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/synced-pattern\/delete.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/synced-pattern\/get": { "title": "block synced-pattern get", @@ -3050,7 +3173,8 @@ "cmd_path": "block\/synced-pattern\/get", "parent": "block\/synced-pattern", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/synced-pattern\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/synced-pattern\/list": { "title": "block synced-pattern list", @@ -3058,7 +3182,8 @@ "cmd_path": "block\/synced-pattern\/list", "parent": "block\/synced-pattern", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/synced-pattern\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/synced-pattern\/update": { "title": "block synced-pattern update", @@ -3066,7 +3191,8 @@ "cmd_path": "block\/synced-pattern\/update", "parent": "block\/synced-pattern", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/synced-pattern\/update.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/template\/export": { "title": "block template export", @@ -3074,7 +3200,8 @@ "cmd_path": "block\/template\/export", "parent": "block\/template", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/template\/export.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/template\/get": { "title": "block template get", @@ -3082,7 +3209,8 @@ "cmd_path": "block\/template\/get", "parent": "block\/template", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/template\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/template\/list": { "title": "block template list", @@ -3090,7 +3218,8 @@ "cmd_path": "block\/template\/list", "parent": "block\/template", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/template\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/type\/exists": { "title": "block type exists", @@ -3098,7 +3227,8 @@ "cmd_path": "block\/type\/exists", "parent": "block\/type", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/type\/exists.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/type\/get": { "title": "block type get", @@ -3106,7 +3236,8 @@ "cmd_path": "block\/type\/get", "parent": "block\/type", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/type\/get.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "block\/type\/list": { "title": "block type list", @@ -3114,7 +3245,8 @@ "cmd_path": "block\/type\/list", "parent": "block\/type", "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/block\/type\/list.md", - "repo_url": "https:\/\/github.com\/wp-cli\/block-command" + "repo_url": "https:\/\/github.com\/wp-cli\/block-command", + "unreleased": true }, "cli\/alias\/add": { "title": "cli alias add", @@ -3345,7 +3477,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/collection\/is-registered": { "title": "font collection is-registered", @@ -3353,7 +3486,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/collection\/list-categories": { "title": "font collection list-categories", @@ -3361,7 +3495,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/collection\/list-families": { "title": "font collection list-families", @@ -3369,7 +3504,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/collection\/list": { "title": "font collection list", @@ -3377,7 +3513,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/face\/install": { "title": "font face install", @@ -3385,7 +3522,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "font\/family\/install": { "title": "font family install", @@ -3393,7 +3531,35 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, + "icon\/collection\/get": { + "title": "icon collection get", + "slug": "get", + "cmd_path": "icon\/collection\/get", + "parent": "icon\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/collection\/get.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, + "icon\/collection\/is-registered": { + "title": "icon collection is-registered", + "slug": "is-registered", + "cmd_path": "icon\/collection\/is-registered", + "parent": "icon\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/collection\/is-registered.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true + }, + "icon\/collection\/list": { + "title": "icon collection list", + "slug": "list", + "cmd_path": "icon\/collection\/list", + "parent": "icon\/collection", + "markdown_source": "https:\/\/github.com\/wp-cli\/handbook\/blob\/main\/commands\/icon\/collection\/list.md", + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "language\/core\/activate": { "title": "language core activate", @@ -3537,7 +3703,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "menu\/item\/add-post": { "title": "menu item add-post", @@ -3569,7 +3736,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "menu\/item\/list": { "title": "menu item list", @@ -3704,7 +3872,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/count": { "title": "post block count", @@ -3712,7 +3881,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/export": { "title": "post block export", @@ -3720,7 +3890,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/extract": { "title": "post block extract", @@ -3728,7 +3899,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/get": { "title": "post block get", @@ -3736,7 +3908,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/import": { "title": "post block import", @@ -3744,7 +3917,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/insert": { "title": "post block insert", @@ -3752,7 +3926,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/list": { "title": "post block list", @@ -3760,7 +3935,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/move": { "title": "post block move", @@ -3768,7 +3944,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/parse": { "title": "post block parse", @@ -3776,7 +3953,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/remove": { "title": "post block remove", @@ -3784,7 +3962,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/render": { "title": "post block render", @@ -3792,7 +3971,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/replace": { "title": "post block replace", @@ -3800,7 +3980,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/block\/update": { "title": "post block update", @@ -3808,7 +3989,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/meta\/add": { "title": "post meta add", @@ -3887,7 +4069,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/revision\/prune": { "title": "post revision prune", @@ -3895,7 +4078,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/revision\/restore": { "title": "post revision restore", @@ -3903,7 +4087,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "post\/term\/add": { "title": "post term add", @@ -4307,7 +4492,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "user\/privacy-request\/create": { "title": "user privacy-request create", @@ -4315,7 +4501,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "user\/privacy-request\/delete": { "title": "user privacy-request delete", @@ -4323,7 +4510,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "user\/privacy-request\/erase": { "title": "user privacy-request erase", @@ -4331,7 +4519,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "user\/privacy-request\/export": { "title": "user privacy-request export", @@ -4339,7 +4528,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "user\/privacy-request\/list": { "title": "user privacy-request list", @@ -4347,7 +4537,8 @@ "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" + "repo_url": "https:\/\/github.com\/wp-cli\/entity-command", + "unreleased": true }, "user\/session\/destroy": { "title": "user session destroy", diff --git a/commands/ability.md b/commands/ability.md index f6a11eec..7de6fc16 100644 --- a/commands/ability.md +++ b/commands/ability.md @@ -2,6 +2,8 @@ Lists, inspects, and executes abilities registered via the WordPress Abilities API. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + The Abilities API, introduced in WordPress 6.9, provides a standardized way to register and discover distinct units of functionality within a WordPress site. ### EXAMPLES @@ -17,7 +19,7 @@ The Abilities API, introduced in WordPress 6.9, provides a standardized way to r +---------------------------+----------------------+----------+------------------------------------------+ # Get details of a specific ability. - $ wp ability get core/get-site-info --fields=name,label,category,readonly,show_in_rest + $ wp ability get core/get-site-info --fields=name,label,category,readonly,public,show_in_rest +---------------+----------------------+ | Field | Value | +---------------+----------------------+ @@ -25,6 +27,7 @@ The Abilities API, introduced in WordPress 6.9, provides a standardized way to r | label | Get Site Information | | category | site | | readonly | 1 | + | public | 1 | | show_in_rest | 1 | +---------------+----------------------+ diff --git a/commands/ability/can-run.md b/commands/ability/can-run.md index b1e987c9..c9e12188 100644 --- a/commands/ability/can-run.md +++ b/commands/ability/can-run.md @@ -2,6 +2,8 @@ Checks if the current user can execute an ability. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Validates permissions without actually executing the ability. Exits with return code 0 if permitted, 1 if not. ### OPTIONS diff --git a/commands/ability/category.md b/commands/ability/category.md index 7a47880d..83fdcc6f 100644 --- a/commands/ability/category.md +++ b/commands/ability/category.md @@ -2,6 +2,8 @@ Lists and inspects ability categories registered via the WordPress Abilities API. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + The Abilities API, introduced in WordPress 6.9, uses categories to organize related abilities for better discoverability. ### EXAMPLES diff --git a/commands/ability/category/exists.md b/commands/ability/category/exists.md index 03c004f3..58739068 100644 --- a/commands/ability/category/exists.md +++ b/commands/ability/category/exists.md @@ -2,6 +2,8 @@ Checks whether an ability category is registered. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Exits with return code 0 if the category exists, 1 if it does not. ### OPTIONS diff --git a/commands/ability/category/get.md b/commands/ability/category/get.md index 51ca5c66..47bc4937 100644 --- a/commands/ability/category/get.md +++ b/commands/ability/category/get.md @@ -2,6 +2,8 @@ Gets details about a registered ability category. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/ability/category/list.md b/commands/ability/category/list.md index ce9cea79..f15355b0 100644 --- a/commands/ability/category/list.md +++ b/commands/ability/category/list.md @@ -2,6 +2,8 @@ Lists all registered ability categories. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/ability/exists.md b/commands/ability/exists.md index bf9253df..41696666 100644 --- a/commands/ability/exists.md +++ b/commands/ability/exists.md @@ -2,6 +2,8 @@ Checks whether an ability is registered. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Exits with return code 0 if the ability exists, 1 if it does not. ### OPTIONS diff --git a/commands/ability/get.md b/commands/ability/get.md index 46e1ab1f..83820bca 100644 --- a/commands/ability/get.md +++ b/commands/ability/get.md @@ -2,6 +2,8 @@ Gets details about a registered ability. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -28,6 +30,8 @@ options: ### AVAILABLE FIELDS +These fields will be displayed by default: + * name * label * category @@ -37,8 +41,17 @@ options: * readonly * destructive * idempotent +* public * show_in_rest +These fields are optionally available: + +* meta + +The `public` field reports the high-level client exposure flag as declared by the ability. As of WordPress 7.1 it seeds the default for channel-specific flags such as `show_in_rest`, which take precedence when set explicitly. On earlier versions the flag is stored but has no effect, so `public` and `show_in_rest` may disagree. + +The `meta` field renders the raw metadata as JSON. It is the only way to inspect channel-specific settings registered by plugins, such as `mcp`. + ### EXAMPLES # Get details of a specific ability. @@ -55,9 +68,14 @@ options: | readonly | 1 | | destructive | 0 | | idempotent | 1 | + | public | 1 | | show_in_rest | 1 | +---------------+----------------------+ + # Inspect channel-specific settings that have no field of their own. + $ wp ability get my-plugin/my-ability --field=meta + {"annotations":{"readonly":true,"destructive":false,"idempotent":null},"mcp":{"public":false},"show_in_rest":true,"public":true} + # Get ability as JSON. $ wp ability get core/get-site-info --format=json diff --git a/commands/ability/list.md b/commands/ability/list.md index 09952337..7f3d8cec 100644 --- a/commands/ability/list.md +++ b/commands/ability/list.md @@ -2,6 +2,8 @@ Lists all registered abilities. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -12,8 +14,11 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--namespace=<prefix>] : Filter abilities by namespace prefix (e.g., 'core' for 'core/*' abilities). -[\--show-in-rest=<bool>] -: Filter abilities by REST API exposure. +[\--public] +: Only list abilities flagged for client exposure. Pass --no-public to invert. + +[\--show-in-rest] +: Only list abilities exposed to the REST API. Pass --no-show-in-rest to invert. [\--field=<field>] : Prints the value of a single field for each ability. @@ -48,8 +53,11 @@ These fields are optionally available: * readonly * destructive * idempotent +* public * show_in_rest +The `public` field reports the high-level client exposure flag as declared by the ability. As of WordPress 7.1 it seeds the default for channel-specific flags such as `show_in_rest`, which take precedence when set explicitly. On earlier versions the flag is stored but has no effect, so `public` and `show_in_rest` may disagree. + ### EXAMPLES # List all abilities. @@ -68,7 +76,13 @@ These fields are optionally available: $ wp ability list --namespace=core # List abilities exposed to REST API. - $ wp ability list --show-in-rest=true + $ wp ability list --show-in-rest + + # List abilities meant to be available to clients. + $ wp ability list --public + + # Find abilities that opt out of REST despite being public. + $ wp ability list --public --no-show-in-rest # List abilities as JSON. $ wp ability list --format=json diff --git a/commands/ability/run.md b/commands/ability/run.md index 46996eab..4268c811 100644 --- a/commands/ability/run.md +++ b/commands/ability/run.md @@ -2,6 +2,8 @@ Executes a registered ability. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/ability/validate.md b/commands/ability/validate.md index eaa47912..77a4bd76 100644 --- a/commands/ability/validate.md +++ b/commands/ability/validate.md @@ -2,6 +2,8 @@ Validates input against an ability's schema. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Validates the input data without executing the ability. Useful for testing input before execution. ### OPTIONS diff --git a/commands/ai.md b/commands/ai.md index 676f2826..1f610273 100644 --- a/commands/ai.md +++ b/commands/ai.md @@ -2,6 +2,8 @@ Interacts with the WordPress AI Client for text and image generation. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### EXAMPLES # Check AI capabilities status diff --git a/commands/ai/check.md b/commands/ai/check.md index d5b5557a..50f6f7e3 100644 --- a/commands/ai/check.md +++ b/commands/ai/check.md @@ -2,6 +2,8 @@ Checks if a prompt is supported for generation. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/ai/generate.md b/commands/ai/generate.md index 0d2a7077..48942b69 100644 --- a/commands/ai/generate.md +++ b/commands/ai/generate.md @@ -2,6 +2,8 @@ Generates AI content. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/ai/is-supported.md b/commands/ai/is-supported.md index 0e2e4f23..d87b4045 100644 --- a/commands/ai/is-supported.md +++ b/commands/ai/is-supported.md @@ -2,6 +2,8 @@ Checks whether AI features are supported in the current environment. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Exits with code 0 if AI features are supported, or code 1 if they are not. ### EXAMPLES diff --git a/commands/ai/status.md b/commands/ai/status.md index 023ad80a..83bfc446 100644 --- a/commands/ai/status.md +++ b/commands/ai/status.md @@ -2,6 +2,8 @@ Checks which AI capabilities are currently supported. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Checks the environment and credentials to determine which AI operations are available. Displays a table showing supported capabilities. ### OPTIONS diff --git a/commands/block.md b/commands/block.md index 49770585..499ff938 100644 --- a/commands/block.md +++ b/commands/block.md @@ -2,6 +2,8 @@ Manages WordPress block editor blocks and related entities. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### EXAMPLES # List all registered block types diff --git a/commands/block/binding.md b/commands/block/binding.md index 53282bac..970bf37d 100644 --- a/commands/block/binding.md +++ b/commands/block/binding.md @@ -2,6 +2,8 @@ Retrieves details on registered block binding sources. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Get information on block binding sources from the WP_Block_Bindings_Registry. Block bindings allow dynamic data to be connected to block attributes. ### EXAMPLES diff --git a/commands/block/binding/get.md b/commands/block/binding/get.md index 644cb79a..e4741605 100644 --- a/commands/block/binding/get.md +++ b/commands/block/binding/get.md @@ -2,6 +2,8 @@ Gets details about a registered block binding source. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/binding/list.md b/commands/block/binding/list.md index 8e673829..568d72cc 100644 --- a/commands/block/binding/list.md +++ b/commands/block/binding/list.md @@ -2,6 +2,8 @@ Lists registered block binding sources. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/pattern-category.md b/commands/block/pattern-category.md index 1be58ffa..a6163dfb 100644 --- a/commands/block/pattern-category.md +++ b/commands/block/pattern-category.md @@ -2,6 +2,8 @@ Retrieves details on registered block pattern categories. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Get information on block pattern categories from the WP_Block_Pattern_Categories_Registry. ### EXAMPLES diff --git a/commands/block/pattern-category/get.md b/commands/block/pattern-category/get.md index 093910e0..1908fb9d 100644 --- a/commands/block/pattern-category/get.md +++ b/commands/block/pattern-category/get.md @@ -2,6 +2,8 @@ Gets details about a registered block pattern category. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/pattern-category/list.md b/commands/block/pattern-category/list.md index 342c598e..015595ea 100644 --- a/commands/block/pattern-category/list.md +++ b/commands/block/pattern-category/list.md @@ -2,6 +2,8 @@ Lists registered block pattern categories. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/pattern.md b/commands/block/pattern.md index b2159b96..1af0328c 100644 --- a/commands/block/pattern.md +++ b/commands/block/pattern.md @@ -2,6 +2,8 @@ Retrieves details on registered block patterns. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Get information on WordPress' built-in and custom block patterns from the WP_Block_Patterns_Registry. ### EXAMPLES diff --git a/commands/block/pattern/get.md b/commands/block/pattern/get.md index 28b316f7..36d9ef23 100644 --- a/commands/block/pattern/get.md +++ b/commands/block/pattern/get.md @@ -2,6 +2,8 @@ Gets details about a registered block pattern. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/pattern/list.md b/commands/block/pattern/list.md index 783789d3..31b8c021 100644 --- a/commands/block/pattern/list.md +++ b/commands/block/pattern/list.md @@ -2,6 +2,8 @@ Lists registered block patterns. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/style.md b/commands/block/style.md index eb79b266..381f8104 100644 --- a/commands/block/style.md +++ b/commands/block/style.md @@ -2,6 +2,8 @@ Retrieves details on registered block styles. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Get information on block style variations from the WP_Block_Styles_Registry. ### EXAMPLES diff --git a/commands/block/style/get.md b/commands/block/style/get.md index 34137915..ff5b8e97 100644 --- a/commands/block/style/get.md +++ b/commands/block/style/get.md @@ -2,6 +2,8 @@ Gets details about a registered block style. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/style/list.md b/commands/block/style/list.md index 80921c23..11b8a362 100644 --- a/commands/block/style/list.md +++ b/commands/block/style/list.md @@ -2,6 +2,8 @@ Lists registered block styles. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/synced-pattern.md b/commands/block/synced-pattern.md index 0429de43..1995327e 100644 --- a/commands/block/synced-pattern.md +++ b/commands/block/synced-pattern.md @@ -2,6 +2,8 @@ Manages synced patterns (reusable blocks). +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Synced patterns are stored as the 'wp_block' post type and can be either synced (changes reflect everywhere) or not synced (regular patterns). ### EXAMPLES diff --git a/commands/block/synced-pattern/create.md b/commands/block/synced-pattern/create.md index d0dbc2b0..3f01be72 100644 --- a/commands/block/synced-pattern/create.md +++ b/commands/block/synced-pattern/create.md @@ -2,6 +2,8 @@ Creates a synced pattern. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/synced-pattern/delete.md b/commands/block/synced-pattern/delete.md index 99773cb0..04f8a6ee 100644 --- a/commands/block/synced-pattern/delete.md +++ b/commands/block/synced-pattern/delete.md @@ -2,6 +2,8 @@ Deletes one or more synced patterns. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/synced-pattern/get.md b/commands/block/synced-pattern/get.md index 972317af..763fe07c 100644 --- a/commands/block/synced-pattern/get.md +++ b/commands/block/synced-pattern/get.md @@ -2,6 +2,8 @@ Gets details about a synced pattern. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/synced-pattern/list.md b/commands/block/synced-pattern/list.md index a8f4f204..839af043 100644 --- a/commands/block/synced-pattern/list.md +++ b/commands/block/synced-pattern/list.md @@ -2,6 +2,8 @@ Lists synced patterns. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/synced-pattern/update.md b/commands/block/synced-pattern/update.md index 957d273c..101ec0e8 100644 --- a/commands/block/synced-pattern/update.md +++ b/commands/block/synced-pattern/update.md @@ -2,6 +2,8 @@ Updates a synced pattern. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/template.md b/commands/block/template.md index c713c013..f7547809 100644 --- a/commands/block/template.md +++ b/commands/block/template.md @@ -2,6 +2,8 @@ Retrieves details on block templates and template parts. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Get information on block templates used in Full Site Editing (FSE) themes. ### EXAMPLES diff --git a/commands/block/template/export.md b/commands/block/template/export.md index 742ef9e5..109353ff 100644 --- a/commands/block/template/export.md +++ b/commands/block/template/export.md @@ -2,6 +2,8 @@ Exports a block template to a file. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/template/get.md b/commands/block/template/get.md index 3f959c1f..64bcc8f0 100644 --- a/commands/block/template/get.md +++ b/commands/block/template/get.md @@ -2,6 +2,8 @@ Gets details about a block template. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/template/list.md b/commands/block/template/list.md index 06696ed8..cae7c0bb 100644 --- a/commands/block/template/list.md +++ b/commands/block/template/list.md @@ -2,6 +2,8 @@ Lists block templates or template parts. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/type.md b/commands/block/type.md index 50969067..fb130de8 100644 --- a/commands/block/type.md +++ b/commands/block/type.md @@ -2,6 +2,8 @@ Retrieves details on registered block types. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Get information on WordPress' built-in and custom block types from the WP_Block_Type_Registry. ### EXAMPLES diff --git a/commands/block/type/exists.md b/commands/block/type/exists.md index 799ff373..c87b3e7e 100644 --- a/commands/block/type/exists.md +++ b/commands/block/type/exists.md @@ -2,6 +2,8 @@ Checks whether a block type is registered. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Exits with return code 0 if the block type exists, 1 if it does not. ### OPTIONS diff --git a/commands/block/type/get.md b/commands/block/type/get.md index 16baeb53..b8770acd 100644 --- a/commands/block/type/get.md +++ b/commands/block/type/get.md @@ -2,6 +2,8 @@ Gets details about a registered block type. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/block/type/list.md b/commands/block/type/list.md index 940bd616..693df385 100644 --- a/commands/block/type/list.md +++ b/commands/block/type/list.md @@ -2,6 +2,8 @@ Lists registered block types. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cache/flush-group.md b/commands/cache/flush-group.md index 5022f4e7..3d1b0239 100644 --- a/commands/cache/flush-group.md +++ b/commands/cache/flush-group.md @@ -2,6 +2,8 @@ Removes all cache items in a group, if the object cache implementation supports it. +Available since WP-CLI 2.8.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cache/patch.md b/commands/cache/patch.md index b13ffc9a..46a1a313 100644 --- a/commands/cache/patch.md +++ b/commands/cache/patch.md @@ -2,6 +2,10 @@ Update a nested value from the cache. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--expiration`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Available since WP-CLI 2.12.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cache/pluck.md b/commands/cache/pluck.md index 3576f4a5..3c21dfac 100644 --- a/commands/cache/pluck.md +++ b/commands/cache/pluck.md @@ -2,6 +2,8 @@ Get a nested value from the cache. +Available since WP-CLI 2.12.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cache/supports.md b/commands/cache/supports.md index a17c532c..1ca37331 100644 --- a/commands/cache/supports.md +++ b/commands/cache/supports.md @@ -2,6 +2,8 @@ Determines whether the object cache implementation supports a particular feature. +Available since WP-CLI 2.8.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cli/alias/get.md b/commands/cli/alias/get.md index 31ef8bec..2eee2e93 100644 --- a/commands/cli/alias/get.md +++ b/commands/cli/alias/get.md @@ -4,6 +4,8 @@ Gets the value for an alias. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--field`, `--raw`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cli/alias/is-group.md b/commands/cli/alias/is-group.md index fc50b92e..63beb03a 100644 --- a/commands/cli/alias/is-group.md +++ b/commands/cli/alias/is-group.md @@ -4,6 +4,8 @@ Check whether an alias is a group. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Available since WP-CLI 2.8.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cli/alias/list.md b/commands/cli/alias/list.md index 6ad9502e..b6dd29ff 100644 --- a/commands/cli/alias/list.md +++ b/commands/cli/alias/list.md @@ -4,6 +4,8 @@ Lists available WP-CLI aliases. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--raw`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cli/update.md b/commands/cli/update.md index a5dc422e..363cadfa 100644 --- a/commands/cli/update.md +++ b/commands/cli/update.md @@ -4,6 +4,8 @@ Updates WP-CLI to the latest release. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--insecure` (2.5.0). + Default behavior is to check the releases API for the newest stable version, and prompt if one is available. By default the update stays within the current major version: a new major release is not offered unless `--major` is passed. This prevents unintentionally accepting breaking changes. When no update within the current major is available, a newer major is announced along with the `--major` flag needed to install it. diff --git a/commands/comment/create.md b/commands/comment/create.md index 18d03554..e58badd7 100644 --- a/commands/comment/create.md +++ b/commands/comment/create.md @@ -6,6 +6,51 @@ Creates a new comment. See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. +[\--comment_agent=<comment_agent>] +: The HTTP user agent of the comment author. + +[\--comment_approved=<comment_approved>] +: Whether the comment has been approved. Default 1. + +[\--comment_author=<comment_author>] +: The name of the author of the comment. + +[\--comment_author_email=<comment_author_email>] +: The email address of the comment author. + +[\--comment_author_IP=<comment_author_IP>] +: The IP address of the comment author. + +[\--comment_author_url=<comment_author_url>] +: The URL address of the comment author. + +[\--comment_content=<comment_content>] +: The content of the comment. + +[\--comment_date=<yyyy-mm-dd-hh-ii-ss>] +: The date the comment was submitted. + +[\--comment_date_gmt=<yyyy-mm-dd-hh-ii-ss>] +: The date the comment was submitted in the GMT timezone. + +[\--comment_karma=<comment_karma>] +: The karma of the comment. Default 0. + +[\--comment_parent=<comment_parent>] +: ID of this comment's parent, if any. Default 0. + +[\--comment_post_ID=<comment_post_ID>] +: ID of the post that relates to the comment, if any. + +[\--comment_type=<comment_type>] +: Comment type. Default 'comment'. + +[\--comment_meta=<comment_meta>] +: Array in JSON format of comment meta values keyed by their comment meta key. + +[\--user_id=<user_id>] +: ID of the user who submitted the comment. Default 0. + [\--<field>=<value>] : Associative args for the new comment. See wp_insert_comment(). diff --git a/commands/comment/meta/get.md b/commands/comment/meta/get.md index 4f88604b..ac72dbe6 100644 --- a/commands/comment/meta/get.md +++ b/commands/comment/meta/get.md @@ -2,6 +2,8 @@ Get meta field value. +Options added later: `--single` (2.12.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/comment/update.md b/commands/comment/update.md index 9ac6f004..0ea7cfdd 100644 --- a/commands/comment/update.md +++ b/commands/comment/update.md @@ -9,6 +9,51 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg <id>... : One or more IDs of comments to update. +[\--comment_agent=<comment_agent>] +: The HTTP user agent of the comment author. + +[\--comment_approved=<comment_approved>] +: Whether the comment has been approved. + +[\--comment_author=<comment_author>] +: The name of the author of the comment. + +[\--comment_author_email=<comment_author_email>] +: The email address of the comment author. + +[\--comment_author_IP=<comment_author_IP>] +: The IP address of the comment author. + +[\--comment_author_url=<comment_author_url>] +: The URL address of the comment author. + +[\--comment_content=<comment_content>] +: The content of the comment. + +[\--comment_date=<yyyy-mm-dd-hh-ii-ss>] +: The date the comment was submitted. + +[\--comment_date_gmt=<yyyy-mm-dd-hh-ii-ss>] +: The date the comment was submitted in the GMT timezone. Note that wp_update_comment() always recalculates this from 'comment_date'. + +[\--comment_karma=<comment_karma>] +: The karma of the comment. + +[\--comment_parent=<comment_parent>] +: ID of this comment's parent, if any. + +[\--comment_post_ID=<comment_post_ID>] +: ID of the post that relates to the comment, if any. + +[\--comment_type=<comment_type>] +: Comment type. + +[\--comment_meta=<comment_meta>] +: Array in JSON format of comment meta values keyed by their comment meta key. + +[\--user_id=<user_id>] +: ID of the user who submitted the comment. + \--<field>=<value> : One or more fields to update. See wp_update_comment(). diff --git a/commands/config/add.md b/commands/config/add.md index 2e40a82f..98565f82 100644 --- a/commands/config/add.md +++ b/commands/config/add.md @@ -4,6 +4,8 @@ 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. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/create.md b/commands/config/create.md index e1074be8..eca5d2d3 100644 --- a/commands/config/create.md +++ b/commands/config/create.md @@ -2,6 +2,10 @@ Generates a wp-config.php file. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--db_password`, `--ssl`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--config-file` (2.6.0), `--insecure` (2.5.0). + Creates a new wp-config.php with database constants, and verifies that the database constants are correct. ### OPTIONS diff --git a/commands/config/delete.md b/commands/config/delete.md index 6764fe20..f068089e 100644 --- a/commands/config/delete.md +++ b/commands/config/delete.md @@ -4,6 +4,8 @@ Deletes a specific constant or variable from the wp-config.php file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--config-file` (2.6.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/edit.md b/commands/config/edit.md index f6132aee..a84737c1 100644 --- a/commands/config/edit.md +++ b/commands/config/edit.md @@ -4,6 +4,8 @@ Launches system editor to edit the wp-config.php file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--config-file` (2.6.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/get.md b/commands/config/get.md index 78f43aff..22b7d3c3 100644 --- a/commands/config/get.md +++ b/commands/config/get.md @@ -4,6 +4,8 @@ Gets the value of a specific constant or variable defined in wp-config.php file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--config-file` (2.6.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/has.md b/commands/config/has.md index 975609a7..4b0326ae 100644 --- a/commands/config/has.md +++ b/commands/config/has.md @@ -4,6 +4,8 @@ Checks whether a specific constant or variable exists in the wp-config.php file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--config-file` (2.6.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/is-true.md b/commands/config/is-true.md index 2d78d489..d9320b0a 100644 --- a/commands/config/is-true.md +++ b/commands/config/is-true.md @@ -4,6 +4,8 @@ Determines whether value of a specific defined constant or variable is truthy. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Available since WP-CLI 2.9.0. + This determination is made by evaluating the retrieved value via boolval(). ### OPTIONS diff --git a/commands/config/list.md b/commands/config/list.md index 1b331a3e..336cf70f 100644 --- a/commands/config/list.md +++ b/commands/config/list.md @@ -4,6 +4,8 @@ Lists variables, constants, and file includes defined in wp-config.php file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--config-file` (2.6.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/set.md b/commands/config/set.md index 3302d8a1..70a7e987 100644 --- a/commands/config/set.md +++ b/commands/config/set.md @@ -4,6 +4,8 @@ Sets the value of a specific constant or variable defined in wp-config.php file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--config-file` (2.6.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/shuffle-salts.md b/commands/config/shuffle-salts.md index 24e53b0f..a3761213 100644 --- a/commands/config/shuffle-salts.md +++ b/commands/config/shuffle-salts.md @@ -4,6 +4,8 @@ Refreshes the salts defined in the wp-config.php file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--force` (2.5.0), `--config-file` (2.6.0), `--insecure` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/config/update.md b/commands/config/update.md index 69ad7e9c..176ce3d1 100644 --- a/commands/config/update.md +++ b/commands/config/update.md @@ -4,6 +4,8 @@ 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. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + This command will add the constant or variable if it doesn't exist, or update it if it does. ### OPTIONS diff --git a/commands/connectors.md b/commands/connectors.md index 18f323bb..2eeab942 100644 --- a/commands/connectors.md +++ b/commands/connectors.md @@ -2,6 +2,8 @@ Lists and retrieves information about AI connectors. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### EXAMPLES # List all available connectors diff --git a/commands/connectors/get.md b/commands/connectors/get.md index 66fb591c..67b2d113 100644 --- a/commands/connectors/get.md +++ b/commands/connectors/get.md @@ -2,6 +2,8 @@ Gets details about a specific AI connector. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/connectors/list.md b/commands/connectors/list.md index 4c6e766b..5bf891db 100644 --- a/commands/connectors/list.md +++ b/commands/connectors/list.md @@ -2,6 +2,8 @@ Lists all available AI connectors. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/core/check-update-db.md b/commands/core/check-update-db.md index 14266d48..387586f2 100644 --- a/commands/core/check-update-db.md +++ b/commands/core/check-update-db.md @@ -2,6 +2,8 @@ Checks for the need for WordPress database updates. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Compares the current database version with the version required by WordPress core to determine if database updates are needed. ### OPTIONS diff --git a/commands/core/check-update.md b/commands/core/check-update.md index a1fb51a7..a2edfc85 100644 --- a/commands/core/check-update.md +++ b/commands/core/check-update.md @@ -2,6 +2,8 @@ Checks for WordPress updates via Version Check API. +Options added later: `--force-check` (2.10.0). + Lists the most recent versions when there are updates available, or success message when up to date. ### OPTIONS diff --git a/commands/core/download.md b/commands/core/download.md index b9c9a25c..98348d51 100644 --- a/commands/core/download.md +++ b/commands/core/download.md @@ -4,6 +4,10 @@ Downloads core WordPress files. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--skip-locale-check`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--insecure` (2.5.0), `--extract` (2.7.0). + Downloads and extracts WordPress core files to the specified path. Uses current directory when no path is specified. Downloaded build is verified to have the correct md5 and then cached to the local filesystem. Subsequent uses of command will use the local cache if it still exists. ### OPTIONS diff --git a/commands/core/install-network.md b/commands/core/install-network.md index 89088133..e1badd8d 100644 --- a/commands/core/install-network.md +++ b/commands/core/install-network.md @@ -4,6 +4,8 @@ Transforms an existing single-site installation into a multisite installation. This is an alias for `wp core multisite-convert`. +Options added later: `--skip-config` (2.8.0). + Creates the multisite database tables, and adds the multisite constants to wp-config.php. For those using WordPress with Apache, remember to update the `.htaccess` file with the appropriate multisite rewrite rules. diff --git a/commands/core/install.md b/commands/core/install.md index 8bff93c5..69cf97b9 100644 --- a/commands/core/install.md +++ b/commands/core/install.md @@ -2,6 +2,10 @@ Runs the standard WordPress installation process. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--admin_pass`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--locale` (2.7.0). + Creates the WordPress tables in the database using the URL, title, and default admin user details provided. Performs the famous 5 minute install in seconds or less. Note: if you've installed WordPress in a subdirectory, then you'll need to `wp option update siteurl` after `wp core install`. For instance, if WordPress is installed in the `/wp` directory and your domain is example.com, then you'll need to run `wp option update siteurl http://example.com/wp` for your WordPress installation to function properly. diff --git a/commands/core/multisite-convert.md b/commands/core/multisite-convert.md index 0e96d6cf..bc86f29f 100644 --- a/commands/core/multisite-convert.md +++ b/commands/core/multisite-convert.md @@ -4,6 +4,8 @@ Transforms an existing single-site installation into a multisite installation. **Alias:** `install-network` +Options added later: `--skip-config` (2.8.0). + Creates the multisite database tables, and adds the multisite constants to wp-config.php. For those using WordPress with Apache, remember to update the `.htaccess` file with the appropriate multisite rewrite rules. diff --git a/commands/core/multisite-install.md b/commands/core/multisite-install.md index 20b44afd..b7852d50 100644 --- a/commands/core/multisite-install.md +++ b/commands/core/multisite-install.md @@ -2,6 +2,8 @@ Installs WordPress multisite from scratch. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--locale`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Creates the WordPress tables in the database using the URL, title, and default admin user details provided. Then, creates the multisite tables in the database and adds multisite constants to the wp-config.php. For those using WordPress with Apache, remember to update the `.htaccess` file with the appropriate multisite rewrite rules. diff --git a/commands/core/update.md b/commands/core/update.md index 5b6a0606..7b65d37e 100644 --- a/commands/core/update.md +++ b/commands/core/update.md @@ -4,6 +4,10 @@ Updates WordPress to a newer version. **Alias:** `upgrade` +> **Note:** The following options are not part of a stable WP-CLI release yet: `--format`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--insecure` (2.5.0). + Defaults to updating WordPress to the latest version. If you see "Error: Another update is currently in progress.", you may need to run `wp option delete core_updater.lock` after verifying another update isn't actually running. diff --git a/commands/core/upgrade.md b/commands/core/upgrade.md index 869f6105..c0d74117 100644 --- a/commands/core/upgrade.md +++ b/commands/core/upgrade.md @@ -4,6 +4,10 @@ Updates WordPress to a newer version. This is an alias for `wp core update`. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--format`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--insecure` (2.5.0). + Defaults to updating WordPress to the latest version. If you see "Error: Another update is currently in progress.", you may need to run `wp option delete core_updater.lock` after verifying another update isn't actually running. diff --git a/commands/core/verify-checksums.md b/commands/core/verify-checksums.md index afb7b830..bfcb1bd1 100644 --- a/commands/core/verify-checksums.md +++ b/commands/core/verify-checksums.md @@ -4,6 +4,10 @@ Verifies WordPress files against WordPress.org's checksums. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--format`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--include-root` (2.8.0), `--insecure` (2.5.0), `--exclude` (2.12.0). + Downloads md5 checksums for the current version from WordPress.org, and compares those checksums against the currently installed files. For security, avoids loading WordPress when verifying checksums. diff --git a/commands/cron/event/delete.md b/commands/cron/event/delete.md index c6a52a15..26ceb6b4 100644 --- a/commands/cron/event/delete.md +++ b/commands/cron/event/delete.md @@ -2,6 +2,10 @@ Deletes all scheduled cron events for the given hook. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--match-args`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--due-now` (2.11.0), `--exclude` (2.11.0), `--all` (2.11.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cron/event/run.md b/commands/cron/event/run.md index 75a7200a..fc66ed1f 100644 --- a/commands/cron/event/run.md +++ b/commands/cron/event/run.md @@ -2,6 +2,10 @@ Runs the next scheduled cron event for the given hook. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--network`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--exclude` (2.8.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/cron/event/unschedule.md b/commands/cron/event/unschedule.md index 12004bc5..b7276fdc 100644 --- a/commands/cron/event/unschedule.md +++ b/commands/cron/event/unschedule.md @@ -2,6 +2,8 @@ Unschedules all cron events for a given hook. +Available since WP-CLI 2.5.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/db/clean.md b/commands/db/clean.md index baf3cab9..427754dc 100644 --- a/commands/db/clean.md +++ b/commands/db/clean.md @@ -2,6 +2,8 @@ Removes all tables with `$table_prefix` from the database. +Options added later: `--defaults` (2.6.0). + Runs `DROP_TABLE` for each table that has a `$table_prefix` as specified in wp-config.php. ### OPTIONS diff --git a/commands/db/create.md b/commands/db/create.md index 8b1d9d43..7558fc2e 100644 --- a/commands/db/create.md +++ b/commands/db/create.md @@ -4,6 +4,8 @@ Creates a new database. This command runs on the `after_wp_config_load` hook, after wp-config.php has been loaded into scope. +Options added later: `--defaults` (2.6.0). + Runs `CREATE_DATABASE` SQL statement using `DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials specified in wp-config.php. ### OPTIONS diff --git a/commands/db/drop.md b/commands/db/drop.md index e9e3ad96..581c27d4 100644 --- a/commands/db/drop.md +++ b/commands/db/drop.md @@ -4,6 +4,8 @@ Deletes the existing database. This command runs on the `after_wp_config_load` hook, after wp-config.php has been loaded into scope. +Options added later: `--defaults` (2.6.0). + Runs `DROP_DATABASE` SQL statement using `DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials specified in wp-config.php. ### OPTIONS diff --git a/commands/db/reset.md b/commands/db/reset.md index e1c1e291..5492c515 100644 --- a/commands/db/reset.md +++ b/commands/db/reset.md @@ -4,6 +4,8 @@ Removes all tables from the database. This command runs on the `after_wp_config_load` hook, after wp-config.php has been loaded into scope. +Options added later: `--defaults` (2.6.0). + Runs `DROP_DATABASE` and `CREATE_DATABASE` SQL statements using `DB_HOST`, `DB_NAME`, `DB_USER` and `DB_PASSWORD` database credentials specified in wp-config.php. ### OPTIONS diff --git a/commands/db/search.md b/commands/db/search.md index 38da8ce9..6a097377 100644 --- a/commands/db/search.md +++ b/commands/db/search.md @@ -2,6 +2,8 @@ Finds a string in the database. +Options added later: `--fields` (2.11.0), `--format` (2.11.0). + Searches through all of the text columns in a selection of database tables for a given string, Outputs colorized references to the string. Defaults to searching through all tables registered to $wpdb. On multisite, this default is limited to the tables for the current site. diff --git a/commands/db/size.md b/commands/db/size.md index 3a4cc5c1..7dd5ff41 100644 --- a/commands/db/size.md +++ b/commands/db/size.md @@ -2,6 +2,8 @@ Displays the database name and size. +Options added later: `--decimals` (2.6.0), `--order` (2.7.0), `--orderby` (2.7.0). + Display the database name and size for `DB_NAME` specified in wp-config.php. The size defaults to a human-readable number. Available size formats include: diff --git a/commands/eval-file.md b/commands/eval-file.md index a4acb66e..4380cf29 100644 --- a/commands/eval-file.md +++ b/commands/eval-file.md @@ -4,6 +4,10 @@ Loads and executes a PHP file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--hook`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--use-include` (2.8.0). + Note: because code is executed within a method, global variables need to be explicitly globalized. ### OPTIONS diff --git a/commands/eval.md b/commands/eval.md index 3f4fcd74..8928633c 100644 --- a/commands/eval.md +++ b/commands/eval.md @@ -4,6 +4,8 @@ Executes arbitrary PHP code. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--hook`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Note: because code is executed within a method, global variables need to be explicitly globalized. ### OPTIONS diff --git a/commands/export.md b/commands/export.md index bcefcbe5..8d5d8521 100644 --- a/commands/export.md +++ b/commands/export.md @@ -2,6 +2,10 @@ Exports WordPress content to a WXR file. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--skip_authors`, `--skip_terms`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--include_once` (2.8.0), `--allow_orphan_terms` (2.9.0). + Generates one or more WXR files containing authors, terms, posts, comments, and attachments. WXR files do not include site configuration (options) or the attachment files themselves. ### OPTIONS diff --git a/commands/font.md b/commands/font.md index 0b6a3a0b..ad3b12cc 100644 --- a/commands/font.md +++ b/commands/font.md @@ -2,6 +2,8 @@ Manages WordPress fonts. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### EXAMPLES # List all font collections diff --git a/commands/font/collection.md b/commands/font/collection.md index d89b29e2..2af5f3a6 100644 --- a/commands/font/collection.md +++ b/commands/font/collection.md @@ -2,6 +2,8 @@ Manages font collections. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + 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 diff --git a/commands/font/collection/get.md b/commands/font/collection/get.md index b3b89442..2af4ecd1 100644 --- a/commands/font/collection/get.md +++ b/commands/font/collection/get.md @@ -2,6 +2,8 @@ Gets details about a registered font collection. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/font/collection/is-registered.md b/commands/font/collection/is-registered.md index 9301ec4a..381b22a6 100644 --- a/commands/font/collection/is-registered.md +++ b/commands/font/collection/is-registered.md @@ -2,6 +2,8 @@ Checks if a font collection is registered. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/font/collection/list-categories.md b/commands/font/collection/list-categories.md index e4fa01c5..ff42874e 100644 --- a/commands/font/collection/list-categories.md +++ b/commands/font/collection/list-categories.md @@ -2,6 +2,8 @@ Lists categories in a collection. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/font/collection/list-families.md b/commands/font/collection/list-families.md index 5099dee5..e5e0d2b8 100644 --- a/commands/font/collection/list-families.md +++ b/commands/font/collection/list-families.md @@ -2,6 +2,8 @@ Lists font families in a collection. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/font/collection/list.md b/commands/font/collection/list.md index 6d31d602..f9f435d9 100644 --- a/commands/font/collection/list.md +++ b/commands/font/collection/list.md @@ -2,6 +2,8 @@ Lists registered font collections. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/font/face.md b/commands/font/face.md index 0adfd8d8..851f0a37 100644 --- a/commands/font/face.md +++ b/commands/font/face.md @@ -2,6 +2,8 @@ Manages font faces. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + To list, get, create, update or delete font faces, use `wp post` with `--post_type=wp_font_face`. ### EXAMPLES diff --git a/commands/font/face/install.md b/commands/font/face/install.md index 4fec3836..e50255ff 100644 --- a/commands/font/face/install.md +++ b/commands/font/face/install.md @@ -2,6 +2,8 @@ Installs a font face. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Creates a new font face post with the specified settings. ### OPTIONS diff --git a/commands/font/family.md b/commands/font/family.md index 7cd1a6aa..610bb0f7 100644 --- a/commands/font/family.md +++ b/commands/font/family.md @@ -2,6 +2,8 @@ Manages font families. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + To list, get, create, update or delete font families, use `wp post` with `--post_type=wp_font_family`. ### EXAMPLES diff --git a/commands/font/family/install.md b/commands/font/family/install.md index d3d4cd98..da5e59b0 100644 --- a/commands/font/family/install.md +++ b/commands/font/family/install.md @@ -2,6 +2,8 @@ Installs a font family from a collection. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Retrieves a font family from a collection and creates the wp_font_family post along with all associated font faces. ### OPTIONS diff --git a/commands/help.md b/commands/help.md index 5ffa0fd8..2b1db689 100644 --- a/commands/help.md +++ b/commands/help.md @@ -2,6 +2,8 @@ Gets help on WP-CLI, or on a specific command. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--full`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/i18n/audit.md b/commands/i18n/audit.md index dafeaf6b..47ffd772 100644 --- a/commands/i18n/audit.md +++ b/commands/i18n/audit.md @@ -4,6 +4,8 @@ Audit strings in a project. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Scans PHP, Blade-PHP and JavaScript files for translatable strings to find possible mistakes. ### OPTIONS diff --git a/commands/i18n/make-json.md b/commands/i18n/make-json.md index 4ceee2af..29928cd1 100644 --- a/commands/i18n/make-json.md +++ b/commands/i18n/make-json.md @@ -4,6 +4,8 @@ Extract JavaScript strings from PO files and add them to individual JSON files. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--domain` (2.12.0), `--extensions` (2.12.0), `--use-map` (2.6.0). + For JavaScript internationalization purposes, WordPress requires translations to be split up into one Jed-formatted JSON file per JavaScript source file. See https://make.wordpress.org/core/2018/11/09/new-javascript-i18n-support-in-wordpress/ to learn more about WordPress JavaScript internationalization. diff --git a/commands/i18n/make-mo.md b/commands/i18n/make-mo.md index 77edee40..cfd0cf58 100644 --- a/commands/i18n/make-mo.md +++ b/commands/i18n/make-mo.md @@ -4,6 +4,8 @@ Create MO files from PO files. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Available since WP-CLI 2.5.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/i18n/make-php.md b/commands/i18n/make-php.md index 876d807f..f2962980 100644 --- a/commands/i18n/make-php.md +++ b/commands/i18n/make-php.md @@ -4,6 +4,10 @@ Create PHP files from PO files. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--pretty-print`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Available since WP-CLI 2.10.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/i18n/make-pot.md b/commands/i18n/make-pot.md index 9f7dbd66..8ddc7f8e 100644 --- a/commands/i18n/make-pot.md +++ b/commands/i18n/make-pot.md @@ -4,6 +4,8 @@ Create a POT file for a WordPress project. This command runs on the `before_wp_load` hook, just before the WP load process begins. +Options added later: `--subtract-and-merge` (2.6.0), `--location` (2.6.0), `--skip-php` (2.5.0), `--skip-blade` (2.7.0), `--skip-block-json` (2.5.0), `--skip-theme-json` (2.6.0). + Scans PHP, Blade-PHP and JavaScript files for translatable strings, as well as theme stylesheets and plugin files if the source directory is detected as either a plugin or theme. ### OPTIONS diff --git a/commands/i18n/update-po.md b/commands/i18n/update-po.md index 152f4b2f..1dc12d51 100644 --- a/commands/i18n/update-po.md +++ b/commands/i18n/update-po.md @@ -4,6 +4,10 @@ Update PO files from a POT file. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--purge`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Available since WP-CLI 2.7.0. + This behaves similarly to the [msgmerge](https://www.gnu.org/software/gettext/manual/html_node/msgmerge-Invocation.html) command. ### OPTIONS diff --git a/commands/icon.md b/commands/icon.md new file mode 100644 index 00000000..7392156d --- /dev/null +++ b/commands/icon.md @@ -0,0 +1,35 @@ +# wp icon + +Manages registered SVG icons. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Icons are registered in code with `wp_register_icon()` by WordPress core, themes, and plugins, and always belong to an icon collection. Because they only exist for the duration of a request, they cannot be created or deleted from the command line. + +Icon names are namespaced with the slug of the collection they belong to, in the form `collection/icon-name`. + +### EXAMPLES + + # List all registered icons + $ wp icon list + +-----------------+------------+------------+ + | name | label | collection | + +-----------------+------------+------------+ + | core/arrow-down | Arrow Down | core | + | core/plus | Plus | core | + +-----------------+------------+------------+ + + # Get details about a single icon + $ wp icon get core/plus --fields=name,label,collection + +------------+-----------+ + | Field | Value | + +------------+-----------+ + | name | core/plus | + | label | Plus | + | collection | core | + +------------+-----------+ + + # Render an icon at a given size, ready to be embedded in a template + $ wp icon render core/plus --size=48 --label="Add item" > plus.svg + + diff --git a/commands/icon/collection.md b/commands/icon/collection.md new file mode 100644 index 00000000..e0ccf7e7 --- /dev/null +++ b/commands/icon/collection.md @@ -0,0 +1,24 @@ +# wp icon collection + +Manages icon collections. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Icon collections group registered SVG icons by source, and act as the namespace of the icons belonging to them. WordPress core registers the `core` collection, while themes and plugins register their own with `wp_register_icon_collection()`. Because collections only exist for the duration of a request, they cannot be created or deleted from the command line. + +### EXAMPLES + + # List all icon collections + $ wp icon collection list + +------+-----------+--------------------------+-------+ + | slug | label | description | count | + +------+-----------+--------------------------+-------+ + | core | WordPress | Default icon collection. | 88 | + +------+-----------+--------------------------+-------+ + + # List the icons of a collection + $ wp icon list --collection=core + + + + diff --git a/commands/icon/collection/get.md b/commands/icon/collection/get.md new file mode 100644 index 00000000..3af49672 --- /dev/null +++ b/commands/icon/collection/get.md @@ -0,0 +1,80 @@ +# wp icon collection get + +Gets details about a registered icon collection. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +### 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> +: Icon 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 +* label +* description +* count + +### EXAMPLES + + # Get details of a specific collection + $ wp icon collection get core + +-------------+--------------------------+ + | Field | Value | + +-------------+--------------------------+ + | slug | core | + | label | WordPress | + | description | Default icon collection. | + | count | 88 | + +-------------+--------------------------+ + + # Get the label field only + $ wp icon collection get core --field=label + WordPress + +### 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/icon/collection/is-registered.md b/commands/icon/collection/is-registered.md new file mode 100644 index 00000000..d51d496a --- /dev/null +++ b/commands/icon/collection/is-registered.md @@ -0,0 +1,47 @@ +# wp icon collection is-registered + +Checks if an icon collection is registered. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +### 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> +: Icon collection slug. + +### EXAMPLES + + # Bash script for checking if an icon collection is registered, with fallback. + + if wp icon collection is-registered core 2>/dev/null; then + # Icon 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/icon/collection/list.md b/commands/icon/collection/list.md new file mode 100644 index 00000000..c86dae8c --- /dev/null +++ b/commands/icon/collection/list.md @@ -0,0 +1,76 @@ +# wp icon collection list + +Lists registered icon collections. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +### 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 + - ids +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for each collection: + +* slug +* label +* description +* count + +### EXAMPLES + + # List all icon collections + $ wp icon collection list + +------+-----------+--------------------------+-------+ + | slug | label | description | count | + +------+-----------+--------------------------+-------+ + | core | WordPress | Default icon collection. | 88 | + +------+-----------+--------------------------+-------+ + + # List collections in JSON format + $ wp icon collection list --fields=slug,label --format=json + [{"slug":"core","label":"WordPress"}] + +### 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/icon/get.md b/commands/icon/get.md new file mode 100644 index 00000000..d2bf760e --- /dev/null +++ b/commands/icon/get.md @@ -0,0 +1,89 @@ +# wp icon get + +Gets details about a registered icon. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +### 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> +: Namespaced icon name, in the form "collection/icon-name". + +[\--field=<field>] +: Instead of returning the whole icon, returns the value of a single field. + +[\--fields=<fields>] +: Limit the output to specific 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 icon: + +* name +* label +* collection +* content + +This field is optionally available: + +* file_path + +### EXAMPLES + + # Get details of a specific icon + $ wp icon get core/plus --fields=name,label,collection + +------------+-----------+ + | Field | Value | + +------------+-----------+ + | name | core/plus | + | label | Plus | + | collection | core | + +------------+-----------+ + + # Get the SVG markup of an icon, as it was registered + $ wp icon get core/plus --field=content + <svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24"> + <path d="M11 12.5V17.5H12.5V12.5H17.5V11H12.5V6H11V11H6V12.5H11Z" /> + </svg> + + # Find out where an icon is loaded from + $ wp icon get core/plus --field=file_path + /var/www/html/wp-includes/images/icon-library/plus.svg + +### 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/icon/is-registered.md b/commands/icon/is-registered.md new file mode 100644 index 00000000..bf9ad92f --- /dev/null +++ b/commands/icon/is-registered.md @@ -0,0 +1,47 @@ +# wp icon is-registered + +Checks if an icon is registered. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +### 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> +: Namespaced icon name, in the form "collection/icon-name". + +### EXAMPLES + + # Bash script for checking if an icon is registered, with fallback. + + if wp icon is-registered core/plus 2>/dev/null; then + # Icon is registered. Do something. + else + # Fallback if icon 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/icon/list.md b/commands/icon/list.md new file mode 100644 index 00000000..29607a15 --- /dev/null +++ b/commands/icon/list.md @@ -0,0 +1,93 @@ +# wp icon list + +Lists registered icons. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +### 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=<slug>] +: Only list icons belonging to the given collection. + +[\--search=<term>] +: Only list icons whose name or label matches the given term. + +[\--field=<field>] +: Prints the value of a single field for each icon. + +[\--fields=<fields>] +: Limit the output to specific icon fields. + +[\--format=<format>] +: Render output in a particular format. +\--- +default: table +options: + - table + - csv + - json + - count + - yaml + - ids +\--- + +### AVAILABLE FIELDS + +These fields will be displayed by default for each icon: + +* name +* label +* collection + +These fields are optionally available: + +* content +* file_path + +### EXAMPLES + + # List all icons of a specific collection + $ wp icon list --collection=core + +-----------------+------------+------------+ + | name | label | collection | + +-----------------+------------+------------+ + | core/arrow-down | Arrow Down | core | + | core/plus | Plus | core | + +-----------------+------------+------------+ + + # Search for icons by name or label + $ wp icon list --search=arrow-down --field=name + core/arrow-down-left + core/arrow-down-right + core/arrow-down + + # Count the icons of a collection + $ wp icon list --collection=core --format=count + 88 + +### 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/icon/render.md b/commands/icon/render.md new file mode 100644 index 00000000..2026920d --- /dev/null +++ b/commands/icon/render.md @@ -0,0 +1,65 @@ +# wp icon render + +Renders the SVG markup of a registered icon. + +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Unlike `wp icon get --field=content`, which prints the icon as it was registered, this applies the same sizing and accessibility attributes that WordPress applies when rendering the icon on the front end. + +### 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> +: Namespaced icon name, in the form "collection/icon-name". + +[\--size=<size>] +: Width and height of the icon in pixels. Pass "none" to leave the intrinsic dimensions of the SVG untouched. +\--- +default: 24 +\--- + +[\--class=<class>] +: Additional CSS class names, separated by spaces. + +[\--label=<label>] +: Accessible label for the icon. Without it, the icon is rendered as decorative and hidden from assistive technology. + +### EXAMPLES + + # Render an icon at its default size of 24 pixels + $ wp icon render core/plus + <svg aria-hidden="true" focusable="false" height="24" width="24" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24"> + <path d="M11 12.5V17.5H12.5V12.5H17.5V11H12.5V6H11V11H6V12.5H11Z" /> + </svg> + + # Render a larger icon with a CSS class and an accessible label + $ wp icon render core/plus --size=48 --class=my-icon --label="Add item" > plus.svg + + # Keep the intrinsic dimensions of the SVG + $ wp icon render core/plus --size=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. + +| **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/import.md b/commands/import.md index 120bdb22..55ac94a6 100644 --- a/commands/import.md +++ b/commands/import.md @@ -2,6 +2,8 @@ Imports content from a given WXR file. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--rewrite_urls`, `--importer`, `--source-dir`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Provides a command line interface to the WordPress Importer plugin, for performing data migrations. Use `define( 'IMPORT_DEBUG', true );` for more verbosity during importing. diff --git a/commands/language/core/install.md b/commands/language/core/install.md index 12a0a173..86559464 100644 --- a/commands/language/core/install.md +++ b/commands/language/core/install.md @@ -2,6 +2,8 @@ Installs a given language. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--format`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Downloads the language pack from WordPress.org. Find your language code at: https://translate.wordpress.org/ ### OPTIONS diff --git a/commands/language/core/update.md b/commands/language/core/update.md index 9f56b9d7..fcc8cad6 100644 --- a/commands/language/core/update.md +++ b/commands/language/core/update.md @@ -2,6 +2,8 @@ Updates installed languages for core. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--format`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/language/plugin/uninstall.md b/commands/language/plugin/uninstall.md index 1be39cc7..e3792eab 100644 --- a/commands/language/plugin/uninstall.md +++ b/commands/language/plugin/uninstall.md @@ -2,6 +2,8 @@ Uninstalls a given language for a plugin. +Options added later: `--all` (2.9.0), `--format` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/language/plugin/update.md b/commands/language/plugin/update.md index 41f37219..5c62949b 100644 --- a/commands/language/plugin/update.md +++ b/commands/language/plugin/update.md @@ -2,6 +2,8 @@ Updates installed languages for one or more plugins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--format`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/language/theme/uninstall.md b/commands/language/theme/uninstall.md index bb020dde..d6ab590c 100644 --- a/commands/language/theme/uninstall.md +++ b/commands/language/theme/uninstall.md @@ -2,6 +2,8 @@ Uninstalls a given language for a theme. +Options added later: `--all` (2.9.0), `--format` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/language/theme/update.md b/commands/language/theme/update.md index dbc411b4..ac663fc1 100644 --- a/commands/language/theme/update.md +++ b/commands/language/theme/update.md @@ -2,6 +2,8 @@ Updates installed languages for one or more themes. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--format`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/media/import.md b/commands/media/import.md index 252fda60..b3c6b182 100644 --- a/commands/media/import.md +++ b/commands/media/import.md @@ -2,6 +2,10 @@ Creates attachments from local files or URLs. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--destination-dir`, `--skip-duplicates`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--post_name` (2.8.0), `--file_name` (2.10.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/media/prune.md b/commands/media/prune.md index 37d9ae5d..f57e525c 100644 --- a/commands/media/prune.md +++ b/commands/media/prune.md @@ -2,6 +2,8 @@ Removes all generated image files for one or more attachments. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + 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 diff --git a/commands/media/regenerate.md b/commands/media/regenerate.md index 88b17921..be53cccd 100644 --- a/commands/media/regenerate.md +++ b/commands/media/regenerate.md @@ -2,6 +2,10 @@ Regenerates thumbnails for one or more attachments. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--update-attachment-refs`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--delete-unknown` (2.11.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/media/replace.md b/commands/media/replace.md index ee9af2bf..354e1afe 100644 --- a/commands/media/replace.md +++ b/commands/media/replace.md @@ -2,6 +2,8 @@ Replaces the file for an existing attachment while preserving its identity. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/menu/item/add-post-type-archive.md b/commands/menu/item/add-post-type-archive.md index e8eedff3..c54e2604 100644 --- a/commands/menu/item/add-post-type-archive.md +++ b/commands/menu/item/add-post-type-archive.md @@ -2,6 +2,8 @@ Adds a post type archive as a menu item. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/menu/item/get.md b/commands/menu/item/get.md index 5e3d4bab..56786483 100644 --- a/commands/menu/item/get.md +++ b/commands/menu/item/get.md @@ -2,6 +2,8 @@ Gets details about a menu item. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/network/meta/get.md b/commands/network/meta/get.md index 05a12de8..ab4df58c 100644 --- a/commands/network/meta/get.md +++ b/commands/network/meta/get.md @@ -2,6 +2,8 @@ Get meta field value. +Options added later: `--single` (2.12.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/option/get-autoload.md b/commands/option/get-autoload.md index 417935b1..52f3294d 100644 --- a/commands/option/get-autoload.md +++ b/commands/option/get-autoload.md @@ -2,6 +2,8 @@ Gets the 'autoload' value for an option. +Available since WP-CLI 2.8.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/option/set-autoload.md b/commands/option/set-autoload.md index ea746c3b..f7146ef1 100644 --- a/commands/option/set-autoload.md +++ b/commands/option/set-autoload.md @@ -2,6 +2,8 @@ Sets the 'autoload' value for an option. +Available since WP-CLI 2.8.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/package/get.md b/commands/package/get.md index 7b7e81be..d24f9a74 100644 --- a/commands/package/get.md +++ b/commands/package/get.md @@ -4,6 +4,8 @@ Gets information about an installed WP-CLI package. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/package/install.md b/commands/package/install.md index b111d2ec..21c0456d 100644 --- a/commands/package/install.md +++ b/commands/package/install.md @@ -4,6 +4,10 @@ Installs a WP-CLI package. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--interaction`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--insecure` (2.5.0). + Packages are required to be a valid Composer package, and can be specified as: * Package name from WP-CLI's package index. diff --git a/commands/package/is-installed.md b/commands/package/is-installed.md index f65b1cb4..b1578e2c 100644 --- a/commands/package/is-installed.md +++ b/commands/package/is-installed.md @@ -4,6 +4,8 @@ Checks if a given package is installed. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Returns exit code 0 when installed, 1 when uninstalled. ### OPTIONS diff --git a/commands/package/list.md b/commands/package/list.md index 7d1af080..93937094 100644 --- a/commands/package/list.md +++ b/commands/package/list.md @@ -4,6 +4,8 @@ Lists installed WP-CLI packages. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--skip-update-check`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/package/uninstall.md b/commands/package/uninstall.md index f4e07b9c..66643a72 100644 --- a/commands/package/uninstall.md +++ b/commands/package/uninstall.md @@ -4,6 +4,10 @@ Uninstalls a WP-CLI package. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--interaction`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--insecure` (2.6.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/package/update.md b/commands/package/update.md index 71b7a75f..beef9b89 100644 --- a/commands/package/update.md +++ b/commands/package/update.md @@ -4,6 +4,8 @@ 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. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--interaction`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + [<package-name>...] : One or more package names to update. If not specified, all packages will be updated. diff --git a/commands/plugin/activate.md b/commands/plugin/activate.md index 4ab7055a..68497f6b 100644 --- a/commands/plugin/activate.md +++ b/commands/plugin/activate.md @@ -2,6 +2,10 @@ Activates one or more plugins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--force`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--exclude` (2.7.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/auto-updates.md b/commands/plugin/auto-updates.md index 61810409..05b22598 100644 --- a/commands/plugin/auto-updates.md +++ b/commands/plugin/auto-updates.md @@ -2,6 +2,8 @@ Manages plugin auto-updates. +Available since WP-CLI 2.5.0. + ### EXAMPLES # Enable the auto-updates for a plugin diff --git a/commands/plugin/auto-updates/disable.md b/commands/plugin/auto-updates/disable.md index 3ac58e98..8311dcac 100644 --- a/commands/plugin/auto-updates/disable.md +++ b/commands/plugin/auto-updates/disable.md @@ -2,6 +2,8 @@ Disables the auto-updates for a plugin. +Available since WP-CLI 2.5.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/auto-updates/enable.md b/commands/plugin/auto-updates/enable.md index 915bb94b..ca902420 100644 --- a/commands/plugin/auto-updates/enable.md +++ b/commands/plugin/auto-updates/enable.md @@ -2,6 +2,8 @@ Enables the auto-updates for a plugin. +Available since WP-CLI 2.5.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/auto-updates/status.md b/commands/plugin/auto-updates/status.md index a734c151..16800571 100644 --- a/commands/plugin/auto-updates/status.md +++ b/commands/plugin/auto-updates/status.md @@ -2,6 +2,8 @@ Shows the status of auto-updates for a plugin. +Available since WP-CLI 2.5.0. Options added later: `--format` (2.8.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/check-update.md b/commands/plugin/check-update.md index c7d9de72..26a9a563 100644 --- a/commands/plugin/check-update.md +++ b/commands/plugin/check-update.md @@ -2,6 +2,8 @@ Checks for plugin updates without performing them. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Lists the available plugin updates. Similar to `wp core check-update`. ### OPTIONS diff --git a/commands/plugin/deactivate.md b/commands/plugin/deactivate.md index 63fecb73..0d7c2a90 100644 --- a/commands/plugin/deactivate.md +++ b/commands/plugin/deactivate.md @@ -2,6 +2,8 @@ Deactivates one or more plugins. +Options added later: `--exclude` (2.7.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/delete.md b/commands/plugin/delete.md index f190295a..82dcb6d7 100644 --- a/commands/plugin/delete.md +++ b/commands/plugin/delete.md @@ -2,6 +2,8 @@ Deletes plugin files without deactivating or uninstalling. +Options added later: `--exclude` (2.7.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/download.md b/commands/plugin/download.md index 0482ebb6..d0806c32 100644 --- a/commands/plugin/download.md +++ b/commands/plugin/download.md @@ -4,6 +4,8 @@ Downloads a plugin zip package without loading WordPress. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/install-dependencies.md b/commands/plugin/install-dependencies.md index d18bc97a..6a11f176 100644 --- a/commands/plugin/install-dependencies.md +++ b/commands/plugin/install-dependencies.md @@ -2,6 +2,8 @@ Installs all dependencies of an installed plugin. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + 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 diff --git a/commands/plugin/install.md b/commands/plugin/install.md index c66f0d6c..fd2e0cbc 100644 --- a/commands/plugin/install.md +++ b/commands/plugin/install.md @@ -2,6 +2,10 @@ Installs one or more plugins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--with-dependencies`, `--slug`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--ignore-requirements` (2.12.0), `--insecure` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/is-active.md b/commands/plugin/is-active.md index 2ebc9462..317e67a6 100644 --- a/commands/plugin/is-active.md +++ b/commands/plugin/is-active.md @@ -2,6 +2,8 @@ Checks if a given plugin is active. +Options added later: `--network` (2.5.0). + 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. diff --git a/commands/plugin/uninstall.md b/commands/plugin/uninstall.md index 1fff21f2..982e7bc2 100644 --- a/commands/plugin/uninstall.md +++ b/commands/plugin/uninstall.md @@ -2,6 +2,8 @@ Uninstalls one or more plugins. +Options added later: `--exclude` (2.7.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/update.md b/commands/plugin/update.md index 619c9be9..98498fc7 100644 --- a/commands/plugin/update.md +++ b/commands/plugin/update.md @@ -4,6 +4,10 @@ Updates one or more plugins. **Alias:** `upgrade` +> **Note:** The following options are not part of a stable WP-CLI release yet: `--auto-update-indicated`, `--include-vcs`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--insecure` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/upgrade.md b/commands/plugin/upgrade.md index ce5cfe7f..489081ee 100644 --- a/commands/plugin/upgrade.md +++ b/commands/plugin/upgrade.md @@ -4,6 +4,10 @@ Updates one or more plugins. This is an alias for `wp plugin update`. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--auto-update-indicated`, `--include-vcs`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--insecure` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/plugin/verify-checksums.md b/commands/plugin/verify-checksums.md index 17aba9c4..c25af49c 100644 --- a/commands/plugin/verify-checksums.md +++ b/commands/plugin/verify-checksums.md @@ -2,6 +2,10 @@ Verifies plugin files against WordPress.org's checksums. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--exclude-mu-plugins`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--version` (2.8.0), `--insecure` (2.5.0), `--exclude` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/post/block.md b/commands/post/block.md index 61595bf3..fa7a4657 100644 --- a/commands/post/block.md +++ b/commands/post/block.md @@ -2,6 +2,8 @@ Manages blocks within post content. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Provides commands for inspecting, manipulating, and managing Gutenberg blocks in post content. ### EXAMPLES diff --git a/commands/post/block/clone.md b/commands/post/block/clone.md index f281ec36..84b512e1 100644 --- a/commands/post/block/clone.md +++ b/commands/post/block/clone.md @@ -2,6 +2,8 @@ Clones a block within a post. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Duplicates an existing block and inserts it at a specified position. ### OPTIONS diff --git a/commands/post/block/count.md b/commands/post/block/count.md index c5ee31b7..08e7f24a 100644 --- a/commands/post/block/count.md +++ b/commands/post/block/count.md @@ -2,6 +2,8 @@ Counts blocks across multiple posts. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Analyzes block usage across posts for site-wide reporting. ### OPTIONS diff --git a/commands/post/block/export.md b/commands/post/block/export.md index e457fb12..0649d178 100644 --- a/commands/post/block/export.md +++ b/commands/post/block/export.md @@ -2,6 +2,8 @@ Exports block content to a file. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Exports blocks from a post to a file for backup or migration. ### OPTIONS diff --git a/commands/post/block/extract.md b/commands/post/block/extract.md index 8444ecd2..2b9c2f56 100644 --- a/commands/post/block/extract.md +++ b/commands/post/block/extract.md @@ -2,6 +2,8 @@ Extracts data from blocks. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Extracts specific attribute values or content from blocks for scripting. ### OPTIONS diff --git a/commands/post/block/get.md b/commands/post/block/get.md index da76ede7..82992170 100644 --- a/commands/post/block/get.md +++ b/commands/post/block/get.md @@ -2,6 +2,8 @@ Gets a single block by index. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Retrieves the full structure of a block at the specified position. ### OPTIONS diff --git a/commands/post/block/import.md b/commands/post/block/import.md index f7cfc913..781690c4 100644 --- a/commands/post/block/import.md +++ b/commands/post/block/import.md @@ -2,6 +2,8 @@ Imports blocks from a file into a post. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Imports blocks from a JSON or YAML file into a post's content. ### OPTIONS diff --git a/commands/post/block/insert.md b/commands/post/block/insert.md index 4bc5551d..be440a00 100644 --- a/commands/post/block/insert.md +++ b/commands/post/block/insert.md @@ -2,6 +2,8 @@ Inserts a block into a post at a specified position. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Adds a new block to the post content. By default, the block is appended to the end of the post. ### OPTIONS diff --git a/commands/post/block/list.md b/commands/post/block/list.md index ae55fd8e..63755afc 100644 --- a/commands/post/block/list.md +++ b/commands/post/block/list.md @@ -2,6 +2,8 @@ Lists blocks in a post with counts. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Displays a summary of block types used in the post and how many times each block type appears. ### OPTIONS diff --git a/commands/post/block/move.md b/commands/post/block/move.md index be42fe6c..350d2c84 100644 --- a/commands/post/block/move.md +++ b/commands/post/block/move.md @@ -2,6 +2,8 @@ Moves a block from one position to another. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Reorders blocks within the post by moving a block from one index to another. ### OPTIONS diff --git a/commands/post/block/parse.md b/commands/post/block/parse.md index 63935c80..71897e14 100644 --- a/commands/post/block/parse.md +++ b/commands/post/block/parse.md @@ -2,6 +2,8 @@ Parses and displays the block structure of a post. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Outputs the parsed block structure as JSON or YAML. By default, innerHTML is stripped from the output for readability. ### OPTIONS diff --git a/commands/post/block/remove.md b/commands/post/block/remove.md index 454a5b6e..7a5c693b 100644 --- a/commands/post/block/remove.md +++ b/commands/post/block/remove.md @@ -2,6 +2,8 @@ Removes blocks from a post by name or index. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Removes one or more blocks from the post content. Blocks can be removed by their type name or by their position index. ### OPTIONS diff --git a/commands/post/block/render.md b/commands/post/block/render.md index e819496e..faaf471d 100644 --- a/commands/post/block/render.md +++ b/commands/post/block/render.md @@ -2,6 +2,8 @@ Renders blocks from a post to HTML. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Outputs the rendered HTML of blocks in a post. This uses WordPress's block rendering system to produce the final HTML output. ### OPTIONS diff --git a/commands/post/block/replace.md b/commands/post/block/replace.md index 8589ff84..c360ba43 100644 --- a/commands/post/block/replace.md +++ b/commands/post/block/replace.md @@ -2,6 +2,8 @@ Replaces blocks in a post. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Replaces blocks of one type with blocks of another type. Can also be used to update block attributes without changing the block type. ### OPTIONS diff --git a/commands/post/block/update.md b/commands/post/block/update.md index 114e1700..8c4f24c9 100644 --- a/commands/post/block/update.md +++ b/commands/post/block/update.md @@ -2,6 +2,8 @@ Updates a block's attributes or content by index. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + 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 diff --git a/commands/post/create.md b/commands/post/create.md index 5f9cd4ec..4f49d4ca 100644 --- a/commands/post/create.md +++ b/commands/post/create.md @@ -86,6 +86,12 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--meta_input=<meta_input>] : Array in JSON format of post meta values keyed by their post meta key. Default empty. +[\--page_template=<page_template>] +: Page template to use. + +[\--import_id=<import_id>] +: The post ID to be used when inserting a new post. If specified, must not match any existing post ID. + [<file>] : Read post content from <file>. If this value is present, the `--post_content` argument will be ignored. diff --git a/commands/post/has-block.md b/commands/post/has-block.md index 6493202b..3a281a04 100644 --- a/commands/post/has-block.md +++ b/commands/post/has-block.md @@ -2,6 +2,8 @@ Checks if a post contains a specific block type. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Exits with return code 0 if the post contains the specified block, or return code 1 if it does not. ### OPTIONS diff --git a/commands/post/has-blocks.md b/commands/post/has-blocks.md index a834acd3..f1807854 100644 --- a/commands/post/has-blocks.md +++ b/commands/post/has-blocks.md @@ -2,6 +2,8 @@ Checks if a post contains any blocks. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Exits with return code 0 if the post contains blocks, or return code 1 if it does not. ### OPTIONS diff --git a/commands/post/list.md b/commands/post/list.md index 3c7b1ea4..a0a11e55 100644 --- a/commands/post/list.md +++ b/commands/post/list.md @@ -9,7 +9,190 @@ Display posts based on all arguments supported by [WP_Query()](https://developer 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>] -: One or more args to pass to WP_Query. +: One or more args to pass to WP_Query. The arguments below are the ones that filter on what this command displays; anything else WP_Query accepts still works and is documented with WP_Query itself. + +[\--p=<id>|ID] +: Filter by post ID. `--ID` is the name of the column this filters and is accepted as an alias. + +[\--title=<title>|post_title] +: Filter by post title, matched in full. `--post_title` is the name of the column this filters and is accepted as an alias. + +[\--name=<slug>|post_name] +: Filter by post slug. `--post_name` is the name of the column this filters and is accepted as an alias. Note: this makes the query a single-post one, and WP_Query returns a draft from one of those only to a user who can edit it. WP-CLI runs as no user unless the global `--user` argument says otherwise, so pass that to filter drafts by slug. + +[\--author=<author>|post_author] +: Filter by the ID of the post's author. `--post_author` is the name of the column this filters and is accepted as an alias. + +[\--author_name=<author_name>] +: Filter by the 'user_nicename' of the post's author. + +[\--cat=<cat>] +: Filter by category ID. Accepts a comma-separated list to match any of them, and a negative ID excludes that category instead. + +[\--category_name=<category_name>] +: Filter by category slug. + +[\--tag=<tag>] +: Filter by tag slug. Accepts a comma-separated list to match any of them, or a '+'-separated list to require all of them. + +[\--post_type=<post_type>] +: Filter by post type. Defaults to 'post'. Accepts a comma-separated list, or 'any' for every type registered without 'exclude_from_search'. + +[\--post_status=<post_status>] +: Filter by post status. Defaults to 'any', which is every status registered without 'exclude_from_search' - so trashed and auto-draft posts are left out until asked for by name, e.g. `--post_status=trash`. + +[\--post_parent=<post_parent>] +: Filter by the ID of the parent post. + +[\--post_mime_type=<post_mime_type>] +: Filter by MIME type. Only attachments carry one. + +[\--menu_order=<menu_order>] +: Filter by menu order. + +[\--comment_status=<comment_status>] +: Filter by comment status. Accepts 'open' or 'closed'. + +[\--ping_status=<ping_status>] +: Filter by ping status. Accepts 'open' or 'closed'. + +[\--comment_count=<comment_count>] +: Filter by number of comments. + +[\--s=<string>] +: Only list the posts matching this search term. + +[\--year=<year>] +: Filter by four-digit year, e.g. 2024. + +[\--monthnum=<monthnum>] +: Filter by month number, 1 to 12. + +[\--day=<day>] +: Filter by day of the month, 1 to 31. + +[\--hour=<hour>] +: Filter by hour, 0 to 23. + +[\--minute=<minute>] +: Filter by minute, 0 to 59. + +[\--second=<second>] +: Filter by second, 0 to 59. + +[\--m=<yearmonth>] +: Filter by year and month together, e.g. 202401. + +[\--w=<week>] +: Filter by week of the year, 0 to 53. + +[\--meta_key=<meta_key>] +: Filter by posts having this meta key. Pair it with `--meta_value` to filter on the value as well. + +[\--meta_value=<meta_value>] +: Filter by this meta value. Needs `--meta_key` to say which key it belongs to. + +[\--orderby=<orderby>] +: Order the results by this field. Accepts what WP_Query accepts, e.g. +'date', 'title', 'ID', 'menu_order', 'rand', or 'meta_value' alongside `--meta_key`. + +[\--order=<order>] +: Direction to order by. Accepts 'ASC' or 'DESC'. + +[\--post__in=<ids>] +: Only list the posts with these IDs (comma-separated). + +[\--post__not_in=<ids>] +: Exclude the posts with these IDs (comma-separated). + +[\--post_name__in=<slugs>] +: Only list the posts with these slugs (comma-separated). Unlike `--name` this is not a single-post query, so it reaches drafts as well. + +[\--post_parent__in=<ids>] +: Only list the posts whose parent is one of these IDs (comma-separated). + +[\--post_parent__not_in=<ids>] +: Exclude the posts whose parent is one of these IDs (comma-separated). + +[\--author__in=<ids>] +: Only list the posts by these author IDs (comma-separated). + +[\--author__not_in=<ids>] +: Exclude the posts by these author IDs (comma-separated). + +[\--category__in=<ids>] +: Only list the posts in these category IDs (comma-separated). + +[\--category__and=<ids>] +: Only list the posts in all of these category IDs (comma-separated). + +[\--category__not_in=<ids>] +: Exclude the posts in these category IDs (comma-separated). + +[\--tag_id=<tag_id>] +: Filter by tag ID. + +[\--tag__in=<ids>] +: Only list the posts with these tag IDs (comma-separated). + +[\--tag__and=<ids>] +: Only list the posts with all of these tag IDs (comma-separated). + +[\--tag__not_in=<ids>] +: Exclude the posts with these tag IDs (comma-separated). + +[\--tag_slug__in=<slugs>] +: Only list the posts with these tag slugs (comma-separated). + +[\--tag_slug__and=<slugs>] +: Only list the posts with all of these tag slugs (comma-separated). + +[\--page_id=<page_id>] +: Filter by page ID. Needs `--post_type=page` to match anything. + +[\--pagename=<pagename>] +: Filter by page slug. Needs `--post_type=page` to match anything. + +[\--attachment_id=<attachment_id>] +: Filter by attachment ID. Needs `--post_type=attachment` to match anything. + +[\--date_query=<json>] +: Filter by a date query, given as JSON. See WP_Date_Query. + +[\--meta_query=<json>] +: Filter by a meta query, given as JSON. See WP_Meta_Query. + +[\--tax_query=<json>] +: Filter by a taxonomy query, given as JSON. See WP_Tax_Query. + +[\--meta_compare=<meta_compare>] +: Operator to test `--meta_value` with, e.g. '=', '!=', '>' or 'LIKE'. + +[\--sentence=<sentence>] +: Match `--s` as one phrase rather than as separate words. Accepts 1 or 0. + +[\--exact=<exact>] +: Match `--s` against the whole column rather than part of it. Accepts 1 or 0. + +[\--search_columns=<columns>] +: Comma-separated list of columns `--s` looks in. Accepts 'post_title', +'post_excerpt' and 'post_content'. Needs WordPress 6.2 or later. + +[\--perm=<perm>] +: Filter by what the current user may do with the post. Accepts +'readable' or 'editable'; pair it with the global `--user` argument, since WP-CLI is no user by default. + +[\--posts_per_page=<number>] +: How many posts to return. Defaults to -1, meaning every post. + +[\--paged=<paged>] +: Which page of results to return, counted in `--posts_per_page` steps. + +[\--offset=<offset>] +: How many posts to skip. Needs `--posts_per_page` set to something other than -1, which otherwise takes precedence. + +[\--nopaging=<nopaging>] +: Return every post, ignoring `--posts_per_page`. Accepts 1 or 0. [\--field=<field>] : Prints the value of a single field for each post. @@ -60,7 +243,6 @@ These fields are optionally available: * post_type * post_mime_type * comment_count -* filter * url ### EXAMPLES diff --git a/commands/post/meta/clean-duplicates.md b/commands/post/meta/clean-duplicates.md index c30066b0..e413f31e 100644 --- a/commands/post/meta/clean-duplicates.md +++ b/commands/post/meta/clean-duplicates.md @@ -2,6 +2,8 @@ Cleans up duplicate post meta values on a post. +Available since WP-CLI 2.7.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/post/meta/get.md b/commands/post/meta/get.md index 387d94e4..1ab8b475 100644 --- a/commands/post/meta/get.md +++ b/commands/post/meta/get.md @@ -2,6 +2,8 @@ Get meta field value. +Options added later: `--single` (2.12.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/post/revision.md b/commands/post/revision.md index 1767de1c..cf66aa71 100644 --- a/commands/post/revision.md +++ b/commands/post/revision.md @@ -2,6 +2,8 @@ Manages post revisions. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### EXAMPLES # Restore a post revision diff --git a/commands/post/revision/diff.md b/commands/post/revision/diff.md index a5d1f72f..5f7d5711 100644 --- a/commands/post/revision/diff.md +++ b/commands/post/revision/diff.md @@ -2,6 +2,8 @@ Shows the difference between two revisions. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/post/revision/prune.md b/commands/post/revision/prune.md index 0b3d9d30..4511b257 100644 --- a/commands/post/revision/prune.md +++ b/commands/post/revision/prune.md @@ -2,6 +2,8 @@ Deletes old post revisions. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/post/revision/restore.md b/commands/post/revision/restore.md index 67c1cf15..2cbc083a 100644 --- a/commands/post/revision/restore.md +++ b/commands/post/revision/restore.md @@ -2,6 +2,8 @@ Restores a post revision. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/post/update.md b/commands/post/update.md index 6bd33fac..04711ba9 100644 --- a/commands/post/update.md +++ b/commands/post/update.md @@ -86,6 +86,9 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--meta_input=<meta_input>] : Array in JSON format of post meta values keyed by their post meta key. Default empty. +[\--page_template=<page_template>] +: Page template to use. + [<file>] : Read post content from <file>. If this value is present, the `--post_content` argument will be ignored. diff --git a/commands/post/url-to-id.md b/commands/post/url-to-id.md index 4f2f2887..9823d97b 100644 --- a/commands/post/url-to-id.md +++ b/commands/post/url-to-id.md @@ -2,6 +2,8 @@ Gets the post ID for a given URL. +Available since WP-CLI 2.10.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/search-replace.md b/commands/search-replace.md index f34ebecb..6be6314a 100644 --- a/commands/search-replace.md +++ b/commands/search-replace.md @@ -2,6 +2,8 @@ Searches/replaces strings in the database. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--old`, `--new`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Searches through all rows in a selection of tables and replaces appearances of the first string with the second string. By default, the command uses tables registered to the `$wpdb` object. On multisite, this will just be the tables for the current site unless `--network` is specified. diff --git a/commands/server.md b/commands/server.md index fc68dabd..0a7401e2 100644 --- a/commands/server.md +++ b/commands/server.md @@ -4,6 +4,8 @@ Launches PHP's built-in web server for a specific WordPress installation. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--adapt-scheme`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Uses `php -S` to launch a web server serving the WordPress webroot. <http://php.net/manual/en/features.commandline.webserver.php> diff --git a/commands/shell.md b/commands/shell.md index bccfcb6e..63a295a6 100644 --- a/commands/shell.md +++ b/commands/shell.md @@ -2,6 +2,8 @@ Opens an interactive PHP console for running and testing PHP code. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--watch`, `--hook`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + `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. diff --git a/commands/sidebar/exists.md b/commands/sidebar/exists.md index ea469f0d..6e2dbb48 100644 --- a/commands/sidebar/exists.md +++ b/commands/sidebar/exists.md @@ -2,6 +2,8 @@ Check if a sidebar exists. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/sidebar/get.md b/commands/sidebar/get.md index 7f8e8aff..498dc94c 100644 --- a/commands/sidebar/get.md +++ b/commands/sidebar/get.md @@ -2,6 +2,8 @@ Get details about a specific sidebar. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/sidebar/list.md b/commands/sidebar/list.md index 9816987c..b65a2f99 100644 --- a/commands/sidebar/list.md +++ b/commands/sidebar/list.md @@ -2,6 +2,8 @@ Lists registered sidebars. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--inactive`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site-health.md b/commands/site-health.md index 96565622..34a4d5bf 100644 --- a/commands/site-health.md +++ b/commands/site-health.md @@ -2,6 +2,8 @@ Manage Site Health +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + diff --git a/commands/site-health/check.md b/commands/site-health/check.md index 537c4b4f..18be1a62 100644 --- a/commands/site-health/check.md +++ b/commands/site-health/check.md @@ -2,6 +2,8 @@ Run site health checks. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site-health/info.md b/commands/site-health/info.md index 36e819f2..2fa18ab4 100644 --- a/commands/site-health/info.md +++ b/commands/site-health/info.md @@ -2,6 +2,8 @@ Displays site health info. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site-health/list-info-sections.md b/commands/site-health/list-info-sections.md index 05853898..563fc50c 100644 --- a/commands/site-health/list-info-sections.md +++ b/commands/site-health/list-info-sections.md @@ -2,6 +2,8 @@ List site health info sections. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site-health/status.md b/commands/site-health/status.md index bffdf8ce..2a800c67 100644 --- a/commands/site-health/status.md +++ b/commands/site-health/status.md @@ -2,6 +2,8 @@ Check site health status. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### EXAMPLES # Check site health status. diff --git a/commands/site/activate.md b/commands/site/activate.md index 03603ef7..b53c7a50 100644 --- a/commands/site/activate.md +++ b/commands/site/activate.md @@ -2,6 +2,8 @@ Activates one or more sites. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/archive.md b/commands/site/archive.md index 5e34c673..fad77eb9 100644 --- a/commands/site/archive.md +++ b/commands/site/archive.md @@ -2,6 +2,8 @@ Archives one or more sites. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/create.md b/commands/site/create.md index d520dd4a..63e9599f 100644 --- a/commands/site/create.md +++ b/commands/site/create.md @@ -2,6 +2,8 @@ Creates a site in a multisite installation. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--site-url`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/deactivate.md b/commands/site/deactivate.md index b9eba939..e2137d60 100644 --- a/commands/site/deactivate.md +++ b/commands/site/deactivate.md @@ -2,6 +2,8 @@ Deactivates one or more sites. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/delete.md b/commands/site/delete.md index 90c8ff38..705eb09e 100644 --- a/commands/site/delete.md +++ b/commands/site/delete.md @@ -2,6 +2,8 @@ Deletes a site in a multisite installation. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--delete-tables-with-prefix`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/generate.md b/commands/site/generate.md index 633ba7f2..39f26765 100644 --- a/commands/site/generate.md +++ b/commands/site/generate.md @@ -2,6 +2,8 @@ Generate some sites. +Available since WP-CLI 2.11.0. + Creates a specified number of new sites. ### OPTIONS diff --git a/commands/site/get.md b/commands/site/get.md index 64527a49..d6a97a01 100644 --- a/commands/site/get.md +++ b/commands/site/get.md @@ -2,6 +2,8 @@ Gets details about a site in a multisite installation. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/list.md b/commands/site/list.md index 32cd354b..d5b9d55f 100644 --- a/commands/site/list.md +++ b/commands/site/list.md @@ -6,23 +6,131 @@ Lists all sites 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. -[\--network=<id>] -: The network to which the sites belong. +[\--network=<id>|site_id|network_id] +: The network to which the sites belong. `--site_id` is the name of the column this filters, `--network_id` is WP_Site_Query's name for it, and both are accepted as aliases. `--network` wins when more than one is given. [\--<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. Note: '--path' conflicts with the global parameter of the same name; use +: Filter by one or more fields (see "Available Fields" section), or pass any other argument accepted by WP_Site_Query. However, '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). +[\--site__not_in=<value>] +: Exclude the sites with these blog_id values (comma-separated). + [\--site_user=<value>] : Only list the sites with this user. [\--site-path=<path>] : Filter by path. Avoids conflict with the global `--path` parameter. +[\--path__in=<value>] +: Only list the sites with these paths (comma-separated). + +[\--path__not_in=<value>] +: Exclude the sites with these paths (comma-separated). + +[\--blog_id=<blog_id>|ID] +: Filter by site ID. `--ID` is WP_Site_Query's name for the same filter and is accepted as an alias. + +[\--network__in=<value>] +: Only list the sites belonging to these network IDs (comma-separated). + +[\--network__not_in=<value>] +: Exclude the sites belonging to these network IDs (comma-separated). + +[\--domain=<domain>] +: Filter by domain. + +[\--domain__in=<value>] +: Only list the sites with these domains (comma-separated). + +[\--domain__not_in=<value>] +: Exclude the sites with these domains (comma-separated). + +[\--registered=<date>] +: Filter by the date the site was registered. Accepts a timestamp or a date; a value carrying no time of day matches that whole day. + +[\--last_updated=<date>] +: Filter by the date the site was last updated. Accepts a timestamp or a date; a value carrying no time of day matches that whole day. + +[\--public=<public>] +: Filter by whether the site is public. Accepts 1 or 0. + +[\--archived=<archived>] +: Filter by whether the site is archived. Accepts 1 or 0. + +[\--mature=<mature>] +: Filter by whether the site is flagged as mature. Accepts 1 or 0. + +[\--spam=<spam>] +: Filter by whether the site is flagged as spam. Accepts 1 or 0. + +[\--deleted=<deleted>] +: Filter by whether the site is flagged as deleted. Accepts 1 or 0. + +[\--lang_id=<lang_id>] +: Filter by language ID. + +[\--lang__in=<value>] +: Only list the sites with these language IDs (comma-separated). + +[\--lang__not_in=<value>] +: Exclude the sites with these language IDs (comma-separated). + +[\--search=<string>] +: Only list the sites matching this search term. Searches the domain and path columns unless `--search_columns` narrows it. + +[\--search_columns=<columns>] +: Comma-separated list of columns `--search` looks in. Accepts 'domain' +and 'path'. + +[\--meta_key=<meta_key>] +: Filter by this site meta key. The site meta arguments need WordPress 5.1 or later, which is where multisite gained the table they read. + +[\--meta_value=<meta_value>] +: Filter by this site meta value. Used together with `--meta_key`. + +[\--meta_compare=<meta_compare>] +: Operator to test the meta value against. Accepts the operators WP_Meta_Query supports, such as '=', '!=', 'LIKE' or 'IN'. + +[\--meta_type=<meta_type>] +: Cast the meta value to this type, such as 'NUMERIC' or 'DATE'. + +[\--meta_query=<meta_query>] +: A WP_Meta_Query clause list, as JSON, for conditions the meta_* arguments above cannot express. + +[\--date_query=<date_query>] +: A WP_Date_Query clause list, as JSON, for ranges `--registered` and `--last_updated` cannot express. Giving those as well narrows this further rather than replacing it. + +[\--number=<number>] +: Limit the number of sites returned. + +[\--offset=<offset>] +: Number of sites to skip. Used together with `--number`. + +[\--no_found_rows=<no_found_rows>] +: Whether to skip counting the total rows the query matches. Accepts 1 or 0. + +[\--update_site_cache=<update_site_cache>] +: Whether to prime the object cache with the sites found. Accepts 1 or 0. Turning it off saves work when listing a large network once. + +[\--update_site_meta_cache=<update_site_meta_cache>] +: Whether to prime the object cache with the site meta of the sites found. Accepts 1 or 0. + +[\--orderby=<field>] +: Order the results by this field, such as 'blog_id', 'domain', 'path', +'registered', 'last_updated' or 'site__in'. + +[\--order=<order>] +: Whether to order the results ascending or descending. +\--- +options: + - asc + - desc +\--- + [\--field=<field>] : Prints the value of a single field for each site. @@ -70,6 +178,15 @@ These fields are optionally available: http://www.example.com/ http://www.example.com/subdir/ + # Output site URLs, most recently registered first + $ wp site list --orderby=registered --order=desc --field=url + http://www.example.com/subdir/ + http://www.example.com/ + + # Search for sites by domain or path + $ wp site list --search=subdir --field=url + http://www.example.com/subdir/ + ### 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. diff --git a/commands/site/mature.md b/commands/site/mature.md index 58c6d7c0..fc7a409b 100644 --- a/commands/site/mature.md +++ b/commands/site/mature.md @@ -2,6 +2,8 @@ Sets one or more sites as mature. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/meta/get.md b/commands/site/meta/get.md index bbe7cc69..c13f4419 100644 --- a/commands/site/meta/get.md +++ b/commands/site/meta/get.md @@ -2,6 +2,8 @@ Get meta field value. +Options added later: `--single` (2.12.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/private.md b/commands/site/private.md index c6ea5c3a..7572f28f 100644 --- a/commands/site/private.md +++ b/commands/site/private.md @@ -2,6 +2,8 @@ Sets one or more sites as private. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/public.md b/commands/site/public.md index dec101dd..b1de4e11 100644 --- a/commands/site/public.md +++ b/commands/site/public.md @@ -2,6 +2,8 @@ Sets one or more sites as public. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/spam.md b/commands/site/spam.md index 73edb733..bc442196 100644 --- a/commands/site/spam.md +++ b/commands/site/spam.md @@ -2,6 +2,8 @@ Marks one or more sites as spam. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/unarchive.md b/commands/site/unarchive.md index afb5c567..9d907986 100644 --- a/commands/site/unarchive.md +++ b/commands/site/unarchive.md @@ -2,6 +2,8 @@ Unarchives one or more sites. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/unmature.md b/commands/site/unmature.md index 3c8cc101..65cfcb7c 100644 --- a/commands/site/unmature.md +++ b/commands/site/unmature.md @@ -2,6 +2,8 @@ Sets one or more sites as immature. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/site/unspam.md b/commands/site/unspam.md index bf1026a3..34363a9f 100644 --- a/commands/site/unspam.md +++ b/commands/site/unspam.md @@ -2,6 +2,8 @@ Removes one or more sites from spam. +Options added later: `--slug` (2.9.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/term/meta/get.md b/commands/term/meta/get.md index 86838305..3cf7bab0 100644 --- a/commands/term/meta/get.md +++ b/commands/term/meta/get.md @@ -2,6 +2,8 @@ Get meta field value. +Options added later: `--single` (2.12.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/term/prune.md b/commands/term/prune.md index f2e7c2ef..33cf418f 100644 --- a/commands/term/prune.md +++ b/commands/term/prune.md @@ -2,6 +2,8 @@ Removes terms with 0 or 1 published posts from one or more taxonomies. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + 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 diff --git a/commands/theme/auto-updates.md b/commands/theme/auto-updates.md index 25bf01dd..d268ac0d 100644 --- a/commands/theme/auto-updates.md +++ b/commands/theme/auto-updates.md @@ -2,6 +2,8 @@ Manages theme auto-updates. +Available since WP-CLI 2.5.0. + ### EXAMPLES # Enable the auto-updates for a theme diff --git a/commands/theme/auto-updates/disable.md b/commands/theme/auto-updates/disable.md index 11c896f7..1f5e4b9c 100644 --- a/commands/theme/auto-updates/disable.md +++ b/commands/theme/auto-updates/disable.md @@ -2,6 +2,8 @@ Disables the auto-updates for a theme. +Available since WP-CLI 2.5.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/theme/auto-updates/enable.md b/commands/theme/auto-updates/enable.md index 778220cb..76e71a20 100644 --- a/commands/theme/auto-updates/enable.md +++ b/commands/theme/auto-updates/enable.md @@ -2,6 +2,8 @@ Enables the auto-updates for a theme. +Available since WP-CLI 2.5.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/theme/auto-updates/status.md b/commands/theme/auto-updates/status.md index cd650924..7c5d43f3 100644 --- a/commands/theme/auto-updates/status.md +++ b/commands/theme/auto-updates/status.md @@ -2,6 +2,8 @@ Shows the status of auto-updates for a theme. +Available since WP-CLI 2.5.0. Options added later: `--format` (2.8.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/theme/check-update.md b/commands/theme/check-update.md index deee07bd..f3df306c 100644 --- a/commands/theme/check-update.md +++ b/commands/theme/check-update.md @@ -2,6 +2,8 @@ Checks for theme updates without performing them. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Lists the available theme updates. Similar to `wp core check-update`. ### OPTIONS diff --git a/commands/theme/download.md b/commands/theme/download.md index f775ff8d..00b5b372 100644 --- a/commands/theme/download.md +++ b/commands/theme/download.md @@ -4,6 +4,8 @@ Downloads a theme zip package without loading WordPress. This command runs on the `before_wp_load` hook, just before the WP load process begins. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/theme/install.md b/commands/theme/install.md index e449f164..08733a4a 100644 --- a/commands/theme/install.md +++ b/commands/theme/install.md @@ -2,6 +2,10 @@ Installs one or more themes. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--slug`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--ignore-requirements` (2.12.0), `--insecure` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/theme/update.md b/commands/theme/update.md index 15729ab9..4d4b919a 100644 --- a/commands/theme/update.md +++ b/commands/theme/update.md @@ -4,6 +4,10 @@ Updates one or more themes. **Alias:** `upgrade` +> **Note:** The following options are not part of a stable WP-CLI release yet: `--auto-update-indicated`, `--include-vcs`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--minor` (2.10.0), `--patch` (2.10.0), `--insecure` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/theme/upgrade.md b/commands/theme/upgrade.md index 2719599d..4ae72f55 100644 --- a/commands/theme/upgrade.md +++ b/commands/theme/upgrade.md @@ -4,6 +4,10 @@ Updates one or more themes. This is an alias for `wp theme update`. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--auto-update-indicated`, `--include-vcs`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + +Options added later: `--minor` (2.10.0), `--patch` (2.10.0), `--insecure` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/transient/patch.md b/commands/transient/patch.md index dded1bb6..93085a9c 100644 --- a/commands/transient/patch.md +++ b/commands/transient/patch.md @@ -2,6 +2,8 @@ Update a nested value from a transient. +Available since WP-CLI 2.12.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/transient/pluck.md b/commands/transient/pluck.md index c5e16a97..b898c570 100644 --- a/commands/transient/pluck.md +++ b/commands/transient/pluck.md @@ -2,6 +2,8 @@ Get a nested value from a transient. +Available since WP-CLI 2.12.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/application-password.md b/commands/user/application-password.md index adb91937..7661a0e6 100644 --- a/commands/user/application-password.md +++ b/commands/user/application-password.md @@ -2,6 +2,8 @@ Creates, updates, deletes, lists and retrieves application passwords. +Available since WP-CLI 2.6.0. + ### EXAMPLES # List user application passwords and only show app name and password hash diff --git a/commands/user/application-password/create.md b/commands/user/application-password/create.md index 91090471..b7fe60b8 100644 --- a/commands/user/application-password/create.md +++ b/commands/user/application-password/create.md @@ -2,6 +2,8 @@ Creates a new application password. +Available since WP-CLI 2.6.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/application-password/delete.md b/commands/user/application-password/delete.md index 8426c169..e84bafd4 100644 --- a/commands/user/application-password/delete.md +++ b/commands/user/application-password/delete.md @@ -2,6 +2,8 @@ Delete an existing application password. +Available since WP-CLI 2.6.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/application-password/exists.md b/commands/user/application-password/exists.md index 7cae9079..949ac13b 100644 --- a/commands/user/application-password/exists.md +++ b/commands/user/application-password/exists.md @@ -2,6 +2,8 @@ Checks whether an application password for a given application exists. +Available since WP-CLI 2.6.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/application-password/get.md b/commands/user/application-password/get.md index 126bc2c0..58478f82 100644 --- a/commands/user/application-password/get.md +++ b/commands/user/application-password/get.md @@ -2,6 +2,8 @@ Gets a specific application password. +Available since WP-CLI 2.6.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/application-password/list.md b/commands/user/application-password/list.md index 51533690..482b2c60 100644 --- a/commands/user/application-password/list.md +++ b/commands/user/application-password/list.md @@ -2,6 +2,8 @@ Lists all application passwords associated with a user. +Available since WP-CLI 2.6.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -12,6 +14,27 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg [\--<field>=<value>] : Filter the list by a specific field. +[\--uuid=<uuid>] +: Filter by the universally unique ID of the application password. + +[\--app_id=<app_id>|app-id] +: Filter by the application ID. `--app-id` is accepted as an alias. + +[\--name=<name>] +: Filter by the name of the application password. + +[\--password=<password>] +: Filter by the hashed password. + +[\--created=<created>] +: Filter by the Unix timestamp the application password was created at. + +[\--last_used=<last_used>|last-used] +: Filter by the Unix timestamp the application password was last used at. `--last-used` is accepted as an alias. + +[\--last_ip=<last_ip>|last-ip] +: Filter by the IP address the application password was last used from. `--last-ip` is accepted as an alias. + [\--field=<field>] : Prints the value of a single field for each application password. diff --git a/commands/user/application-password/record-usage.md b/commands/user/application-password/record-usage.md index fcba73d9..384e2b00 100644 --- a/commands/user/application-password/record-usage.md +++ b/commands/user/application-password/record-usage.md @@ -2,6 +2,8 @@ Record usage of an application password. +Available since WP-CLI 2.6.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/application-password/update.md b/commands/user/application-password/update.md index 8c5b61fb..50fede60 100644 --- a/commands/user/application-password/update.md +++ b/commands/user/application-password/update.md @@ -2,6 +2,8 @@ Updates an existing application password. +Available since WP-CLI 2.6.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -12,8 +14,8 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg <uuid> : The universally unique ID of the application password. -[\--<field>=<value>] -: Update the <field> with a new <value>. Currently supported fields: name. +[\--name=<name>] +: The new name of the application password. ### EXAMPLES diff --git a/commands/user/check-password.md b/commands/user/check-password.md index ade1d136..a8a3c13f 100644 --- a/commands/user/check-password.md +++ b/commands/user/check-password.md @@ -2,6 +2,8 @@ Checks if a user's password is valid or not. +Options added later: `--escape-chars` (2.5.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/create.md b/commands/user/create.md index 70de9c75..e02c3cd2 100644 --- a/commands/user/create.md +++ b/commands/user/create.md @@ -2,6 +2,8 @@ Creates a new user. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--syntax_highlighting`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. @@ -43,7 +45,10 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : A string containing content about the user. [\--rich_editing=<rich_editing>] -: A string for whether to enable the rich editor or not. False if not empty. +: Whether to enable the rich editor for the user. Accepts 'true' or 'false', or their numeric forms 1 and 0. Default: true + +[\--syntax_highlighting=<syntax_highlighting>] +: Whether to enable the rich code editor for the user. Accepts 'true' or 'false', or their numeric forms 1 and 0. Default: true [\--send-email] : Send an email to the user with their new account details. diff --git a/commands/user/exists.md b/commands/user/exists.md index 6eff5dfe..aab753b2 100644 --- a/commands/user/exists.md +++ b/commands/user/exists.md @@ -2,6 +2,8 @@ Verifies whether a user exists. +Available since WP-CLI 2.11.0. + Displays a success message if the user does exist. ### OPTIONS diff --git a/commands/user/list-caps.md b/commands/user/list-caps.md index cb75c73c..232df133 100644 --- a/commands/user/list-caps.md +++ b/commands/user/list-caps.md @@ -2,6 +2,8 @@ Lists all capabilities for a user. +Options added later: `--origin` (2.10.0), `--exclude-role-names` (2.10.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/list.md b/commands/user/list.md index 8eae39ff..ae8515d6 100644 --- a/commands/user/list.md +++ b/commands/user/list.md @@ -60,7 +60,6 @@ These fields are optionally available: * caps * cap_key * allcaps -* filter * url ### EXAMPLES diff --git a/commands/user/privacy-request.md b/commands/user/privacy-request.md index dabe4115..5f8a3754 100644 --- a/commands/user/privacy-request.md +++ b/commands/user/privacy-request.md @@ -2,6 +2,8 @@ Manages user privacy requests (GDPR personal data export and erasure). +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### EXAMPLES # List all privacy requests. diff --git a/commands/user/privacy-request/complete.md b/commands/user/privacy-request/complete.md index c6549bbb..b6a12f65 100644 --- a/commands/user/privacy-request/complete.md +++ b/commands/user/privacy-request/complete.md @@ -2,6 +2,8 @@ Marks one or more privacy requests as completed. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/privacy-request/create.md b/commands/user/privacy-request/create.md index 2fea653d..1b280995 100644 --- a/commands/user/privacy-request/create.md +++ b/commands/user/privacy-request/create.md @@ -2,6 +2,8 @@ Creates a privacy request for a user. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/privacy-request/delete.md b/commands/user/privacy-request/delete.md index 3b893b8c..bae4eee0 100644 --- a/commands/user/privacy-request/delete.md +++ b/commands/user/privacy-request/delete.md @@ -2,6 +2,8 @@ Deletes one or more privacy requests. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/privacy-request/erase.md b/commands/user/privacy-request/erase.md index feb25331..f86ef08b 100644 --- a/commands/user/privacy-request/erase.md +++ b/commands/user/privacy-request/erase.md @@ -2,6 +2,8 @@ Erases personal data for a given privacy request. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Runs all registered data erasers for the email address associated with the request, then marks the request as completed. ### OPTIONS diff --git a/commands/user/privacy-request/export.md b/commands/user/privacy-request/export.md index 7ee21725..1730a972 100644 --- a/commands/user/privacy-request/export.md +++ b/commands/user/privacy-request/export.md @@ -2,6 +2,8 @@ Exports personal data for a given privacy request. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + 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 diff --git a/commands/user/privacy-request/list.md b/commands/user/privacy-request/list.md index 4757c412..1070705c 100644 --- a/commands/user/privacy-request/list.md +++ b/commands/user/privacy-request/list.md @@ -2,6 +2,8 @@ Lists privacy requests. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/remove-cap.md b/commands/user/remove-cap.md index 120da503..4fe6ecf5 100644 --- a/commands/user/remove-cap.md +++ b/commands/user/remove-cap.md @@ -2,6 +2,8 @@ Removes a user's capability. +Options added later: `--force` (2.12.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/reset-password.md b/commands/user/reset-password.md index bb98b440..6fd62698 100644 --- a/commands/user/reset-password.md +++ b/commands/user/reset-password.md @@ -2,6 +2,8 @@ Resets the password for one or more users. +Options added later: `--show-password` (2.8.0), `--porcelain` (2.8.0). + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/signup.md b/commands/user/signup.md index 81105c60..545457b9 100644 --- a/commands/user/signup.md +++ b/commands/user/signup.md @@ -2,6 +2,8 @@ Manages signups on a multisite installation. +Available since WP-CLI 2.11.0. + ### EXAMPLES # List signups. diff --git a/commands/user/signup/activate.md b/commands/user/signup/activate.md index 0ab5ba10..bfd59736 100644 --- a/commands/user/signup/activate.md +++ b/commands/user/signup/activate.md @@ -2,6 +2,8 @@ Activates one or more signups. +Available since WP-CLI 2.11.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/signup/delete.md b/commands/user/signup/delete.md index a11b2f1d..6947bc4f 100644 --- a/commands/user/signup/delete.md +++ b/commands/user/signup/delete.md @@ -2,6 +2,8 @@ Deletes one or more signups. +Available since WP-CLI 2.11.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/signup/get.md b/commands/user/signup/get.md index 8a8530de..ef1138f8 100644 --- a/commands/user/signup/get.md +++ b/commands/user/signup/get.md @@ -2,6 +2,8 @@ Gets details about a signup. +Available since WP-CLI 2.11.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/signup/list.md b/commands/user/signup/list.md index e6a7baec..04a47d13 100644 --- a/commands/user/signup/list.md +++ b/commands/user/signup/list.md @@ -2,6 +2,8 @@ Lists signups. +Available since WP-CLI 2.11.0. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/user/unspam.md b/commands/user/unspam.md index bebb59e9..b012ee0f 100644 --- a/commands/user/unspam.md +++ b/commands/user/unspam.md @@ -14,7 +14,7 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg # Remove user from spam. $ wp user unspam 123 User 123 removed from spam. - Success: Unspamed 1 of 1 users. + Success: Unspammed 1 of 1 users. ### GLOBAL PARAMETERS diff --git a/commands/user/update.md b/commands/user/update.md index 8dcccb93..88fd8034 100644 --- a/commands/user/update.md +++ b/commands/user/update.md @@ -37,14 +37,41 @@ See the [argument syntax](https://make.wordpress.org/cli/handbook/references/arg : A string containing content about the user. [\--rich_editing=<rich_editing>] -: A string for whether to enable the rich editor or not. False if not empty. +: Whether to enable the rich editor for the user. Accepts 'true' or 'false', or their numeric forms 1 and 0. + +[\--syntax_highlighting=<syntax_highlighting>] +: Whether to enable the rich code editor for the user. Accepts 'true' or 'false', or their numeric forms 1 and 0. + +[\--comment_shortcuts=<comment_shortcuts>] +: Whether to enable comment moderation keyboard shortcuts for the user. Accepts 'true' or 'false' as a string literal, not boolean. + +[\--admin_color=<admin_color>] +: Admin color scheme for the user. + +[\--use_ssl=<use_ssl>] +: Whether the user should always access the admin over https. [\--user_registered=<yyyy-mm-dd-hh-ii-ss>] : The date the user registered. +[\--user_activation_key=<user_activation_key>] +: Password reset key. + +[\--spam=<spam>] +: Multisite only. Whether the user is marked as spam. + +[\--show_admin_bar_front=<show_admin_bar_front>] +: Whether to display the admin bar for the user on the site's front end. Accepts 'true' or 'false' as a string literal, not boolean. + [\--role=<role>] : A string used to set the user's role. +[\--locale=<locale>] +: The user's locale. + +[\--meta_input=<meta_input>] +: Array in JSON format of user meta values keyed by their user meta key. + \--<field>=<value> : One or more fields to update. For accepted fields, see wp_update_user(). diff --git a/commands/widget/patch.md b/commands/widget/patch.md index 8fbd06a9..6daabbd2 100644 --- a/commands/widget/patch.md +++ b/commands/widget/patch.md @@ -2,6 +2,8 @@ Updates a nested value in a widget's options. +> **Note:** This command is not part of a stable WP-CLI release yet. To use it now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + ### OPTIONS See the [argument syntax](https://make.wordpress.org/cli/handbook/references/argument-syntax/) reference for a detailed explanation of the syntax conventions used. diff --git a/commands/widget/reset.md b/commands/widget/reset.md index 6f3b1bae..c2b99f4c 100644 --- a/commands/widget/reset.md +++ b/commands/widget/reset.md @@ -2,6 +2,8 @@ Resets sidebar. +> **Note:** The following options are not part of a stable WP-CLI release yet: `--inactive`. To use them now, [switch to the nightly build](https://make.wordpress.org/cli/handbook/guides/installing/#updating-wp-cli) with `wp cli update --nightly`. If you installed the command as a separate package, updating that package may be enough. + Removes all widgets from the sidebar and places them in Inactive Widgets. ### OPTIONS