_register_widget_update_callback() WordPress Function
The register_widget_update_callback() function is used to register a callback for a widget update. This function is used to register a callback for a widget update.
_register_widget_update_callback( string $id_base, callable $update_callback, array $options = array(), mixed $params ) #
Registers the update callback for a widget.
Parameters
- $id_base
(string)(Required)The base ID of a widget created by extending WP_Widget.
- $update_callback
(callable)(Required)Update callback method for the widget.
- $options
(array)(Optional) Widget control options. See wp_register_widget_control().
Default value: array()
- $params
(mixed)(Optional)additional parameters to pass to the callback function when it's called.
Source
File: wp-includes/widgets.php
function _register_widget_update_callback( $id_base, $update_callback, $options = array(), ...$params ) {
global $wp_registered_widget_updates;
if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) {
if ( empty( $update_callback ) ) {
unset( $wp_registered_widget_updates[ $id_base ] );
}
return;
}
$widget = array(
'callback' => $update_callback,
'params' => $params,
);
$widget = array_merge( $widget, $options );
$wp_registered_widget_updates[ $id_base ] = $widget;
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 5.3.0 | Formalized the existing and already documented ...$params parameter by adding it to the function signature. |
| 2.8.0 | Introduced. |