get_sidebar() – Load sidebar template.

You appear to be a bot. Output may be restricted

Description

Load sidebar template.

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

Usage

$void|false = get_sidebar( $name, $args );

Parameters

$name
( string ) optional – The name of the specialised sidebar.
$args
( array ) optional – Optional. Additional arguments passed to the sidebar template. Default empty array.

Returns

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

Source

File name: wordpress/wp-includes/general-template.php
Lines:

1 to 25 of 25
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 on GitHub View on Trac