get_sidebar()
最后更新于:2021-11-27 00:15:08
get_sidebar( string$name=null, array$args=array())Load sidebar template.
参数
- $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()
响应
(void|false) Void on success, false if the template does not exist.
源文件
文件: gc-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;
}
}