Caelldesign Technical Blog オリジナルテーマ作成からカスタマイズ・プラグイン・テクニカルなどWordPressに関する備忘録

WordPress5.5からテンプレートにパラメータ(引数)で変数を渡す方法

今回ご紹介する事例は、WordPress5.5からテンプレートにパラメータ(引数)で変数を渡す方法をご紹介します。WordPress5.5以降のWordpressに関しては、メインのテンプレート(index.php)からヘッダーやフッターのテンプレート(header.php, footer.php)に変数値を渡すようにできるようになりました。

メインテンプレートのindex.phpからヘッダーのheader.phpへ変数値を渡す方法

変数の使い方はとても簡単です。テンプレートにパラメータ(引数)を渡せる関数は下記になります。また、使い方などWordPress.orgリファレンスで確認してみてください。

関数テンプレート

get_header() header.php
get_footer() footer.php
get_sidebar() sidebar.php
get_template_part() 任意のテンプレート

※参照元:
get_header()
get_footer()
get_sidebar()
get_template_part()
locate_template
load_template

変数設定する方法

index.php側の設定

<?php
$args = [
    'test1' => 'test1-value',
];
// get_header();
get_header( null, $args );
?>

引き取るパラメータの変数名は ‘$args’ を使います。
複数のパラメータを渡したければ、$argsを配列や連想配列にすれば大丈夫です。※変数名までは渡せないので気をつけましょう。

header.php側

<?php echo $args['test1']; ?>

まとめ

今回は、WordPress5.5からテンプレートにパラメータ(引数)で変数を渡す方法をご紹介しました。これでテンプレート(header.php, footer.php)に変数値を渡すことができます。ぜひ変数でヘッダーやフッターのテンプレート設定を試してみてください。