在WordPress插件开发中,register_activation_hook()
函数用于注册一个在插件激活时运行的函数。这个函数会在插件被激活时执行一次,通常用于设置数据库表、创建配置选项等初始化操作。
以下是如何使用 register_activation_hook()
的步骤:
-
确定插件的文件路径。这通常是插件的主文件,例如
my-plugin.php
。 -
创建一个函数,这个函数将包含你希望在插件激活时运行的代码。
-
使用
register_activation_hook()
函数,传入插件文件路径和你创建的函数名。
下面是一个简单的示例:
<?php
/*
Plugin Name: My Custom Plugin
Description: A brief description of the plugin.
Version: 1.0
Author: Your Name
Author URI: http://yourwebsite.com/
*/
// 插件激活时调用的函数
function my_plugin_activate() {
// 这里编写你的插件激活逻辑
// 例如:创建数据库表、设置选项等
// 示例:添加一个选项
add_option('my_plugin_option', 'Option Value', '', 'yes');
}
// 注册激活钩子
register_activation_hook(__FILE__, 'my_plugin_activate');
在这个例子中,当插件被激活时,my_plugin_activate()
函数会被调用,并且会添加一个名为 my_plugin_option
的选项。
请确保在插件的主文件中(在这个例子中是 my-plugin.php
)使用 register_activation_hook()
,并且提供的函数 my_plugin_activate
是可用的。如果你的激活逻辑涉及到数据库操作,确保使用WordPress提供的函数如 global $wpdb;
来安全地执行这些操作。