get_sidebar() WordPress Function

The get_sidebar() function is used to display a sidebar on a WordPress site. A sidebar is a column on the side of a WordPress site that can contain widgets, which are small pieces of code that add functionality to a WordPress site.

get_sidebar( string $name = null, array $args = array() ) #

Load sidebar template.


Description

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

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


Top ↑

Parameters

$name

(string)(Optional)The name of the specialised sidebar.

Default value: null

$args

(array)(Optional) Additional arguments passed to the sidebar template.

Default value: array()


Top ↑

Return

(void|false) Void on success, false if the template does not exist.


Top ↑

Source

File: wp-includes/general-template.php

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;
	}
}


Top ↑

Changelog

Changelog
VersionDescription
5.5.0The $args parameter was added.
1.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More