Loads sidebar template.

Description

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

Parameters

$namestringoptional

The name of the specialized sidebar.

Default:null

$argsarrayoptional

Additional arguments passed to the sidebar template.

Default:array()

Return

Source

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

View all references View on Trac View on GitHub

Hooks

do_action( ‘get_sidebar’, string|null $name, array $args )

Fires before the sidebar template file is loaded.

Changelog