在WordPress中创建自定义小工具(Widget)通常涉及以下步骤:
-
设置基础文件:创建一个新的PHP文件来定义你的小工具类。
-
定义小工具类:这个类需要继承自
WP_Widget
类。 -
注册小工具:使用
widgets_init
动作钩子来注册你的小工具。
下面是一个简单的示例,展示如何创建一个名为 "Simple Widget" 的自定义小工具:
步骤 1: 创建PHP文件
在你的主题目录(通常是 wp-content/themes/your-theme/
)或插件目录中创建一个新的PHP文件,例如 simple-widget.php
。
步骤 2: 定义小工具类
在 simple-widget.php
文件中,定义一个继承自 WP_Widget
的类:
<?php
class Simple_Widget extends WP_Widget {
/**
* 构造函数
*/
public function __construct() {
parent::__construct(
'simple_widget', // 小工具ID
'Simple Widget', // 小工具名称
array( 'description' => 'A simple widget example.' ) // 小工具描述
);
}
/**
* 输出小工具内容
*
* @param array $args 小工具参数
* @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>' . esc_html__( 'Hello, World!', 'text_domain' ) . '</div>';
echo $args['after_widget'];
}
/**
* 输出小工具表单
*
* @param array $instance 小工具实例
*/
public function form( $instance ) {
$title = ! empty( $instance['title'] ) ? $instance['title'] : esc_html__( 'New title', 'text_domain' );
?>
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_attr_e( 'Title:', '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;
}
}
步骤 3: 注册小工具
在 simple-widget.php
文件的底部,使用 widgets_init
钩子来注册小工具:
function register_simple_widget() {
register_widget( 'Simple_Widget' );
}
add_action( 'widgets_init', 'register_simple_widget' );
完成以上步骤后,你就可以在WordPress的“外观” > “小工具”部分找到并添加你的“Simple Widget”到小工具区域了。
请确保你的PHP文件被正确地放置在主题或插件目录中,并且WordPress能够加载它。如果遇到问题,你可能需要重新启动服务器或清除WordPress缓存。