get_sidebar( string $name = null )

Load sidebar template.

Description
Related
- Uses
User Contributed Notes

Description 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 Parameters

$name

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

Default value: null

Top ↑

Source Source

File: wp-includes/general-template.php

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

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

	$templates[] = 'sidebar.php';

	locate_template( $templates, true );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version	Description
1.5.0	Introduced.

Top ↑

Uses Uses

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.

Top ↑

User Contributed Notes User Contributed Notes

Skip to note 1 content

You must log in to vote on the helpfulness of this noteVote results for this note: 10You must log in to vote on the helpfulness of this note

Contributed by Codex — 4 years ago
Simple call
Assume you have file wp-content/yourTheme/sidebar-nice-bar.php. The way you can include this sidebar in your page is:
```
<?php get_sidebar('nice-bar'); ?>
```
Log in to add feedback
Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

Contributed by Codex — 4 years ago
Multi sidebars
Different sidebar for different pages.
```
<?php
if ( is_home() ) :
  get_sidebar( 'home' );
elseif ( is_404() ) :
  get_sidebar( '404' );
else :
  get_sidebar();
endif;
?>
```
The file names for the home and 404 sidebars should be sidebar-home.php and sidebar-404.php respectively.
Log in to add feedback
Skip to note 3 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by Codex — 4 years ago
Simple 404 page
The following code is a simple example of a template for an “HTTP 404: Not Found” error (which you could include in your Theme as 404.php).
```
<?php get_header(); ?>
<h2>Error 404 - Not Found</h2>
<?php get_sidebar(); ?>
<?php get_footer(); ?>
```
Log in to add feedback
Skip to note 4 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by Codex — 4 years ago
Left and Right Sidebars
Two sidebars in one theme.
```
<?php get_header(); ?>
<?php get_sidebar( 'left' ); ?>
<?php get_sidebar( 'right' ); ?>
<?php get_footer(); ?>
```
The file names for the right and left sidebars should be sidebar-right.php and sidebar-left.php respectively.
Log in to add feedback

You must log in before being able to contribute a note or feedback.

WordPress.org

Code Reference

get_sidebar( string $name = null )

Contents

Description Description

Parameters Parameters

Source Source

Changelog Changelog

User Contributed Notes User Contributed Notes

WordPress.org

get_sidebar( string $name = null )

Contents

Description #Description

Parameters #Parameters

Source #Source

Changelog #Changelog

Related #Related

Uses #Uses

User Contributed Notes #User Contributed Notes

Description Description

Parameters Parameters

Source Source

Changelog Changelog

Related Related

Uses Uses

User Contributed Notes User Contributed Notes