2022年04月25日

WP関数:get_sidebar()

この関数の説明

WP関数の get_sidebar() は、現在のテーマディレクトリの sidebar.php ファイルをインクルードします。

 


関数

get_sidebar( $name )

 


パラメータ

$name(文字列)(オプション)

指定しないと sidebar.php がインクルードされます。

$nameを指定すると sidebar-$name.php がインクルードされます。

­ ­phpプログラムのファイル名

プログラムのファイル名は ○○○-△△△.php という - で区切られた構造を持ちます。

○○○がスラッグ名で、△△△を特殊テンプレート名と呼びます。

 


戻り値

ありません

 


事例

①左右のサイドバーを表示する。

事前に sidebar-left.php と sidebar-right.php がある物とします。

<?php get_header(); ?>
<!-- 本文の表示 -->
<?php get_sidebar('left'); ?>
<?php get_sidebar('right'); ?>
<?php get_footer(); ?>

■本文と左右のサイドバーはCSSで横に並ぶ設定がしてあることが前提です。

 


参考情報

get_sidebar()は sidebar.php ファイルをインクルードするだけの関数です。

一方、 sidebar.php の中に記述される dynamic_sidebar() は、[外観→ウィジェット]で定義したウィジェットを呼び出す関数になります。

またどの様なウィジェットを用意するかは register_sidebar() で定義します。

 

関数一覧
  • 1.WPのエスケープ処理
  • 2.WPプログラムの基本
  • 3.ヘッダ/フッタ/サイドバで使われる関数
  • 4.DBからの読込関数
  • 5.一般テンプレートの中で使われる関数
  • 6.その他のWP関数
  • add_shortcode()
  • bloginfo()
  • body_class()
  • date_i18n()
  • dynamic_sidebar()
  • edit_post_link()
  • esc_attr()
  • esc_html_e()
  • esc_html()
  • esc_url()
  • get_ancestors()
  • get_cat_ID()
  • get_cat_name()
  • get_category_link()
  • get_category_parents()
  • get_category()
  • get_footer()
  • get_header()
  • get_home_url()
  • get_post_format()
  • get_post_meta()
  • get_post_thumbnail_id()
  • get_query_var()
  • get_search_query()
  • get_sidebar()
  • get_site_url()
  • get_stylesheet_directory_uri()
  • get_stylesheet_uri()
  • get_template_directory_uri()
  • get_template_part()
  • get_the_category()
  • get_the_content()
  • get_the_date()
  • get_the_excerpt()
  • get_the_ID()
  • get_the_modified_date()
  • get_the_modified_time()
  • get_the_permalink()
  • get_the_post_thumbnail()
  • get_the_tags()
  • get_the_time()
  • get_the_title()
  • get_uploaded_header_images()
  • get_year_link()
  • has_category()
  • has_custom_logo()
  • has_header_image()
  • has_header_video()
  • has_nav_menu()
  • has_post_thumbnail()
  • has_tag()
  • header_image()
  • home_url()
  • is_admin()
  • is_category()
  • is_date()
  • is_front_page()
  • is_home()
  • is_main_query()
  • is_page()
  • is_search()
  • is_single()
  • language_attributes()
  • the_category()
  • the_content()
  • the_custom_header_markup()
  • the_custom_logo()
  • the_date()
  • the_excerpt()
  • the_ID()
  • the_modified_date()
  • the_modified_time()
  • the_permalink()
  • the_post_thumbnail()
  • the_search_query()
  • the_tags()
  • the_time()
  • the_title()
  • update_post_meta()
  • wp_get_attachment_image_src()
  • wp_nav_menu()
  • WP_Query()