register_widget_control() │ WP 2.2.0

Registers widget control callback for customizing options.

Allows $name to be an array that accepts either three elements to grab the first element and the third for the name or just uses the first element of the array for the name.

Passes to wp_register_widget_control() after the argument list has been compiled.

No Hooks.

Return

null. Nothing (null).

Usage

register_widget_control( $name, $control_callback, $width, $height, ...$params );

$name(int|string) (required)

Sidebar ID.

$control_callback(callable) (required)

Widget control callback to display and process form.

$width(int)

Widget width.
Default: ''

$height(int)

Widget height.
Default: ''

...$params(mixed) (required)

Widget parameters.

Notes

• See: wp_register_widget_control()

Changelog

register_widget_control() register widget control code ^{WP 6.5.2}

function register_widget_control($name, $control_callback, $width = '', $height = '', ...$params) {
	_deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_widget_control()' );
	// Compat.
	if ( is_array( $name ) ) {
		if ( count( $name ) === 3 ) {
			$name = sprintf( $name[0], $name[2] );
		} else {
			$name = $name[0];
		}
	}

	$id      = sanitize_title( $name );
	$options = array();
	if ( ! empty( $width ) ) {
		$options['width'] = $width;
	}
	if ( ! empty( $height ) ) {
		$options['height'] = $height;
	}

	wp_register_widget_control( $id, $name, $control_callback, $options, ...$params );
}