WordPress中用于创建以及获取侧边栏的PHP函数讲解


            register_sidebar()（创建侧边栏）

建立一个侧边栏，用来放置小工具。这个函数使用的时候请放在一个函数里，挂载到 “widgets_init” 钩子。

用法





register_sidebar( $args );





参数

$args

（字符串 | 数组）（可选）要创建的侧边栏的参数。

默认值：





$args = array(

  'name'     => __( 'Sidebar name', 'theme_text_domain' ),

  'id'      => 'unique-sidebar-id',

  'description'  => '',

  'class'     => '',

  'before_widget' => '<li id="%1" class="widget %2">',

  'after_widget' => '</li>',

  'before_title' => '<h2 class="widgettitle">',

  'after_title'  => '</h2>'

);





数组参数介绍：



  name：侧边栏名称

  id：侧边栏 ID，必须为小写，默认为递增的数组 ID

  description：侧边栏描述

  class：给其中的小工具的额外 class

  before_widget：里边的小工具的开头 Html 代码

  after_widget：里边的小工具的末尾的 Html 代码

  before_title：里边的小工具的标题的开头 Html 代码

  after_title：里边的小工具的标题的末尾的 Html 代码



例子





register_sidebar( array(

  'name'     => __( '右边的侧边栏' ),

  'id'      => 'sidebar-1',

  'description' => __( '右侧边栏的小工具。' ),

  'before_title' => '<h3 class="title">',

  'after_title' => '</h3 class="title">',

));





其它

该函数位于：wp-includes/widgets.php

get_sidebar()（获取侧边栏）

get_sidebar() 用来引入侧边栏模板。如果指定名称则引入当前主题根目录的 sidebar-{name}.php 文件，不指定则引入当前主题根目录的 sidebar.php 文件，如果文件不存在则引入 wp-includes/theme-compat/sidebar.php 文件。

用法





get_sidebar( $name );





参数

$name

（字符串）（可选）引入模板的名称，如果指定则引入当前主题根目录的 sidebar-{$name}.php 文件。

默认值：None

例子

下边的代码将引入当前主题根目录的 sidebar.php 文件：





<?php get_sidebar(); ?>





下边的代码将引入当前主题根目录的 sidebar-left.php 文件：





<?php get_sidebar( 'left' ); ?>





下边的例子分别引入了左侧边栏（sidebar-left.php）和右侧边栏（sidebar-right.php）：





<?php get_header(); ?>

<?php get_sidebar( 'left' ); ?>





内容内容







<?php get_sidebar( 'right' ); ?>

<?php get_footer(); ?>





其它

此函数位于：wp-includes/general-template.php