概要
get_header関数は、ワードプレステーマ内のheader.phpを読み込むために使用される関数です。この関数は、ウェブサイトのヘッダー部分を表示する際によく使用され、次のような機能を実装する際に用いられます。
- ロゴやサイトタイトルを表示する
- ナビゲーションメニューを表示する
- スタイルシートやスクリプトを読み込む
- SEO用のメタタグを追加する
- コンテンツのスキーマを定義する
- ソーシャルメディアのリンクを表示する
- ユーザーのログイン状態を確認する
- ページ特有のカスタムフッター情報を含める
構文
get_header( $name );
パラメータ
$name(オプション): 読み込むヘッダーの名前を指定します。指定しない場合は、デフォルトのheader.phpが読み込まれます。
戻り値
ヘッダー部分のHTMLが返されます。
関連する関数
使用可能なバージョン
get_header関数は、ワードプレスの初期バージョンから存在しており、特に非推奨や削除されたバージョンはありません。
コアファイルのパス
get_header関数は、wp-includes/general-template.phpに含まれています。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | |
| wp_roles_init | |
| setup_theme | 〇 |
| after_setup_theme | 〇 |
| set_current_user | |
| init | |
| register_sidebar | |
| wp_loaded | |
| send_headers | |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | 〇 |
| get_header | 〇 |
| wp_head | 〇 |
サンプルコード
サンプル1: 基本的なヘッダーの読み込み
<?php get_header(); ?>
このコードは、テーマ内のheader.phpを読み込みます。デフォルトのヘッダーを表示する基本的な使い方です。
引用元: https://developer.wordpress.org/reference/functions/get_header/
サンプル2: 特定の名前のヘッダーを読み込み
<?php get_header('custom'); ?>
このコードは、テーマ内のheader-custom.phpを読み込みます。特定のヘッダーを指定して使用することができます。
引用元: https://developer.wordpress.org/reference/functions/get_header/
サンプル3: テンプレートにカスタムヘッダーを追加
<?php
if ( is_page('custom-page') ) {
get_header('custom');
} else {
get_header();
}
?>
このコードは、特定のページにカスタムヘッダーを使用し、それ以外はデフォルトのヘッダーを表示します。
引用元: https://developer.wordpress.org/reference/functions/get_header/
サンプル4: CSSファイルの読み込み
<?php
function my_custom_header() {
get_header();
echo '<link rel="stylesheet" href="custom.css">';
}
add_action('wp_head', 'my_custom_header');
?>
このコードは、ヘッダーを読み込んだ後にカスタムCSSファイルを追加する例です。ヘッダー内で他のリソースを追加する際に便利です。
引用元: https://developer.wordpress.org/reference/functions/get_header/
サンプル5: ヘッダーに変数を渡す
<?php
$title = 'My Custom Title';
get_header();
?>
このコードは、ヘッダーを読み込む前に変数$titleを設定し、header.php内で使用可能にする例です。
引用元: https://developer.wordpress.org/reference/functions/get_header/
以上がget_header関数の概要説明とサンプルコードです。この関数を利用して、ワードプレスサイトのヘッダー部分を柔軟に管理することができます。