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

Registers the update callback for a widget.


Parameters 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.


Top ↑

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


Top ↑

Changelog 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 User Contributed Notes

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