W3cubDocs

/WordPress

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".

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()

Return

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

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

Uses

Uses Description
wp-includes/general-template.php: get_sidebar

Fires before the sidebar template file is loaded.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/template.php: locate_template()

Retrieve the name of the highest priority template file that exists.

Changelog

Version Description
5.5.0 The $args parameter was added.
1.5.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_sidebar