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|intrequired
Widget ID.
$output_callbackcallablerequired
Run when widget is called.
$classnamestringoptional
Classname widget option.

Default:''

$paramsmixedoptional
Widget parameters.

Source

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

Changelog

VersionDescription
2.8.0Use wp_register_sidebar_widget()
2.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.