wp_register_sidebar_widget

Регистрирует виджет, который затем можно добавить в панель виджетов (сайдбар) в админ-панели.

Хуки из функции:
wp_register_sidebar_widget
Возвращает

Ничего не возвращает.

Использование

wp_register_sidebar_widget( $id, $name, $output_callback, $options, $params, ... );
$id(строка/число) (обязательный)
ID виджета, уникальное название. Например, your_widget_1.
$name(строка) (обязательный)
Заголовок виджета, по которому его можно будет узнать в админ-панели.
$output_callback(строка) (обязательный)
Функция обратного вызова, которая будет запускаться при вызове виджета в шаблоне.
$options(строка/массив)
Настройки виджета.
По умолчанию: нет
$params, …(строка/массив/число/объект/логический)
Параметры, которые будут добавлены к виджету.
По умолчанию: нет

Параметры передаваемые функции обратного вызова ($output_callback)

function my_output_callback_function( $args, $params ){ ... }
$args(массив) (обязательный)
Параметры виджета, регистрируемые при регистрации виджета: widget_id, widget_name и т.д.
$params(массив) (обязательный)
Дополнительные параметры передаваемые функции, параметр $params функции wp_register_sidebar_widget().
К параметрам применяется фильтр dynamic_sidebar_params, перед вызовом функции обратного вызова.

Примеры

#1 Создание виджета

Следующий код, создаст виджет “Мой виджет”, который станет доступен в админ-панели WordPress. Этот виджет можно будет перетащить в доступную панель виджетов (сайдбар).

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

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *