W3cubDocs

/WordPress

apply_filters( “sanitize_option_{$option}”, mixed $value, string $option, mixed $original_value )

Filters an option value following sanitization.

Parameters

$valuemixed
The sanitized option value.
$optionstring
The option name.
$original_valuemixed
The original value passed to the function.

More Information

There is one filter per option name; the $option in the filter name stands for the name (e.g. ‘sanitize_option_blogname‘, ‘sanitize_option_siteurl‘). You can use this filter to define a sanitizer for your own options. See the notes for sanitize_option() for a list of existing options.

Filter existing options

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) {
//...
}

Filter your own options

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) {
//...
}

Source

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

Changelog

Version Description
4.3.0 Added the $original_value parameter.
2.3.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/sanitize_option_option