WordPress.org

Function Reference/get sidebar

Description

Includes the sidebar.php template file from your current theme's directory. if a name is specified then a specialised sidebar sidebar-special.php will be included. If the theme contains no sidebar.php file then the sidebar from the default theme wp-content/themes/default/sidebar.php will be included.

Usage

<?php get_sidebar( $name ); ?>

Parameters

$name

(string) (optional) Calls for sidebar-name.php.

Default: None

Examples

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

Left and Right sidebars

Two sidebars in o theme.

<?php get_header(); ?>
<?php get_sidebar('left'); ?>
<?php get_sidebar('right'); ?>
<?php get_footer(); ?>

Mullti sidebars

Different sidebar for different pages.

<?php
if ( is_home() ) :
  get_sidebar('home');
elseif ( is_404() ) :
  get_sidebar('404');
else :
  get_sidebar();
endif;
?>

Notes

The name parameter was added in Version 2.5.

Change Log

Since: 1.5.0

Source File

get_sidebar() is located in wp-includes/general-template.php.