On this page
register_sidebar_widget( string|int $name, callable $output_callback, string $classname = '', mixed $params )
This function has been deprecated. Use wp_register_sidebar_widget() instead.
Register widget for sidebar with backward compatibility.
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_sidebar_widget() after argument list and backward compatibility is complete.
See also
Parameters
$namestring|int Required-
Widget ID.
$output_callbackcallable Required-
Run when widget is called.
$classnamestring Optional-
Classname widget option.
Default:
'' $paramsmixed Optional-
Widget parameters.
Source
File: wp-includes/deprecated.php. View all references
function register_sidebar_widget($name, $output_callback, $classname = '', ...$params) {
_deprecated_function( __FUNCTION__, '2.8.0', 'wp_register_sidebar_widget()' );
// 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( $classname ) && is_string( $classname ) ) {
$options['classname'] = $classname;
}
wp_register_sidebar_widget( $id, $name, $output_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_sidebar_widget() wp-includes/widgets.php | Register an instance of a widget. |
| _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_sidebar_widget() |
| 2.2.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/register_sidebar_widget