在WordPress中创建自定义小工具通常涉及以下步骤:
- 定义小工具类:创建一个新的PHP类,该类继承自
WP_Widget
。 - 注册小工具:使用
register_widget()
函数注册你的自定义小工具类。 - 实现小工具的前端显示:在小工具类中定义一个
widget()
方法来输出小工具在前端显示的内容。 - 实现小工具的表单:在小工具类中定义一个
form()
方法来输出小工具在后台的配置表单。 - 更新小工具的选项:在小工具类中定义一个
update()
方法来处理和保存小工具的选项。
下面是一个创建自定义小工具的基本示例:
<?php
// 确保只在WordPress环境中加载此代码
if (!defined('ABSPATH')) {
exit;
}
class My_Custom_Widget extends WP_Widget {
/**
* 设置小工具名称等
*/
public function __construct() {
parent::__construct(
'my_custom_widget', // 小工具ID
'我的自定义小工具', // 小工具名称
array( 'description' => '这是我的自定义小工具描述' ) // 小工具描述
);
}
/**
* 输出小工具在前端的内容
*
* @param array $args 小工具周围的HTML结构参数
* @param array $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 class="my-custom-widget-content">';
echo esc_html__( 'Hello, World!', 'text_domain' );
echo '</div>';
echo $args['after_widget']; // 小工具结束标签
}
/**
* 输出小工具在后台的表单
*
* @param array $instance 小工具的当前实例
*/
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
}
/**
* 更新小工具的选项
*
* @param array $new_instance 新的实例选项
* @param array $old_instance 旧的实例选项
* @return array 更新后的小工具实例
*/
public function update( $new_instance, $old_instance ) {
$instance = array();
$instance['title'] = ( ! empty( $new_instance['title'] ) ) ? sanitize_text_field( $new_instance['title'] ) : '';
return $instance;
}
}
// 注册小工具
function register_my_custom_widget() {
register_widget( 'My_Custom_Widget' );
}
add_action( 'widgets_init', 'register_my_custom_widget' );
将以上代码放入你的主题的functions.php
文件中或者创建一个插件来实现这个功能。保存文件后,你就可以在WordPress后台的“外观”->“小工具”部分找到并添加你的自定义小工具到侧边栏或其他小工具区域了。