Регистрирует (создает) виджет.
Функции нужно передать название класса, который наследуется от WP_Widget.
Регистрировать виджеты принято на хуке widgets_init. Однако, их также можно регистрировать на хуке init.
Хуков нет.
Возвращает
null
. Ничего не возвращает.
Использование
register_widget( $widget_class )
- $widget_class(объект) (обязательный)
Название класса, который расширяет основной класс виджетов WP_Widget.
Если используется пространство имён, то указывается и оно, например:
register_widget( 'MyNameSpace\MyWidget' );
// или
register_widget( __NAMESPACE__ . '\MyWidget' );
// или
register_widget( MyWidget::class );
Примеры
#1 Создание виджета с настройками
Этот пример создает виджет Foo_Widget с настройками, в которых можно указать заголовок виджета. По аналогии можно добавить любые настройки:
<?php
/**
* Добавление нового виджета Foo_Widget.
*/
class Foo_Widget extends WP_Widget {
// Регистрация виджета используя основной класс
function __construct() {
// вызов конструктора выглядит так:
// __construct( $id_base, $name, $widget_options = array(), $control_options = array() )
parent::__construct(
'foo_widget', // ID виджета, если не указать (оставить ''), то ID будет равен названию класса в нижнем регистре: foo_widget
'Заголовок виджета',
array( 'description' => 'Описание виджета', /*'classname' => 'my_widget',*/ )
);
// скрипты/стили виджета, только если он активен
if ( is_active_widget( false, false, $this->id_base ) || is_customize_preview() ) {
add_action('wp_enqueue_scripts', array( $this, 'add_my_widget_scripts' ));
add_action('wp_head', array( $this, 'add_my_widget_style' ) );
}
}
/**
* Вывод виджета во Фронт-энде
*
* @param array $args аргументы виджета.
* @param array $instance сохраненные данные из настроек
*/
function widget( $args, $instance ) {
$title = apply_filters( 'widget_title', $instance['title'] );
echo $args['before_widget'];
if ( ! empty( $title ) ) {
echo $args['before_title'] . $title . $args['after_title'];
}
echo __( 'Hello, World!', 'text_domain' );
echo $args['after_widget'];
}
/**
* Админ-часть виджета
*
* @param array $instance сохраненные данные из настроек
*/
function form( $instance ) {
$title = @ $instance['title'] ?: 'Заголовок по умолчанию';
?>
<p>
<label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ); ?></label>
<input class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>">
</p>
<?php
}
/**
* Сохранение настроек виджета. Здесь данные должны быть очищены и возвращены для сохранения их в базу данных.
*
* @see WP_Widget::update()
*
* @param array $new_instance новые настройки
* @param array $old_instance предыдущие настройки
*
* @return array данные которые будут сохранены
*/
function update( $new_instance, $old_instance ) {
$instance = array();
$instance['title'] = ( ! empty( $new_instance['title'] ) ) ? strip_tags( $new_instance['title'] ) : '';
return $instance;
}
// скрипт виджета
function add_my_widget_scripts() {
// фильтр чтобы можно было отключить скрипты
if( ! apply_filters( 'show_my_widget_script', true, $this->id_base ) )
return;
$theme_url = get_stylesheet_directory_uri();
wp_enqueue_script('my_widget_script', $theme_url .'/my_widget_script.js' );
}
// стили виджета
function add_my_widget_style() {
// фильтр чтобы можно было отключить стили
if( ! apply_filters( 'show_my_widget_style', true, $this->id_base ) )
return;
?>
<style type="text/css">
.my_widget a{ display:inline; }
</style>
<?php
}
}
// регистрация Foo_Widget в WordPress
add_action( 'widgets_init', 'register_foo_widget' );
function register_foo_widget() {
register_widget( 'Foo_Widget' );
}
#3 Шаблон для создания виджета
Этот код расширяет базовый класс виджетов WP_Widget и создает дополнительный виджет, который можно будет использовать многократно:
// Класс виджета
class My_Widget extends WP_Widget {
function __construct() {
// Запускаем родительский класс
parent::__construct(
'идентификатор_виджета', // ID виджета, если не указать (оставить ''), то ID будет равен названию класса в нижнем регистре: my_widget
'Название виджета',
array('description' => 'Описание виджета')
);
// стили скрипты виджета, только если он активен
if ( is_active_widget( false, false, $this->id_base ) || is_customize_preview() ) {
add_action('wp_enqueue_scripts', array( $this, 'add_my_widget_scripts' ));
add_action('wp_head', array( $this, 'add_my_widget_style' ) );
}
}
// Вывод виджета
function widget( $args, $instance ){
$title = apply_filters( 'widget_title', $instance['title'] );
echo $args['before_widget'];
if( $title )
echo $args['before_title'] . $title . $args['after_title'];
echo 'Привет!';
echo $args['after_widget'];
}
// Сохранение настроек виджета (очистка)
function update( $new_instance, $old_instance ) {
}
// html форма настроек виджета в Админ-панели
function form( $instance ) {
}
// скрипт виджета
function add_my_widget_scripts() {
// фильтр чтобы можно было отключить скрипты
if( ! apply_filters( 'show_my_widget_script', true, $this->id_base ) )
return;
$theme_url = get_stylesheet_directory_uri();
wp_enqueue_script('my_widget_script', $theme_url .'/my_widget_script.js' );
}
// стили виджета
function add_my_widget_style() {
// фильтр чтобы можно было отключить стили
if( ! apply_filters( 'show_my_widget_style', true, $this->id_base ) )
return;
?>
<style>
.my_widget a{ display:inline; }
</style>
<?php
}
}
// Регистрация виджета
add_action( 'widgets_init', 'my_register_widgets' );
function my_register_widgets() {
register_widget( 'My_Widget' );
}