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



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。