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">. Конструкции %1$s и %2$s будут заменены на id и class используемого в сайдбаре виджета.
По умолчанию: '<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 в %1$s и $class в %2$s. Выводится после хука dynamic_sidebar_before.
По умолчанию: ''

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');
?>

Добавить свой пример

—