【WordPress】ヘッダーを読み込む関数「get_header()」解説
こんにちは、岐阜・名古屋を拠点に全国各地からご依頼いただくWEBサイトを制作しているフリーランスエンジニアの寺井です。
WordPressではヘッダーやフッターなどサイトの共通部分はひとつのファイルにまとめることが一般的な開発手順となっています。
今回の記事ではヘッダーにスポットを当てて、別ファイルに切り分けたヘッダー部分のHTMLを各ページに読み込む方法をご紹介します。
基本的な使用方法
テーマ内にあるheader.phpをpage.phpやindex.phpなどで読み込む場合、WordPressの独自関数として定義されているget_header()関数を使用します。
使用方法は以下の通りです。
<?php get_header(); ?>これで同じテーマ内にあるheader.phpを読み込むことが出来ます。
応用した使用方法
続いてget_header()関数の少し応用した使用方法を見てみましょう。get_header()関数は以下のように定義されていて引数を2つ渡すことが出来ます。
get_header( $name = null, $args = array() ) - $name：読み込むヘッダーテンプレートの名前を指定できます。
- $args：変数を配列としてヘッダーテンプレートに渡すことが出来ます。
複数のヘッダーファイルを使い分ける
仕様によっては複数のヘッダーを使い分ける必要があるかもしれません。
この場合、以下のように複数のヘッダーファイルを用意します。
- header.php
- header-recruit.php
header-recruit.phpを読み込む場合、以下のようにget_header()関数を使用します。
<?php get_header('recruit'); ?>これで同じテーマ内にあるheader-recruit.phpを読み込むことが出来ます。
引数を指定しなければ、header.phpを読み込むことが出来ます。
ヘッダーに引数を渡す
仕様やカスタマイズ内容によってはheader.phpに引数を渡したい場合もあるかもしれません。
この場合、以下のように引数を指定することでheader.phpに引数を渡すことが出来ます。
ヘッダーを読み込む側は以下のように記述し引数を渡します。
<?php
$args = [
'name' => 'site-name',
];
get_header('', $args);
?>ヘッダー側では以下のように記述し受け取った引数を表示します。
<?php echo $args['name']; ?>この機能がWordPress5.5から追加され、開発やカスタマイズが格段に行いやすくなりました。
まとめ
今回の記事ではWordPressでヘッダーテンプレートを読み込む方法をご紹介しました。WordPressでWEB制作をする場合、必ず使用する関数なので、どんな機能があり、どのように使用するのか予め把握しておきたいですね。
