wpseek.com
A WordPress-centric search engine for devs and theme authors



_register_widget_form_callback › WordPress Function

Since2.8.0
Deprecatedn/a
› _register_widget_form_callback ( $id, $name, $form_callback, $options = array(), $params )
Parameters: (5)
  • (int|string) $id Widget ID.
    Required: Yes
  • (string) $name Name attribute for the widget.
    Required: Yes
  • (callable) $form_callback Form callback.
    Required: Yes
  • (array) $options Optional. Widget control options. See wp_register_widget_control(). Default empty array.
    Required: No
    Default: array()
  • (mixed) $params Optional additional parameters to pass to the callback function when it's called.
    Required: Yes
Defined at:
Codex:
Change Log:
  • 5.3.0

Registers the form callback for a widget.



Related Functions: _register_widget_update_callback, wp_register_widget_control, register_widget_control, register_widget, wp_unregister_widget_control

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