get_sidebar( string $name = null, array $args = array() )

Load sidebar template.

Contents

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

Top ↑

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

Top ↑

Return Return

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

Top ↑

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

Expand full source code Collapse full source code View on Trac

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

Calls the callback functions that have been added to an action hook.
wp-includes/template.php: locate_template()

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

Top ↑

Changelog Changelog

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

Top ↑

User Contributed Notes User Contributed Notes

  3. Skip to note 3 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    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.

  5. Skip to note 5 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
    Contributed by thirumani02 —

    Call sidebar with $args parameter (Since 5.5.0)
    Consider below is your sidebar call from anywhere inside your theme, 

    <?php 
$args = array(
	'title' => 'Shop sidebar'
);

get_sidebar( 'shop', $args ); 

?>

    Your codes inside sidebar-shop.php file might look a like below.

    <div id="secondary" class="widget-area sidebar-shop" role="complementary">
	<h2><?php echo esc_html( $args['title'] ); ?><h2>
	<?php dynamic_sidebar( 'sidebar-shop' ); ?>
</div><!-- #secondary -->
  6. Skip to note 6 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by tradesouthwest —

    Conditional Statement for Any Sidebar
    In case you are making a plugin template where you do not know if there is a sidebar, for any given theme the plugin may be used with, you may check for register_sidebar function to see if any sidebar exists.

    if ( function_exists( 'register_sidebar' ) ) { 
	get_sidebar(); 
}

    Or, if you know the theme registered name for the sidebar in question try:

    //for twenty-sixteen theme
    if ( is_active_sidebar( 'content-bottom' ) ) : 
        get_sidebar( 'content-bottom' ); 
    endif;

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