widget_update_callback │ filter-hook │ WP 2.8.0

Filters a widget's settings before saving.

Returning false will effectively short-circuit the widget's ability to update settings.

Usage

add_filter( 'widget_update_callback', 'wp_kama_widget_update_callback_filter', 10, 4 );

/**
 * Function for `widget_update_callback` filter-hook.
 * 
 * @param array     $instance     The current widget instance's settings.
 * @param array     $new_instance Array of new widget settings.
 * @param array     $old_instance Array of old widget settings.
 * @param WP_Widget $widget       The current widget instance.
 *
 * @return array
 */
function wp_kama_widget_update_callback_filter( $instance, $new_instance, $old_instance, $widget ){

	// filter...
	return $instance;
}

$instance(array)

The current widget instance's settings.

$new_instance(array)

Array of new widget settings.

$old_instance(array)

Array of old widget settings.

$widget(WP_Widget)

The current widget instance.

Changelog

Where the hook is called

$instance = apply_filters( 'widget_update_callback', $instance, $new_instance, $old_instance, $this );

$instance = apply_filters(
	'widget_update_callback',
	$instance,
	$new_instance,
	$old_instance,
	$widget_object
);

Where the hook is used in WordPress