README

添加、移动和删除小工具；列出侧边栏。

使用

此包实现了以下命令

wp widget

管理小工具，包括在侧边栏内添加和移动它们。

wp widget

小工具可以向小工具区域（也称为侧边栏）添加内容和功能。

示例

# List widgets on a given sidebar
$ wp widget list sidebar-1
+----------+------------+----------+----------------------+
| name     | id         | position | options              |
+----------+------------+----------+----------------------+
| meta     | meta-6     | 1        | {"title":"Meta"}     |
| calendar | calendar-2 | 2        | {"title":"Calendar"} |
+----------+------------+----------+----------------------+

# Add a calendar widget to the second position on the sidebar
$ wp widget add calendar sidebar-1 2
Success: Added widget to sidebar.

# Update option(s) associated with a given widget
$ wp widget update calendar-1 --title="Calendar"
Success: Widget updated.

# Delete one or more widgets entirely
$ wp widget delete calendar-2 archive-1
Success: 2 widgets removed from sidebar.

wp widget add

向侧边栏添加小工具。

wp widget add <name> <sidebar-id> [<position>] [--<field>=<value>]

在数据库中创建一个新的小工具条目，并将其与侧边栏关联。

选项

<name>
	Widget name.

<sidebar-id>
	ID for the corresponding sidebar.

[<position>]
	Widget's current position within the sidebar. Defaults to last

[--<field>=<value>]
	Widget option to add, with its new value

示例

# Add a new calendar widget to sidebar-1 with title "Calendar"
$ wp widget add calendar sidebar-1 2 --title="Calendar"
Success: Added widget to sidebar.

wp widget deactivate

从活动侧边栏中停用一个或多个小工具。

wp widget deactivate <widget-id>...

将小工具移动到“非活动小工具”。

选项

<widget-id>...
	Unique ID for the widget(s)

示例

# Deactivate the recent-comments-2 widget.
$ wp widget deactivate recent-comments-2
Success: 1 widget deactivated.

wp widget delete

从侧边栏删除一个或多个小工具。

wp widget delete <widget-id>...

选项

<widget-id>...
	Unique ID for the widget(s)

示例

# Delete the recent-comments-2 widget from its sidebar.
$ wp widget delete recent-comments-2
Success: Deleted 1 of 1 widgets.

wp widget list

列出与侧边栏相关的小工具。

wp widget list <sidebar-id> [--fields=<fields>] [--format=<format>]

选项

<sidebar-id>
	ID for the corresponding sidebar.

[--fields=<fields>]
	Limit the output to specific object fields.

[--format=<format>]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - ids
	  - json
	  - count
	  - yaml
	---

可用字段

以下字段将默认显示在每个小工具中

name
id
position
options

没有可选字段。

示例

$ wp widget list sidebar-1 --fields=name,id --format=csv
name,id
meta,meta-5
search,search-3

wp widget move

移动小工具的位置。

wp widget move <widget-id> [--position=<position>] [--sidebar-id=<sidebar-id>]

更改小工具在现有侧边栏中的顺序，或将其移动到新的侧边栏。

选项

<widget-id>
	Unique ID for the widget

[--position=<position>]
	Assign the widget to a new position.

[--sidebar-id=<sidebar-id>]
	Assign the widget to a new sidebar

示例

# Change position of widget
$ wp widget move recent-comments-2 --position=2
Success: Widget moved.

# Move widget to Inactive Widgets
$ wp widget move recent-comments-2 --sidebar-id=wp_inactive_widgets
Success: Widget moved.

wp widget reset

重置侧边栏。

wp widget reset [<sidebar-id>...] [--all]

从侧边栏删除所有小工具，并将它们放入“非活动小工具”。

选项

[<sidebar-id>...]
	One or more sidebars to reset.

[--all]
	If set, all sidebars will be reset.

示例

# Reset a sidebar
$ wp widget reset sidebar-1
Success: Sidebar 'sidebar-1' reset.

# Reset multiple sidebars
$ wp widget reset sidebar-1 sidebar-2
Success: Sidebar 'sidebar-1' reset.
Success: Sidebar 'sidebar-2' reset.

# Reset all sidebars
$ wp widget reset --all
Success: Sidebar 'sidebar-1' reset.
Success: Sidebar 'sidebar-2' reset.
Success: Sidebar 'sidebar-3' reset.

wp widget update

更新现有小工具的选项。

wp widget update <widget-id> [--<field>=<value>]

选项

<widget-id>
	Unique ID for the widget

[--<field>=<value>]
	Field to update, with its new value

示例

# Change calendar-1 widget title to "Our Calendar"
$ wp widget update calendar-1 --title="Our Calendar"
Success: Widget updated.

wp sidebar

列出已注册的侧边栏。

wp sidebar

侧边栏是主题的任何小工具区域。

示例

# List sidebars
$ wp sidebar list --fields=name,id --format=csv
name,id
"Widget Area",sidebar-1
"Inactive Widgets",wp_inactive_widgets

wp sidebar list

列出已注册的侧边栏。

wp sidebar list [--fields=<fields>] [--format=<format>]

选项

[--fields=<fields>]
	Limit the output to specific object fields.

[--format=<format>]
	Render output in a particular format.
	---
	default: table
	options:
	  - table
	  - csv
	  - json
	  - ids
	  - count
	  - yaml
	---

可用字段

以下字段将默认显示在每个侧边栏中

name
id
description

以下字段是可选的

class
before_widget
after_widget
before_title
after_title

示例

$ wp sidebar list --fields=name,id --format=csv
name,id
"Widget Area",sidebar-1
"Inactive Widgets",wp_inactive_widgets

安装

此包包含在WP-CLI本身中，无需额外安装。

要安装此包的最新版本（超过WP-CLI中包含的版本），请运行

wp package install [email protected]:wp-cli/widget-command.git

贡献

我们感谢您主动为该项目做出贡献。

贡献不仅限于代码。我们鼓励您以最适合您能力的方式做出贡献，例如编写教程、在当地聚会中演示、帮助其他用户解决支持问题或修订我们的文档。

要获取更详细的介绍，请查看WP-CLI的贡献指南。此包遵循那些政策和指南。

报告错误

认为你发现了一个错误？我们很乐意你帮助我们修复它。

在创建新问题之前，你应该搜索现有问题，以查看是否已存在对该问题的解决方案，或者它是否已在更新的版本中修复。

一旦您进行了一些搜索，发现没有针对您错误的开放或固定问题，请创建一个新问题。尽可能提供详细信息，如果可能，请提供重现步骤。更多指导，请查看我们的错误报告文档。

创建 pull request

想要贡献一个新功能？请首先打开一个新问题，讨论该功能是否适合本项目。

一旦您决定投入时间完成您的 pull request，请遵循我们创建 pull request 的指南，以确保这是一个愉快的体验。有关在本地工作于此包的详细信息，请查看"设置"。

支持

GitHub 的问题不适用于一般支持问题，但您还可以尝试其他途径：https://wp-cli.org/#support

此 README.md 是使用 wp scaffold package-readme（文档）从项目的代码库动态生成的。要建议更改，请向代码库的相应部分提交 pull request。

wp-cli/widget-command

维护者

详细信息