get_sidebar( string $name = null )
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".
参数
$name
(string)
(Optional)
The name of the specialised sidebar.
Default value: null
源代码
File: wp-includes/general-template.php
function get_sidebar( $name = null ) {
/**
* Fires before the sidebar template file is loaded.
*
* The hook allows a specific sidebar template file to be used in place of the
* default sidebar template file. If your file is called sidebar-new.php,
* you would specify the filename in the hook as get_sidebar( 'new' ).
*
* @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 );
}
更新日志
Version
描述
1.5.0
Introduced.
相关函数
Uses
wp-includes/general-template.php:
get_sidebar
wp-includes/plugin.php:
do_action()
wp-includes/template.php:
locate_template()
Skip to note content
You must log in to vote on the helpfulness of this noteVote results for this note: 6You must log in to vote on the helpfulness of this note
Contributed by Codex
Simple call
Assume you have file wp-content/yourTheme/sidebar-nice-bar.php. The way you can include this sidebar in your page is:
Multi sidebars
Different sidebar for different pages.
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.
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).
Error 404 - Not Found
Left and Right Sidebars
Two sidebars in one theme.
The file names for the right and left sidebars should be sidebar-right.phpandsidebar-left.php respectively.