wp_register_widget_control( int|string $id, string $name, callable $control_callback, array $options = array(), mixed $params )
Registers widget control callback for customizing options.
Parameters
- $id
-
(int|string) (Required) Sidebar ID.
- $name
-
(string) (Required) Sidebar display name.
- $control_callback
-
(callable) (Required) Run when sidebar is displayed.
- $options
-
(array) (Optional) Array or string of control options.
-
'height'
(int) Never used. Default 200. -
'width'
(int) Width of the fully expanded control form (but try hard to use the default width). Default 250. -
'id_base'
(int|string) Required for multi-widgets, i.e widgets that allow multiple instances such as the text widget. The widget id will end up looking like{$id_base}-{$unique_number}.
Default value: array()
-
'height'
- $params
-
(mixed) (Optional) additional parameters to pass to the callback function when it's called.
Source
File: wp-includes/widgets.php
function wp_register_widget_control( $id, $name, $control_callback, $options = array(), ...$params ) {
global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;
$id = strtolower( $id );
$id_base = _get_widget_id_base( $id );
if ( empty( $control_callback ) ) {
unset( $wp_registered_widget_controls[ $id ] );
unset( $wp_registered_widget_updates[ $id_base ] );
return;
}
if ( in_array( $control_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $control_callback ) ) {
unset( $wp_registered_widgets[ $id ] );
return;
}
if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {
return;
}
$defaults = array(
'width' => 250,
'height' => 200,
); // Height is never used.
$options = wp_parse_args( $options, $defaults );
$options['width'] = (int) $options['width'];
$options['height'] = (int) $options['height'];
$widget = array(
'name' => $name,
'id' => $id,
'callback' => $control_callback,
'params' => $params,
);
$widget = array_merge( $widget, $options );
$wp_registered_widget_controls[ $id ] = $widget;
if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) {
return;
}
if ( isset( $widget['params'][0]['number'] ) ) {
$widget['params'][0]['number'] = -1;
}
unset( $widget['width'], $widget['height'], $widget['name'], $widget['id'] );
$wp_registered_widget_updates[ $id_base ] = $widget;
} Changelog
| Version | Description |
|---|---|
| 5.3.0 | Formalized the existing and already documented ...$params parameter by adding it to the function signature. |
| 2.2.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_register_widget_control