当前浏览:首页 / WordPress钩子 / sanitize_option_{$option}

apply_filters( "sanitize_option_{$option}", string $value, string $option, string $original_value )

过滤清理净化后的选项值

kses 清理

option 选项more...

sanitize 清理more...


参数

$valuestring
已清理的选项值。
$optionstring
选项名称。
$original_valuestring
传递给函数的原始值。

更多信息

每个选项名称有一个过滤器,过滤器名称中的动态部分$option代表选项名称(例如“sanitize_option_blogname”、“sanitize_option_siteurl”)。您可以使用此过滤器为自己的选项定义清理。有关现有选项的列表,请参见sanitize_option()的说明。

过滤现有选项

add_filter('sanitize_option_admin_email', 'sanitize_builtin_option', 10, 2);
add_filter('sanitize_option_new_admin_email', 'sanitize_builtin_option', 10, 2);

function sanitize_builtin_option($value, $option) {
    //...
}

过滤您自己的选项

add_filter('sanitize_option_feed_url', 'sanitize_url', 10, 2);
add_filter('sanitize_option_wpi_endpoint', 'sanitize_url', 10, 2);
add_filter('sanitize_option_contact_email', 'sanitize_email');

function sanitize_url($value, $option) {
    //...
}

function sanitize_email($value, $option) {
    //...
}


源码

查看源码 官方文档


更新日志

版本描述
4.3.0添加了$original_value参数。
2.3.0开始引入

使用示例

  • 示例1

    从Codex迁移的示例:

    add_option('blocksize', 200); # 256 gets stored for blocksize
    
    add_filter('sanitize_option_blocksize', 'sanitize_blocksize');
    
    if (! function_exists('lg')) {
        function lg($x) {
            return log($x) / log(2);
        }
    }
    
    function sanitize_blocksize($value) {
        return pow(2, ceil(lg($value)));
    }