get_header

説明

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

パラメータ

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

返り値

戻り値はありません。

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


注意

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

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


使用例

  • header.phpを読み込む。
    <?php get_header(); ?>
  • header-index.phpを読み込む。
    <?php get_header('index'); ?>

フィルター

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

アクション

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

ソースファイル

/wp-includes/general-template.php

最終更新 : 2020年08月18日 10:28



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。