Registers the form callback for a widget.

Parameters

$idint|stringrequired

Widget ID.

$namestringrequired

Name attribute for the widget.

$form_callbackcallablerequired

Form callback.

$optionsarrayoptional

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()

$paramsmixedoptional

Optional additional parameters to pass to the callback function when it’s called.

Source

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

View all references View on Trac View on GitHub

Changelog