wp_register_sidebar_widget( int|string $id, string $name, callable $output_callback, array $options = array() )

Register an instance of a widget.

Description

The default widget option is ‘classname’ that can be overridden.

The function can also be used to un-register widgets when $output_callback parameter is an empty string.

Parameters

$id

(int|string) (Required) Widget ID.

$name

(string) (Required) Widget display title.

$output_callback

(callable) (Required) Run when widget is called.

$options

(array) (Optional) An array of supplementary widget options for the instance.

  • 'classname'
    (string) Class name for the widget's HTML container. Default is a shortened version of the output callback name.
  • 'description'
    (string) Widget description for display in the widget administration panel and/or theme.

Default value: array()

Source

File: wp-includes/widgets.php 

function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array() ) {
	global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks;

	$id = strtolower($id);

	if ( empty($output_callback) ) {
		unset($wp_registered_widgets[$id]);
		return;
	}

	$id_base = _get_widget_id_base($id);
	if ( in_array($output_callback, $_wp_deprecated_widgets_callbacks, true) && !is_callable($output_callback) ) {
		unset( $wp_registered_widget_controls[ $id ] );
		unset( $wp_registered_widget_updates[ $id_base ] );
		return;
	}

	$defaults = array('classname' => $output_callback);
	$options = wp_parse_args($options, $defaults);
	$widget = array(
		'name' => $name,
		'id' => $id,
		'callback' => $output_callback,
		'params' => array_slice(func_get_args(), 4)
	);
	$widget = array_merge($widget, $options);

	if ( is_callable($output_callback) && ( !isset($wp_registered_widgets[$id]) || did_action( 'widgets_init' ) ) ) {

		/**
		 * Fires once for each registered widget.
		 *
		 * @since WP-3.0.0
		 *
		 * @param array $widget An array of default widget arguments.
		 */
		do_action( 'wp_register_sidebar_widget', $widget );
		$wp_registered_widgets[$id] = $widget;
	}
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/plugin.php: did_action()

Retrieve the number of times an action is fired.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/widgets.php: _get_widget_id_base()

Retrieves the widget ID base value.
wp-includes/widgets.php: wp_register_sidebar_widget

Fires once for each registered widget.
wp-includes/functions.php: wp_parse_args()

Merge user defined arguments into defaults array.

Changelog

Changelog
Version Description
WP-2.2.0 Introduced.