在WordPress中,update_option()
和 get_option()
是两个非常常用的函数,用于存储和检索插件或主题的设置。以下是如何使用这两个函数的基本步骤:
1. 使用 update_option()
存储设置
update_option()
函数用于在WordPress数据库中创建或更新一个选项。它接受两个必填参数和一个可选参数:
$option
:选项名称(字符串),这应该是一个唯一的标识符,用于引用你的设置。$value
:要存储的值,可以是字符串、数组或任何可以被序列化的数据类型。$deprecated
(可选):已废弃的参数,通常不需要使用。$autoload
(可选):布尔值,指示是否在WordPress启动时自动加载此选项。默认为 'yes'。
以下是一个示例,演示如何使用 update_option()
存储一个简单的设置:
// 假设我们有一个设置名为 'my_plugin_settings'
$settings = array(
'setting1' => 'value1',
'setting2' => 'value2',
// 更多设置...
);
// 使用 update_option() 存储设置
update_option('my_plugin_settings', $settings);
2. 使用 get_option()
检索设置
get_option()
函数用于从WordPress数据库中检索一个选项的值。它接受一个必填参数和一个可选参数:
$option
:要检索的选项名称(字符串)。$default
(可选):如果选项不存在,则返回的默认值。
以下是一个示例,演示如何使用 get_option()
检索之前存储的设置:
// 检索名为 'my_plugin_settings' 的设置
$settings = get_option('my_plugin_settings', array());
// 检查是否成功检索到设置,如果没有,使用默认值
if (is_array($settings)) {
// 使用 $settings 数组中的值
$setting1 = $settings['setting1'];
$setting2 = $settings['setting2'];
// 更多操作...
} else {
// 处理错误或使用默认设置
}
完整示例
以下是一个简单的插件设置页面,其中包含表单提交和设置存储的逻辑:
// 添加插件设置页面到 WordPress 管理菜单
function my_plugin_menu() {
add_options_page('My Plugin Settings', 'My Plugin', 'manage_options', 'my-plugin-settings', 'my_plugin_settings_page');
}
add_action('admin_menu', 'my_plugin_menu');
// 插件设置页面内容
function my_plugin_settings_page() {
?>
<div class="wrap">
<h1>My Plugin Settings</h1>
<form method="post" action="options.php">
<?php
settings_fields('my_plugin_settings_group');
do_settings_sections('my-plugin-settings');
?>
<table class="form-table">
<tr valign="top">
<th scope="row">Setting 1</th>
<td><input type="text" name="my_plugin_settings[setting1]" value="<?php echo esc_attr(get_option('my_plugin_settings')['setting1']); ?>" /></td>
</tr>
<tr valign="top">
<th scope="row">Setting 2</th>
<td><input type="text" name="my_plugin_settings[setting2]" value="<?php echo esc_attr(get_option('my_plugin_settings')['setting2']); ?>" /></td>
</tr>
</table>
<?php submit_button(); ?>
</form>
</div>
<?php
}
// 注册设置
function my_plugin_register_settings() {
register_setting('my_plugin_settings_group', 'my_plugin_settings');
}
add_action('admin_init', 'my_plugin_register_settings');
在这个示例中,我们创建了一个设置页面,用户可以在其中输入两个设置值。这些值通过 update_option()
存储在数据库中,并在页面加载时通过 get_option()
检索出来以填充表单字段。我们还使用了 settings_fields()
和 do_settings_sections()
函数来处理表单提交和验证。