Warning: This function has been deprecated. Use register_setting() instead.

add_option_update_handler() WordPress Function

The add_option_update_handler() function is used to add an update handler for an option.

add_option_update_handler( string $option_group, string $option_name, callable $sanitize_callback = '' ) #

Register a setting and its sanitization callback


Description

Top ↑

See also


Top ↑

Parameters

$option_group

(string)(Required)A settings group name. Should correspond to an allowed option key name. Default allowed option key names include 'general', 'discussion', 'media', 'reading', 'writing', and 'options'.

$option_name

(string)(Required)The name of an option to sanitize and save.

$sanitize_callback

(callable)(Optional) A callback function that sanitizes the option's value.

Default value: ''


Top ↑

Source

File: wp-admin/includes/deprecated.php

function add_option_update_handler( $option_group, $option_name, $sanitize_callback = '' ) {
	_deprecated_function( __FUNCTION__, '3.0.0', 'register_setting()' );
	register_setting( $option_group, $option_name, $sanitize_callback );
}


Top ↑

Changelog

Changelog
VersionDescription
3.0.0Use register_setting()
2.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More