Warning: This function has been deprecated. Use wp_register_widget_control() instead.
register_widget_control( int|string $name, callable $control_callback, int $width = '', int $height = '', mixed $params )
Registers widget control callback for customizing options.
Description 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.
See also See also
Parameters 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.
Source 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 );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 2.8.0 | Use wp_register_widget_control() |
| 2.2.0 | Introduced. |