get_sidebar

（1.5.0以降）
get_sidebar - テーマ内のsidebar.phpを読み込む

説明

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

関連

参考

Code Reference: get_sidebar

お勧め

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

さくらのVPSでKUSANAGI（2018年5月27日 更新）

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

ホームディレクトリから過去のファイルを削除する（2013年1月27日 更新）

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

「Align widgets horizontally」プラグインのフィルター使用例（2024年5月15日 更新）

ダッシュボードのウィジェットを横並びに変える「Align widgets horizontally」プラグインには緒設定を変更できるフィルターが用意されている。ここではフィルターの使い方と設定できる項目について紹介する。

各投稿記事で設定されているカスタムフィールドの値を取得するには（2011年9月16日 更新）

投稿記事ごとに設定されているカスタムフィールドの値は get_post_meta関数で取得できるが、すべての投稿記事で設定されているカスタムフィールドの値を一覧を取得する関数が見当たらない。カテゴリーや投稿タグのようにそれぞれの値と実際に使用されている投稿記事件数を取得したいのだが、探し方が悪いのか見つからないのだ。