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



register_widget_control › WordPress Function

Since2.2.0
Deprecated2.8.0
› register_widget_control ( $name, $control_callback, $width = '', $height = '', $params )
Parameters: (5)
  • (int|string) $name Sidebar ID.
    Required: Yes
  • (callable) $control_callback Widget control callback to display and process form.
    Required: Yes
  • (int) $width Widget width.
    Required: No
    Default: (empty)
  • (int) $height Widget height.
    Required: No
    Default: (empty)
  • (mixed) $params Widget parameters.
    Required: Yes
See:
Defined at:
Codex:

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.


Related Functions: unregister_widget_control, wp_register_widget_control, wp_unregister_widget_control, wp_render_widget_control, register_widget

Source 

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