説明
get_sidebar() は、sidebar.php テンプレートを読み込む関数です。
基本構文
get_sidebar( string|null $name = null, array $args = array() ): void|false引数
$name：sidebar-{name}.phpを読み込む場合の名前$args：テンプレートに渡す引数
戻り値
ファイルが見つからない場合は false。
使い方（サンプル）
get_sidebar();注意点
- テンプレートファイルが存在しなければ何も出力されません。
実務での使いどころ
- サイドバーのテンプレート（
sidebar.php）を、読み込むとき。 - ページごとに、別のサイドバー（
sidebar-shop.php）を、読み込むとき（get_sidebar( 'shop' )）。
よくあるミスと対処
- ファイル名が、合っていない。
get_sidebar( 'shop' )は、sidebar-shop.phpを読み込む。 - ファイルがないとき、何も読み込まれない場合がある（古い互換のファイルが、読み込まれる場合もある）。
- ウィジェットの出力と、混同している。ウィジェット領域の出力は、
dynamic_sidebar()。
NG例
get_sidebar( 'sidebar-shop' ); // sidebar-sidebar-shop.php を探すOK例
get_sidebar( 'shop' ); // sidebar-shop.php を読み込む使い分け早見表
| 関数 | 読み込むファイル |
|---|---|
get_sidebar() |
sidebar.php（または sidebar-名前.php） |
get_header() |
header.php（または header-名前.php） |
get_footer() |
footer.php（または footer-名前.php） |
関連項目
get_header()、get_footer()、get_template_part()
公式リファレンス：get_sidebar() | Function | WordPress Developer Resources
コメント