_register_widget_form_callback( int|string $id, string $name, callable $form_callback, array $options = array(), mixed $params )

Registers the form callback for a widget.


Description Description


Parameters Parameters

$id

(int|string) (Required) Widget ID.

$name

(string) (Required) Name attribute for the widget.

$form_callback

(callable) (Required) Form callback.

$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_form_callback( $id, $name, $form_callback, $options = array(), ...$params ) {
	global $wp_registered_widget_controls;

	$id = strtolower( $id );

	if ( empty( $form_callback ) ) {
		unset( $wp_registered_widget_controls[ $id ] );
		return;
	}

	if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {
		return;
	}

	$defaults          = array(
		'width'  => 250,
		'height' => 200,
	);
	$options           = wp_parse_args( $options, $defaults );
	$options['width']  = (int) $options['width'];
	$options['height'] = (int) $options['height'];

	$widget = array(
		'name'     => $name,
		'id'       => $id,
		'callback' => $form_callback,
		'params'   => $params,
	);
	$widget = array_merge( $widget, $options );

	$wp_registered_widget_controls[ $id ] = $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.