On this page
register_widget_control( int|string $name, callable $control_callback, int $width = '', int $height = '', mixed $params )
This function has been deprecated. Use wp_register_widget_control() instead.
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.
See also
Parameters
$nameint|string Required-
Sidebar ID.
$control_callbackcallable Required-
Widget control callback to display and process form.
$widthint Optional-
Widget width.
Default:
'' $heightint Optional-
Widget height.
Default:
'' $paramsmixed Required-
Widget parameters.
Source
File: wp-includes/deprecated.php. View all references
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| sanitize_title() wp-includes/formatting.php | Sanitizes a string into a slug, which can be used in URLs or HTML attributes. |
| wp_register_widget_control() wp-includes/widgets.php | Registers widget control callback for customizing options. |
| _deprecated_function() wp-includes/functions.php | Marks a function as deprecated and inform when it has been used. |
Changelog
| Version | Description |
|---|---|
| 2.8.0 | Use wp_register_widget_control() |
| 2.2.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/register_widget_control