wordpress常用api

WordPress Settings API 是一个强大的工具，它允许开发者在 WordPress 中创建和管理自定义设置，这个 API 提供了一种方式来验证、过滤和输入数据，以确保数据的完整性和安全性，在本文中，我们将详细介绍如何使用 WordPress Settings API 进行验证、过滤和输入。

验证

验证是确保数据符合预期格式和规则的过程，在 WordPress Settings API 中，我们可以使用 sanitize_callback 参数来指定一个函数，该函数将用于验证用户输入的数据。

假设我们有一个设置，要求用户输入一个有效的电子邮件地址，我们可以创建一个名为 validate_email 的函数，该函数将检查用户输入的数据是否符合电子邮件地址的格式，我们可以将此函数作为 sanitize_callback 参数传递给 add_settings_field 函数。

function validate_email($input) {
    if (filter_var($input, FILTER_VALIDATE_EMAIL)) {
        return $input;
    } else {
        return new WP_Error('invalid_email', __('Invalid email address.'));
    }
}
add_settings_field(
    'email',
    'Email Address',
    'text',
    'general',
    'email_setting',
    array(
        'label' => 'Email Address',
        'type' => 'text',
        'sanitize_callback' => 'validate_email',
    )
);

在上面的代码中，我们首先定义了一个名为 validate_email 的函数，该函数使用 filter_var 函数检查用户输入的数据是否符合电子邮件地址的格式，如果数据有效，函数将返回原始数据；否则，它将返回一个包含错误消息的 WP_Error 对象，我们将此函数作为 sanitize_callback 参数传递给 add_settings_field 函数。

过滤

过滤是修改数据以符合特定条件或规则的过程，在 WordPress Settings API 中，我们可以使用 sanitize_callback 参数来指定一个函数，该函数将用于过滤用户输入的数据。

假设我们有一个设置，要求用户输入一个整数，我们可以创建一个名为 sanitize_integer 的函数，该函数将检查用户输入的数据是否为整数，我们可以将此函数作为 sanitize_callback 参数传递给 add_settings_field 函数。

function sanitize_integer($input) {
    if (is_numeric($input)) {
        return intval($input);
    } else {
        return new WP_Error('invalid_integer', __('Invalid integer.'));
    }
}
add_settings_field(
    'integer',
    'Integer Value',
    'text',
    'general',
    'integer_setting',
    array(
        'label' => 'Integer Value',
        'type' => 'text',
        'sanitize_callback' => 'sanitize_integer',
    )
);

在上面的代码中，我们首先定义了一个名为 sanitize_integer 的函数，该函数使用 is_numeric 函数检查用户输入的数据是否为整数，如果数据为整数，函数将返回整数形式的原始数据；否则，它将返回一个包含错误消息的 WP_Error 对象，我们将此函数作为 sanitize_callback 参数传递给 add_settings_field 函数。

输入

输入是将数据添加到数据库的过程，在 WordPress Settings API 中，我们可以使用 register_setting 函数来注册一个新的设置，我们可以使用 add_settings_field 和 register_setting 函数来创建一个新的设置字段，我们可以使用 update_option 函数来更新设置的值。

假设我们想要添加一个名为 siteurl 的新设置，我们可以首先使用 register_setting 函数来注册这个新设置，我们可以使用 add_settings_field 和 register_setting 函数来创建一个新的设置字段，我们可以使用 update_option 函数来更新设置的值。

register_setting('general', 'siteurl');
add_settings_field(
    'siteurl',
    'Site URL',
    'text',
    'general',
    'siteurl_setting',
    array(
        'label' => 'Site URL',
        'type' => 'text',
        'sanitize_callback' => 'esc_url', // 确保 URL 安全和有效
    )
);

在上面的代码中，我们首先使用 register_setting 函数来注册一个新的设置，我们使用 add_settings_field 和 register_setting 函数来创建一个新的设置字段，我们使用 update_option 函数来更新设置的值，注意，我们使用了 esc_url 函数来确保 URL 的安全和有效。