get_sidebar() — описание функции WordPress на русском

Сигнатура

get_sidebar( string|null $name = null, array $args = array() ): void|false

Описание

Подключает шаблон боковой панели темы, а если указано имя, то подключается специализированная боковая панель.
Для параметра: если файл называется «sidebar-special.php», укажите «special».

Оригинал (английский)

Includes the sidebar template for a theme or if a name is specified then a specialized sidebar will be included.

For the parameter, if the file is called “sidebar-special.php” then specify “special”.

Параметры

$name string|null необязательный = null

Имя специализированной боковой панели.

$args array необязательный = array()

Дополнительные аргументы, передаваемые в шаблон боковой панели.

Возвращаемое значение

void|false

Исходный код

wp-includes/general-template.php:115

function get_sidebar( $name = null, $args = array() ) {
	/**
	 * Fires before the sidebar template file is loaded.
	 *
	 * @since 2.2.0
	 * @since 2.8.0 The `$name` parameter was added.
	 * @since 5.5.0 The `$args` parameter was added.
	 *
	 * @param string|null $name Name of the specific sidebar file to use. Null for the default sidebar.
	 * @param array       $args Additional arguments passed to the sidebar template.
	 */
	do_action( 'get_sidebar', $name, $args );

	$templates = array();
	$name      = (string) $name;
	if ( '' !== $name ) {
		$templates[] = "sidebar-{$name}.php";
	}

	$templates[] = 'sidebar.php';

	if ( ! locate_template( $templates, true, true, $args ) ) {
		return false;
	}
}

История изменений

Версия	Описание
5.5.0	The $args parameter was added.
1.5.0	Introduced.