get_sidebar

説明

void | false get_sidebar( [ string $name = null [ , array $args = array() ] ] )
サイドバーパーツを記述したメインサイドバーファイルsidebar.php(またはサブサイドバーファイルsidebar-???.php)を読み込む。

パラメータ

  • $name
    [2.8.0]サブサイドバーファイルの識別名を指定(省略時はnull)。
  • $args
    [5.5.0]サイドバーファイルに引き継ぐパラメータを指定(省略時はarray())。

返り値

戻り値はありません。

[5.5.0]フッターファイルが見つからなかった場合はfalseを返す。


注意

パラメータ$nameが指定された場合でも、対応するサブサイドバーファイルが存在しない場合は、sidebar.phpを読み込む。

[5.5.0]パラメータ$argsが追加され、サイドバーファイルが見つからなかった場合のみfalseを返すように変更された。


使用例

  • sidebar.phpを読み込む。
    <?php get_sidebar(); ?>
  • sidebar-right.phpを読み込む。
    <?php get_sidebar('right'); ?>

フィルター

直接実行するフィルターはありません。

アクション

[2.2.0]はじめに'get_sidebar'アクションを呼び出す。[2.8.0]パラメータ$nameが追加され、本関数が受け取った内容が格納されている。[5.5.0]パラメータ$argsが追加され、本関数が受け取った内容が格納されている。
do_action( 'get_sidebar', $name, $args );

ソースファイル

/wp-includes/general-template.php

最終更新 : 2020年08月18日 11:19



お勧め

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

3.2標準テーマ「Twenty Eleven」は投稿フォーマットに着目(2011年7月6日 更新)

新テーマ「Twenty Eleven」のトップページでは、投稿フォーマットに応じて表示を切り替える仕組みが提案されている。ここでは、その投稿フォームの活用方法を簡単に紹介する。

標準で使用できる数少ないショートコード[caption]とは(2018年5月27日 更新)

画像をアップロードして「投稿に追加」ボタンをクリックすると、投稿記事内にリンク付きのimgタグか、ショートコードのが挿入される。ここではそれらの書式を整理する。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。