wp_register_sidebar_widget() — описание функции WordPress на русском

Сигнатура

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

Описание

По умолчанию опция виджета — ‘classname’, которую можно переопределить.
Функцию также можно использовать для отмены регистрации виджетов, когда параметр $output_callback является пустой строкой.

Оригинал (английский)

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.

Параметры

$id int|string обязательный

ID виджета.

$name string обязательный

Отображаемый заголовок виджета.

$output_callback callable обязательный

Выполняется при вызове виджета.

$options array необязательный = array()

Массив дополнительных опций виджета для экземпляра. classname stringИмя класса для HTML-контейнера виджета. По умолчанию — сокращённая версия имени функции обратного вызова вывода. description stringОписание виджета для отображения в панели администрирования виджетов и/или в теме. show_instance_in_rest boolПоказывать ли настройки экземпляра виджета в REST API. Доступно только для виджетов на основе WP_Widget.

$params mixed необязательный

Необязательные дополнительные параметры, передаваемые в функцию обратного вызова при её вызове.

Исходный код

wp-includes/widgets.php:396

function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array(), ...$params ) {
	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'   => $params,
	);
	$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 3.0.0
		 *
		 * @param array $widget An array of default widget arguments.
		 */
		do_action( 'wp_register_sidebar_widget', $widget );
		$wp_registered_widgets[ $id ] = $widget;
	}
}

История изменений

Версия	Описание
5.8.0	Added show_instance_in_rest option.
5.3.0	Formalized the existing and already documented ...$params parameter by adding it to the function signature.
2.2.0	Introduced.