在WordPress中创建自定义小工具通常涉及以下几个步骤:
- 定义小工具类:创建一个继承自
WP_Widget
的类。 - 注册小工具:在
widgets_init
动作钩子中注册你的小工具类。 - 实现小工具的表单:在自定义类中实现
form()
方法,用于在后台管理界面显示表单。 - 更新小工具的设置:在自定义类中实现
update()
方法,用于处理表单提交的数据。 - 输出小工具的内容:在自定义类中实现
widget()
方法,用于在前端显示小工具的内容。
以下是创建自定义小工具的一个基本示例:
<?php
// 在主题的 functions.php 文件中或在一个单独的插件文件中添加以下代码
// 定义 My_Widget 类
class My_Widget extends WP_Widget {
// 构造函数中设置小工具名称、描述等
public function __construct() {
parent::__construct(
'my_widget', // 小工具ID
'我的自定义小工具', // 小工具名称
array( 'description' => '这是一个自定义小工具的示例' ) // 小工具描述
);
}
// 后台表单
public function form( $instance ) {
// 如果之前有设置,则使用之前的设置,否则使用默认值
$title = ! empty( $instance['title'] ) ? $instance['title'] : esc_html__( '默认标题', 'text_domain' );
?>
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_attr_e( '标题:', 'text_domain' ); ?></label>
<input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>">
</p>
<?php
}
// 更新小工具设置
public function update( $new_instance, $old_instance ) {
$instance = array();
$instance['title'] = ( ! empty( $new_instance['title'] ) ) ? sanitize_text_field( $new_instance['title'] ) : '';
return $instance;
}
// 前端显示小工具
public function widget( $args, $instance ) {
echo $args['before_widget'];
if ( ! empty( $instance['title'] ) ) {
echo $args['before_title'] . apply_filters( 'widget_title', $instance['title'] ) . $args['after_title'];
}
// 输出小工具的内容
echo '<div>' . esc_html__( '这里是自定义小工具的内容。', 'text_domain' ) . '</div>';
echo $args['after_widget'];
}
}
// 注册小工具
function register_my_widget() {
register_widget( 'My_Widget' );
}
add_action( 'widgets_init', 'register_my_widget' );
在这个例子中,我们创建了一个名为My_Widget
的小工具类,它有一个可以设置标题的表单字段。form()
方法用于生成表单,update()
方法用于处理表单提交的数据,而widget()
方法用于输出小工具在前端页面的内容。
将上述代码添加到你的主题的functions.php
文件中或者创建一个插件,然后在WordPress后台的“外观”->“小工具”中你应该能看到名为“我的自定义小工具”的新小工具,你可以将它拖动到侧边栏并配置它的标题。