Warning: This function has been deprecated. Use wp_register_widget_control() instead.

register_widget_control() WordPress Function

The register_widget_control() function allows you to add controls to a widget. This function accepts three arguments: the id of the widget, the id of the control, and an array of options. The options array can include a 'label' key, which will be used as the label for the control, a 'type' key, which can be either 'text' or 'checkbox', and a 'default' key, which will be used as the default value for the control.

register_widget_control( int|string $name, callable $control_callback, int $width = '', int $height = '', mixed $params ) #

Registers widget control callback for customizing options.


Description

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.

Top ↑

See also


Top ↑

Parameters

$name

(int|string)(Required)Sidebar ID.

$control_callback

(callable)(Required)Widget control callback to display and process form.

$width

(int)(Optional)Widget width.

Default value: ''

$height

(int)(Optional)Widget height.

Default value: ''

$params

(mixed)(Required)Widget parameters.


Top ↑

Source

File: wp-includes/deprecated.php

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


Top ↑

Changelog

Changelog
VersionDescription
2.8.0Use wp_register_widget_control()
2.2.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More