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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

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

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