This page redirects to an external site: https://developer.wordpress.org/reference/functions/get_sidebar/

Languages: English • 日本語 Русский • 中文(简体) • (Add your language)

Description

Includes the sidebar.php template file from your current theme's directory.

If a name ($name) is specified then a specialized sidebar sidebar-{name}.php will be included. If sidebar-{name}.php does not exist, then it will fallback to loading sidebar.php.

If the theme contains no sidebar.php file then the sidebar from the default theme wp-includes/theme-compat/sidebar.php will be included.

Usage

<?php get_sidebar( $name ); ?>

Parameters

$name

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

Default: None

Examples

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

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

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.

Notes

• Uses: locate_template()
• Uses: do_action() Calls 'get_sidebar' action.

Change Log

• Since: 1.5.0
• 2.5.0 : Added the 'name' parameters.

Source File

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

Related

Include Tags

• Function: get_header(),
• Function: get_footer(),
• Function: get_sidebar(),
• Function: get_template_part(),
• Function: get_search_form(),
• Function: comments_template()

Widgets: is_active_widget(), the_widget(), register_widget(), unregister_widget(), wp_register_widget_control(), wp_unregister_widget_control(), wp_convert_widget_settings(), wp_get_widget_defaults(), wp_widget_description()

• Adding Sidebar Classes included with get_sidebar to body_class