apply_filters( 'widget_update_callback', array $instance, array $new_instance, array $old_instance, WP_Widget $widget )
- Since
- 2.8.0
Filters a widget's settings before saving.
Description
Returning false will effectively short-circuit the widget's ability to update settings.
Compatibility
- WordPress
- since 2.8.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Parameters
$instancearray- The current widget instance's settings.
$new_instancearray- Array of new widget settings.
$old_instancearray- Array of old widget settings.
$widgetWP_Widget- The current widget instance.
Where this hook fires · 2
wp-includes/class-wp-widget.php:476WP_Widget::update_callback()wp-includes/rest-api/endpoints/class-wp-rest-widget-types-controller.php:513WP_REST_Widget_Types_Controller::encode_form_data()
Source code
<?php * * @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. */ $instance = apply_filters( 'widget_update_callback', $instance, $new_instance, $old_instance, $this ); if ( false !== $instance ) { $all_instances[ $number ] = $instance; } break; // Run only once.Changelog
Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
- Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.