_register_widget_update_callback( string $id_base, callable $update_callback, array $options = array(), mixed $params )

Registers the update callback for a widget.

Contents

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() .
More Arguments from wp_register_widget_control( ... $options ) Array or string of control options.
  • height int
    Never used. Default 200.
  • width int
    Width of the fully expanded control form (but try hard to use the default width).
    Default 250.
  • id_base int|string
    Required for multi-widgets, i.e widgets that allow multiple instances such as the text widget. The widget ID will end up looking like {$id_base}-{$unique_number}.

Default: array()

$params mixed Optional
Optional additional parameters to pass to the callback function when it's called.

Top ↑

Source

File: wp-includes/widgets.php. View all references 

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;
}

View on Trac View on GitHub

Top ↑

Top ↑

Changelog

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.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.