register_sidebar() │ WP 2.2.0

Реєструє панель віджетів (місце, куди розміщуються віджети в адмін-панелі, щоб потім вивести їх у лицьовій частині).

Функція реєструє панель (місце, контейнер) для віджетів та формат виведення для кожного віджету:

• html тег заголовка.
• html тег до і після віджету.

Зареєструвавши панель, в адмін-панелі з’явиться місце, куди можна розміщувати віджети. Розмістивши віджети на панелі, ми зможемо вивести панель з віджетами в шаблоні за допомогою функції dynamic_sidebar() , (див. приклад 2).

'name' => sprintf(__('Sidebar %d'), $i ),
'id' => "sidebar-$i",

Повертає

Строку. Ідентифікатор передано у параметрі ID.

Шаблон використання

add_action( 'widgets_init', 'register_my_widgets');
function register_my_widgets(){

	register_sidebar(array(
		'name' => sprintf(__('Sidebar %d'), $i ),
		'id' => "sidebar-$i",
		'description' => '',
		'class' => '',
		'before_widget' => '<li id="%1$s" class="widget %2$s">',
		'after_widget' => "</li>n",
		'before_title' => '<h2 class="widgettitle">',
		'after_title' => "</h2>n",
		'before_sidebar' => '', // WP 5.6
		'after_sidebar' => '', // WP 5.6
	)));
}

Використання

register_sidebar($args);

$args
(рядок/масив)

Аргументи для реєстрації панелі віджетів. Можна вказувати у вигляді рядка або масиву:
Якщо у вигляді рядка, аргументи потрібно розділяти знаком &:

'name=Sidebar&id=my_prefix_sidebar'

Ті самі аргументи в масиві:

array(
	'name' => 'Sidebar',
	'id' => 'my_prefix_sidebar',
)

За промовчанням: параметри за промовчанням.

Аргументи параметра $args

name
(рядок)

Назва панелі віджетів. Назва буде видно у адмін-панелі WordPress. За замовчуванням “Бічне стовпчик 1” (локалізація від
Sidebar $i, де $i порядковий номер сайдбара). Значення не повинно бути порожнім!


Типово: sprintf(__(‘Sidebar %d’), $i )

id
(рядок)

Ідентифікатор віджету. Рядок, в якому не повинно бути великих літер і прогалин. Значення не повинно бути порожнім, якщо залишити цей параметр порожнім, то в режимі розробки (при дебазі) отримайте нотатку типу E_USER_NOTICE.


Типово: “sidebar-$i”

description
(рядок)

Текст, що описує, де буде виводитися панель віджетів. Відображається в панелі керування віджетами.


За замовчуванням: ”

class
(рядок)

CSS клас, який буде доданий до головного HTML тегу панелі віджетів.


За замовчуванням: ”

before_widget
(рядок)

HTML-код, який буде розташований перед кожним віджетом в панелі. Наприклад:
<li class="my-widget">. Конструкції
будуть замінені на id %1$sі
%2$sclass віджету, що використовується в сайдбарі.


За замовчуванням: ‘ <li id="%1$s" class="widget %2$s">‘

after_widget
(рядок)

HTML код, який буде розміщений після кожного віджету на панелі. Наприклад:
</li>.


За замовчуванням: ” </li>n“

before_title
(рядок)

HTML код перед заголовком віджету.


За замовчуванням: ‘ <h2 class="widgettitle">‘

after_title
(рядок)

HTML код після заголовка віджету.


За замовчуванням: ” </h2>n“

before_sidebar
(рядок) (WP 5.6)

HTML перед сайдбар. Отримує
аргумент
$id і
$class%1$s в
. Виводиться після хука
dynamic_sidebar_before .
За замовчуванням: ”%2$s

after_sidebar
(рядок) (WP 5.6)

HTML після сайдбару. Виводиться перед хуком
dynamic_sidebar_after .


За замовчуванням: ”

$show_in_rest
(true/false) (WP 5.9)

Чи потрібно показувати цей сайдбар публічно у REST API.


За замовчуванням: false (показувати лише адміністраторам).

Приклади

function register_my_widgets(){
	register_sidebar(array(
		'name' => 'Бічна панель на головній сторінці',
		'id' => 'homepage-sidebar',
		'description' => 'Виводитись як бічна панель тільки на головній сторінці сайту.',
		'before_widget' => '<li class="homepage-widget-block">',
		'after_widget' => '</li>',
		'before_title' => '<h2 class="widgettitle">',
		'after_title' => '</h2>',
	)));
}
add_action( 'widgets_init', 'register_my_widgets');

<div class="custom">
	<?php
	if ( function_exists('dynamic_sidebar') )
		dynamic_sidebar('homepage-sidebar');
	?>
</div>

function register_my_widgets(){
	register_sidebar(array(
		'name' => "Права бічна панель сайту",
		'id' => 'right-sidebar',
		'description' => 'Ці віджети будуть показані в правій колонці сайту',
		'before_title' => '<h2>',
		'after_title' => '</h2>'
	)));
}
add_action( 'widgets_init', 'register_my_widgets');

<?php
	if ( function_exists('dynamic_sidebar') )
		dynamic_sidebar('right-sidebar');
?>

Додати свій приклад

–