get_sidebar

函数
get_sidebar ( $name = null, $args = array() )
参数
  • (string) $name The name of the specialised sidebar.
    Required:
    Default: null
  • (array) $args Optional. Additional arguments passed to the sidebar template. Default empty array.
    Required:
    Default: array()
返回值
  • (void|false) Void on success, false if the template does not exist.
定义位置
相关方法
wp_get_sidebarregister_sidebarget_siteregister_sidebarsget_site_url
引入
1.5.0
弃用
-

get_sidebar函数是一个WordPress的函数,用于检索一个特定侧边栏的HTML标记: 这个函数把侧边栏的名称作为参数,并返回侧边栏的HTML标记。

加载侧边栏模板。

包括一个主题的侧边栏模板,或者如果指定了一个名字,那么一个专门的侧边栏将被包括。

对于参数,如果文件被称为”sidebar-special.php”,那么指定”special”。

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

常见问题

FAQs
查看更多 >