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

Сигнатура

wp_register_widget_control( int|string $id, string $name, callable $control_callback, array $options = array(), mixed $params )

Описание

Регистрирует функцию обратного вызова управления виджетом для настройки опций.

Параметры

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

ID боковой панели.

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

Отображаемое имя боковой панели.

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

Выполняется при отображении боковой панели.

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

Массив или строка опций управления. height intНе используется. По умолчанию 200. width intШирина полностью развёрнутой формы управления (но старайтесь по возможности использовать ширину по умолчанию). По умолчанию 250. id_base int|stringОбязателен для мультивиджетов, то есть виджетов, допускающих несколько экземпляров, например текстового виджета. В итоге ID виджета будет выглядеть как {$id_base}-{$unique_number}.

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

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

Исходный код

wp-includes/widgets.php:536

function wp_register_widget_control( $id, $name, $control_callback, $options = array(), ...$params ) {
	global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks;

	$id      = strtolower( $id );
	$id_base = _get_widget_id_base( $id );

	if ( empty( $control_callback ) ) {
		unset( $wp_registered_widget_controls[ $id ] );
		unset( $wp_registered_widget_updates[ $id_base ] );
		return;
	}

	if ( in_array( $control_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $control_callback ) ) {
		unset( $wp_registered_widgets[ $id ] );
		return;
	}

	if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) {
		return;
	}

	$defaults          = array(
		'width'  => 250,
		'height' => 200,
	); // Height is never used.
	$options           = wp_parse_args( $options, $defaults );
	$options['width']  = (int) $options['width'];
	$options['height'] = (int) $options['height'];

	$widget = array(
		'name'     => $name,
		'id'       => $id,
		'callback' => $control_callback,
		'params'   => $params,
	);
	$widget = array_merge( $widget, $options );

	$wp_registered_widget_controls[ $id ] = $widget;

	if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) {
		return;
	}

	if ( isset( $widget['params'][0]['number'] ) ) {
		$widget['params'][0]['number'] = -1;
	}

	unset( $widget['width'], $widget['height'], $widget['name'], $widget['id'] );
	$wp_registered_widget_updates[ $id_base ] = $widget;
}

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

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