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

• wp_register_sidebar_widget()

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

View all references View on Trac View on GitHub

Changelog