Реєструє (створює) віджет. Функції потрібно передати назву створеного класу віджетів WP_Widget, що розширює основний клас.
Хуків немає.
Повертає
null
. Нічого не вертає.
Використання
register_widget( $widget_class )
-
$widget_class
(об’єкт) (обов’язковий) Назва класу, який розширює основний клас віджетів WP_Widget.
Якщо використовується простір імен, то вказується і воно, наприклад:
- register_widget( ‘MyNameSpaceMyWidget’ )
- або register_widget( __NAMESPACE__ . ‘MyWidget’ )
- або register_widget(MyWidget::class) .
Приклади
#1 Шаблон для створення віджету
Цей код розширює базовий клас віджетів 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');
}
#2 Створення віджету з налаштуваннями
Цей приклад створює віджет 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
// реєстрація Foo_Widget у WordPress
function register_foo_widget() {
register_widget( 'Foo_Widget');
}
add_action( 'widgets_init', 'register_foo_widget');